Ever wanted to know EXACTLY what Ranking signals Google uses? Here is a searchable list. These variables were found on a server under Apache 2.0 license and shared (publicly) by Mike King from iPullRank. He got them via Rand, who got them from an anonymous person, who found them under the Apache 2.0 license. They represent all the ranking signals that we believe Googlers might have access to for their algorithms. I put them here as an easy way for me (and others) to search for buzzwords like “PageRank” and “mustang”. If you want to know, I run an SEO SAAS called InLinks.
Update 29 May: I just changed the column order. I think it makes more sense. Clicking on any row shows the row in a modal.
(Takes a minute to load… 14,000 rows. Wait until you see the search box.)
Signals searchable below… use the green (+) icon to expand.
| Name | Description | ModuleName | ModuleDescription | Type |
|---|---|---|---|---|
| id | AbuseiamAbuseType | String | ||
| subtype | Optional client specific subtype of abuse that is too specific to belong in the above enumeration. For example, some client may want to differentiate nudity from graphic sex, but both are PORNOGRAPHY. | AbuseiamAbuseType | String | |
| ageYears | This restriction applies if the user is between [min_age_years, age_years) years old. | AbuseiamAgeRestriction | integer | |
| minAgeYears | AbuseiamAgeRestriction | integer | ||
| child | This restriction applies if all of the children apply. | AbuseiamAndRestriction | list(AbuseiamUserRestriction) | |
| id | AbuseiamClient | A client is be a Google product, or subproduct that provides content for AbuseIAm to classify. | String | |
| subservice | The name of the subservice within a client. This subservice can be used to affect the flow of decision script, or selection of backend classifiers. For example, StreetView may want to specify a panel is insufficiently blurred (maybe there is a lisense plate or public sex, etc), which requires manual review then the subservice might be “blurring”. | AbuseiamClient | A client is be a Google product, or subproduct that provides content for AbuseIAm to classify. | String |
| type | A constant of type TRUE always applies, and of type FALSE never applies. | AbuseiamConstantRestriction | String | |
| adminVerdict | Takedowns specified by admins via AbuseIAm | AbuseiamContentRestriction | Pair of Verdicts used for ProjectR age/geo gating. See http://go/projectr for more information. | list(AbuseiamVerdict) |
| userVerdict | User-specified takedowns | AbuseiamContentRestriction | Pair of Verdicts used for ProjectR age/geo gating. See http://go/projectr for more information. | list(AbuseiamVerdict) |
| abuseType | AbuseiamEvaluation | Backends return Evaluations to AbuseIAm. One of the things Evaluations are used for is to explain Verdicts. | AbuseiamAbuseType | |
| backend | Who creates this Evaluation. This field is required. | AbuseiamEvaluation | Backends return Evaluations to AbuseIAm. One of the things Evaluations are used for is to explain Verdicts. | String |
| comment | Backends can choose to put some debug info in addition to abuse_type, score, and status. | AbuseiamEvaluation | Backends return Evaluations to AbuseIAm. One of the things Evaluations are used for is to explain Verdicts. | String |
| miscData | This field is used to store miscellaneous information that Backend might provide. If you find youself here considering to use this field, please prefer using the repeated feature field below instead. It supports a richer structure for passing complex data back from the backend. | AbuseiamEvaluation | Backends return Evaluations to AbuseIAm. One of the things Evaluations are used for is to explain Verdicts. | list(AbuseiamNameValuePair) |
| processedMicros | When the evaluation was processed by the decision script. | AbuseiamEvaluation | Backends return Evaluations to AbuseIAm. One of the things Evaluations are used for is to explain Verdicts. | String |
| region | The list of regions where the evaluation applies. | AbuseiamEvaluation | Backends return Evaluations to AbuseIAm. One of the things Evaluations are used for is to explain Verdicts. | list(AbuseiamRegion) |
| score | AbuseiamEvaluation | Backends return Evaluations to AbuseIAm. One of the things Evaluations are used for is to explain Verdicts. | float | |
| status | AbuseiamEvaluation | Backends return Evaluations to AbuseIAm. One of the things Evaluations are used for is to explain Verdicts. | String | |
| target | AbuseiamEvaluation | Backends return Evaluations to AbuseIAm. One of the things Evaluations are used for is to explain Verdicts. | AbuseiamTarget | |
| timestampMicros | When the Evaluation was generated. | AbuseiamEvaluation | Backends return Evaluations to AbuseIAm. One of the things Evaluations are used for is to explain Verdicts. | String |
| userRestriction | A boolean expression tree used to define the restrictions where the verdict applies. Please use java/com/google/ccc/abuse/abuseiam/client/TakedownManager.java to evaluate this proto. | AbuseiamEvaluation | Backends return Evaluations to AbuseIAm. One of the things Evaluations are used for is to explain Verdicts. | AbuseiamUserRestriction |
| version | Version of Backend. For rules, this string is the only way to differentiate between them. | AbuseiamEvaluation | Backends return Evaluations to AbuseIAm. One of the things Evaluations are used for is to explain Verdicts. | String |
| locale | AbuseiamGeoRestriction | A node representing a table of regions and restrictions that apply to those regions. This table understands region inclusion and knows to apply the most specific rule, for example, a rule for France would override a rule for the EU for a user in France. | list(AbuseiamGeoRestrictionLocale) | |
| location | The location where the restriction applies. Defaults to the “The world”. See go/iii. | AbuseiamGeoRestrictionLocale | String | |
| restriction | The UserRestriction that applies to this location. If not specified evaluates to true. | AbuseiamGeoRestrictionLocale | AbuseiamUserRestriction | |
| hash | 64 bit hash in the hex form. | AbuseiamHash | Information about various hashes that can be computed on a message ex: simhash, attachment hash, etc | String |
| type | AbuseiamHash | Information about various hashes that can be computed on a message ex: simhash, attachment hash, etc | String | |
| name | AbuseiamNameValuePair | String | ||
| nonUtf8Value | AbuseiamNameValuePair | String | ||
| value | AbuseiamNameValuePair | String | ||
| child | This restriction applies if the child does not apply. Only one is allowed. “repeated” is used to avoid breaking Sawzall (See b/6758277). | AbuseiamNotRestriction | list(AbuseiamUserRestriction) | |
| child | This restriction applies if any of the children apply. | AbuseiamOrRestriction | list(AbuseiamUserRestriction) | |
| region | This is a CLDR Region Code: http://wiki/Main/IIIHowTo#using_region It is used to denote the region affected by a verdict. | AbuseiamRegion | String | |
| type | AbuseiamSpecialRestriction | A SpecialRestriction is a standardized UserRestriction which lives in a table maintained via CDD. | String | |
| id | AbuseiamTarget | String | ||
| type | AbuseiamTarget | String | ||
| channel | AbuseiamUserNotification | A structure used to configure a notification to a user. | String | |
| ageRestriction | AbuseiamUserRestriction | Describes restrictions on where the verdict applies. Please use {@code TakedownManager} to evaluate this proto. | AbuseiamAgeRestriction | |
| andRestriction | Operators | AbuseiamUserRestriction | Describes restrictions on where the verdict applies. Please use {@code TakedownManager} to evaluate this proto. | AbuseiamAndRestriction |
| constantRestriction | Constant | AbuseiamUserRestriction | Describes restrictions on where the verdict applies. Please use {@code TakedownManager} to evaluate this proto. | AbuseiamConstantRestriction |
| geoRestriction | Leaf Nodes | AbuseiamUserRestriction | Describes restrictions on where the verdict applies. Please use {@code TakedownManager} to evaluate this proto. | AbuseiamGeoRestriction |
| notRestriction | AbuseiamUserRestriction | Describes restrictions on where the verdict applies. Please use {@code TakedownManager} to evaluate this proto. | AbuseiamNotRestriction | |
| orRestriction | AbuseiamUserRestriction | Describes restrictions on where the verdict applies. Please use {@code TakedownManager} to evaluate this proto. | AbuseiamOrRestriction | |
| specialRestriction | AbuseiamUserRestriction | Describes restrictions on where the verdict applies. Please use {@code TakedownManager} to evaluate this proto. | AbuseiamSpecialRestriction | |
| client | Target client of the verdict. It can be used to differentiate verdicts from multiple clients when such verdicts are processed in one common place. | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | AbuseiamClient |
| comment | Additional info regarding the verdict. | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | String |
| decision | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | String | |
| durationMins | Time duration (in minutes) of the verdict. | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | integer |
| evaluation | Evaluations relevant to this verdict. Every Verdict should contain at least one Evaluation. | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | list(AbuseiamEvaluation) |
| hashes | Details of all the hashes that can be computed on a message, such as simhash and attachment hash | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | list(AbuseiamHash) |
| isLegalIssued | Is this verdict issued by legal? | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | boolean |
| miscScores | This field is used to pass relevant / necessary scores to our clients. For eg: ASBE propagates these scores to moonshine. | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | list(AbuseiamNameValuePair) |
| reasonCode | A short description of the reason why the verdict decision is made. | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | String |
| region | The regions in which this verdict should be enforced. Absence of this field indicates that the verdict is applicable everywhere. | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | list(AbuseiamRegion) |
| restriction | Restrictions on where this verdict applies. If any restriction is met, the verdict is applied there. If no restrictions are present, the verdict is considered global. | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | list(AbuseiamVerdictRestriction) |
| strikeCategory | Category of the strike if this is a strike verdict. | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | String |
| target | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | AbuseiamTarget | |
| targetTimestampMicros | The timestamp of the target. E.g., the time when the target was updated. | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | String |
| timestampMicros | When the verdict is generated | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | String |
| userNotification | Extra notification(s) to be delivered to target user or message owner about the verdict. | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | list(AbuseiamUserNotification) |
| version | version of decision script | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | String |
| context | For a restriction to apply, all contexts must be satisfied. For example, if context[0] is COUNTRY/’GERMANY’ and context[1] is DESTINATION_STREAM/’gplus:SQUARE:knitting_discussion’, then the verdict applies only when the ‘knitting discussion’ square is viewed from inside Germany. Please note that this is present for legacy reasons and users of this field would be migrated to use the user_restriction field defined below. | AbuseiamVerdictRestriction | Describes restrictions on where the verdict applies. | list(AbuseiamVerdictRestrictionContext) |
| userRestriction | A boolean expression tree used to define the restrictions where the verdict applies. Please use java/com/google/ccc/abuse/abuseiam/client/TakedownManager.java to evaluate this proto. | AbuseiamVerdictRestriction | Describes restrictions on where the verdict applies. | AbuseiamUserRestriction |
| id | String identifying the context. | AbuseiamVerdictRestrictionContext | Describes a dimension of a context where a verdict applies. | String |
| type | AbuseiamVerdictRestrictionContext | Describes a dimension of a context where a verdict applies. | String | |
| highId | AdsShoppingReportingOffersSerializedSoriId | The serialized form of a SORI id. NOTE that this proto is stored in V4/O4 index and that new fields should not be added without getting an agreement from the serving team as well. | String | |
| lowId1 | AdsShoppingReportingOffersSerializedSoriId | The serialized form of a SORI id. NOTE that this proto is stored in V4/O4 index and that new fields should not be added without getting an agreement from the serving team as well. | String | |
| lowId2 | AdsShoppingReportingOffersSerializedSoriId | The serialized form of a SORI id. NOTE that this proto is stored in V4/O4 index and that new fields should not be added without getting an agreement from the serving team as well. | String | |
| anchor | Anchors | list(AnchorsAnchor) | ||
| homepageAnchorsDropped | The total # of local homepage anchors dropped in AnchorAccumulator. | Anchors | String | |
| indexTier | The index tier from which the anchors were extracted. Note that this is only valid in the anchor record written by linkextractor. The value can be one of the enum values defined in segindexer/types.h. | Anchors | integer | |
| localAnchorsDropped | The total # of local non-homepage anchors dropped in AnchorAccumulator. | Anchors | String | |
| nonlocalAnchorsDropped | The total # of non-local anchors dropped in AnchorAccumulator. | Anchors | String | |
| redundantAnchorsDropped | The *_anchors_dropped fields below are not populated by Alexandria, which uses cdoc.anchor_stats instead. The total # of redundant anchors dropped in linkextractor. | Anchors | String | |
| redundantanchorinfo | Anchors | list(AnchorsRedundantAnchorInfo) | ||
| supplementalAnchorsDropped | The total # of supplemental anchors dropped in AnchorAccumulator. ## DEPRECATED. | Anchors | String | |
| targetDocid | may be implicit | Anchors | String | |
| targetSite | HOST_LEVEL site chunking. | Anchors | String | |
| targetUrl | This is produced during link extraction but not written out in the linklogs in order to save space. | Anchors | String | |
| creationDate | used for history – the first and last time we have seen this anchor. creation_date also used for Freshdocs Twitter indexing, a retweet is an anchor of the original tweet. This field records the time when a retweet is created. | AnchorsAnchor | integer | |
| origText | Original text, including capitalization and punctuation. Runs of whitespace are collapsed into a single space. | AnchorsAnchor | String | |
| context2 | This is a hash of terms near the anchor. (This is a second-generation hash replacing the value stored in the ‘context’ field.) | AnchorsAnchor | integer | |
| fontsize | AnchorsAnchor | integer | ||
| experimental | If true, the anchor is for experimental purposes and should not be used in serving. | AnchorsAnchor | boolean | |
| fragment | The URL fragment for this anchor (the foo in http://www.google.com#foo) | AnchorsAnchor | String | |
| sourceType | is to record the quality of the anchor’s source page and is correlated with but not identical to the index tier of the source page. In the docjoins built by the indexing pipeline (Alexandria), – Anchors marked TYPE_HIGH_QUALITY are from base documents. – Anchors marked TYPE_MEDIUM_QUALITY are from documents of medium quality (roughly but not exactly supplemental tier documents). – Anchors marked TYPE_LOW_QUALITY are from documents of low quality (roughly but not exactly blackhole documents). Note that the source_type can also be used as an importance indicator of an anchor (a lower source_type value indicates a more important anchor), so it is important to enforce that TYPE_HIGH_QUALITY < TYPE_MEDIUM_QUALITY < TYPE_LOW_QUALITY To add a new source type in future, please maintain the proper relationship among the types as well. TYPE_FRESHDOCS, only available in freshdocs indexing, is a special case and is considered the same type as TYPE_HIGH_QUALITY for the purpose of anchor importance in duplicate anchor removal. | AnchorsAnchor | integer | |
| pagerankWeight | Weight to be stored in linkmaps for pageranker | AnchorsAnchor | number | |
| isLocal | The bit ~roughly~ indicates whether an anchor’s source and target pages are on the same domain. Note: this plays no role in determining whether an anchor is onsite, ondomain, or offdomain in mustang (i.e., the bit above). | AnchorsAnchor | boolean | |
| originalTargetDocid | The docid of the anchor’s original target. This field is available if and only if the anchor is forwarded. | AnchorsAnchor | String | |
| fullLeftContext | The full context. These are not written out in the linklogs. | AnchorsAnchor | list(String) | |
| expired | true iff exp domain | AnchorsAnchor | boolean | |
| catfishTags | CATfish tags attached to a link. These are similar to link tags, except the values are created on the fly within Cookbook. See: http://sites/cookbook/exporting/indexing | AnchorsAnchor | list(integer) | |
| deletionDate | AnchorsAnchor | integer | ||
| linkTags | Contains info on link type, source page, etc. | AnchorsAnchor | list(integer) | |
| forwardingTypes | How the anchor is forwarded to the canonical, available only for forwarded anchors (i.e., the field is set). The forwarding types are defined in URLForwardingUtil (segindexer/segment-indexer-util.h). Always use URLForwardingUtil to access this field and use URLForwardingUtil::GetAnchorForwardingReason to get the explanation how the anchor is forwarded to the canonical. NOTE: Use with caution as it is only set for docjoins generated using the urlmap from repository/updater. | AnchorsAnchor | integer | |
| possiblyOldFirstseenDate | DEPRECATED. It used to be set if firstseen_date is not set. It’s to indicate that the anchor is possibly old, but we don’t have enough information to tell until the linkage map is updated. TODO(hxu) rename it to possibly_old_firstseen_date_DEPRECATED after clean up other dependencies. | AnchorsAnchor | boolean | |
| locality | For ranking purposes, the quality of an anchor is measured by its “locality” and “bucket”. See quality/anchors/definitions.h for more information. | AnchorsAnchor | integer | |
| demotionreason | DEPRECATED | AnchorsAnchor | integer | |
| parallelLinks | The number of additional links from the same source page to the same target domain. Not populated if is_local is true. | AnchorsAnchor | integer | |
| text | Space-delimited anchor words. Text that needs segmentation (like CJK or Thai) is unsegmented, since we set FLAGS_segment_during_lexing to false in mr-linkextractor.cc . | AnchorsAnchor | String | |
| source | AnchorsAnchor | AnchorsAnchorSource | ||
| bucket | AnchorsAnchor | integer | ||
| fullRightContext | AnchorsAnchor | list(String) | ||
| targetUrlEncoding | A given target URL may be found in different encodings in different documents. We store the URL encoding with each source anchor so that we can count them later to find the encoding most likely to be expected by the Web site. Around 0.7% of target URLs are expected to require a non-default value here. The default value 0 is referenced in C++ as webutil::kDefaultUrlEncoding. See also webutil/urlencoding. | AnchorsAnchor | integer | |
| compressedOriginalTargetUrl | The anchor’s original target url, compressed. Available only in Alexandria docjoins when the anchor is forwarded. | AnchorsAnchor | String | |
| firstseenDate | # days past Dec 31, 1994, 23:00:00 UTC (Unix time @788914800) that this link was first seen. Should never occupy more than 15 bits. NOTE: this is NOT the same as creation_date; firstseen_date is filled during link extraction | AnchorsAnchor | integer | |
| setiPagerankWeight | TEMPORARY | AnchorsAnchor | number | |
| context | AnchorsAnchor | integer | ||
| linkAdditionalInfo | Additional information related to the anchor, such as additional anchor text or scores. | AnchorsAnchor | Proto2BridgeMessageSet | |
| type | DEPRECATED: Now in link_tags | AnchorsAnchor | integer | |
| firstseenNearCreation | true if we think ‘firstseen_date’ is an accurate estimate of when the link was actually added to the source page. false if it may have existed for some time before we saw it. | AnchorsAnchor | boolean | |
| lastUpdateTimestamp | Used for history and freshness tracking – the timestamp this anchor is updated in indexing. | AnchorsAnchor | integer | |
| offset | This is the offset for the first term in the anchor – it can be used as a unique ID for the anchor within the document and compared against all per-tag data. This is measured in bytes from the start of the document. We write this out to the linklogs to recover the original order of links after source/target forwarding. This is necessary for computing the global related data. | AnchorsAnchor | integer | |
| weight | weights are 0-127 | AnchorsAnchor | integer | |
| deleted | AnchorsAnchor | boolean | ||
| encodedNewsAnchorData | Encoded data containing information about newsiness of anchor. Populated only if anchor is classified as coming from a newsy, high quality site. Encoded data for anchor sources are being stored in googledata/quality/freshness/news_anchors/encoded_news_anchors_data.txt Scores are being computed with quality/freshness/news_anchors/ routines. | AnchorsAnchor | integer | |
| compressedImageUrls | If the anchor contained images, these image urls are stored here in compressed form. | AnchorsAnchor | list(String) | |
| timestamp | This field is DEPRECATED and no longer filled. For source page crawl timestamp, use Source.crawl_timestamp. Next tag id should be 62. | AnchorsAnchor | String | |
| additionalInfo | Additional information related to the source, such as news hub info. | AnchorsAnchorSource | attributes of the source document for the link | Proto2BridgeMessageSet |
| cluster | anchor++ cluster id | AnchorsAnchorSource | attributes of the source document for the link | integer |
| compressedUrl | compressed source url | AnchorsAnchorSource | attributes of the source document for the link | String |
| crawlTimestamp | Source page crawl timestamp. | AnchorsAnchorSource | attributes of the source document for the link | String |
| docid | The docid field used to be “required”, but it is now “optional” because it is not present when anchors are stored in webtable. When anchors are stored as part of docjoin files in the segment indexer, however, docid should be considered required. | AnchorsAnchorSource | attributes of the source document for the link | String |
| doclength | necessary for anything? | AnchorsAnchorSource | attributes of the source document for the link | integer |
| homePageInfo | Information about if the source page is a home page. It can be one of the enum values defined in PerDocData::HomePageInfo (NOT_HOMEPAGE, NOT_TRUSTED, PARTIALLY_TRUSTED, and FULLY_TRUSTED). | AnchorsAnchorSource | attributes of the source document for the link | integer |
| indyrank | uint16 scale | AnchorsAnchorSource | attributes of the source document for the link | integer |
| ipaddr | DEPRECATED, use packed_ipaddress | AnchorsAnchorSource | attributes of the source document for the link | integer |
| language | default -> English | AnchorsAnchorSource | attributes of the source document for the link | integer |
| linkhash | 0 -> no hash | AnchorsAnchorSource | attributes of the source document for the link | String |
| localCountryCodes | Countries to which the source page is local/most relevant; stored as III identifiers for country/region codes (see http://go/iii). | AnchorsAnchorSource | attributes of the source document for the link | list(integer) |
| nsr | This NSR value has range [0,1000] and is the original value [0.0,1.0] multiplied by 1000 rounded to an integer. | AnchorsAnchorSource | attributes of the source document for the link | integer |
| outdegree | AnchorsAnchorSource | attributes of the source document for the link | integer | |
| outsites | approx num of pointed-to sites | AnchorsAnchorSource | attributes of the source document for the link | integer |
| packedIpaddress | string in IPAddress::ToPackedString() format. | AnchorsAnchorSource | attributes of the source document for the link | String |
| pageTags | Page tags are described by enum PageTag in PerDocData. Page tags are used in anchors to identify properties of the linking page. These are DEPRECATED: in the future, use link_tags instead. DEPRECATED | AnchorsAnchorSource | attributes of the source document for the link | list(integer) |
| pagerank | uint16 scale | AnchorsAnchorSource | attributes of the source document for the link | integer |
| pagerankNs | unit16 scale | AnchorsAnchorSource | attributes of the source document for the link | integer |
| seglanguage | DEPRECATED | AnchorsAnchorSource | attributes of the source document for the link | integer |
| site | AnchorsAnchorSource | attributes of the source document for the link | String | |
| spamrank | uint16 scale | AnchorsAnchorSource | attributes of the source document for the link | integer |
| spamscore1 | deprecated, to be removed after October 20. 0-127 scale | AnchorsAnchorSource | attributes of the source document for the link | integer |
| spamscore2 | 0-127 scale | AnchorsAnchorSource | attributes of the source document for the link | integer |
| webtableKey | Webtable key of source | AnchorsAnchorSource | attributes of the source document for the link | String |
| anchorsDropped | AnchorsRedundantAnchorInfo | NOTE: in docjoins, the following anchor sampling information is only ## available in the first record of a document (under the same docid). The total number of redundant anchors dropped per (domain, text) in linkextractor. If we receive a large number of anchors from a particular domain, then we’ll throw out all but a sampling of them from that domain. The data is sorted by the (domain,text) pairs. This field is not populated by Alexandria, which uses cdoc.anchor_stats instead. | String | |
| domain | AnchorsRedundantAnchorInfo | NOTE: in docjoins, the following anchor sampling information is only ## available in the first record of a document (under the same docid). The total number of redundant anchors dropped per (domain, text) in linkextractor. If we receive a large number of anchors from a particular domain, then we’ll throw out all but a sampling of them from that domain. The data is sorted by the (domain,text) pairs. This field is not populated by Alexandria, which uses cdoc.anchor_stats instead. | String | |
| text | AnchorsRedundantAnchorInfo | NOTE: in docjoins, the following anchor sampling information is only ## available in the first record of a document (under the same docid). The total number of redundant anchors dropped per (domain, text) in linkextractor. If we receive a large number of anchors from a particular domain, then we’ll throw out all but a sampling of them from that domain. The data is sorted by the (domain,text) pairs. This field is not populated by Alexandria, which uses cdoc.anchor_stats instead. | String | |
| customerId | AppsDynamiteCustomerId | Represents a GSuite customer ID. Obfuscated with CustomerIdObfuscator. | String | |
| consumerInfo | AppsDynamiteSharedOrganizationInfo | Contains info about the entity that something is, or is owned by. | AppsDynamiteSharedOrganizationInfoConsumerInfo | |
| customerInfo | AppsDynamiteSharedOrganizationInfo | Contains info about the entity that something is, or is owned by. | AppsDynamiteSharedOrganizationInfoCustomerInfo | |
| customerId | AppsDynamiteSharedOrganizationInfoCustomerInfo | AppsDynamiteCustomerId | ||
| memberType | AppsDynamiteSharedSegmentedMembershipCount | Contains info on membership count for member types: HUMAN_USER, APP_USER & ROSTER_MEMBER different states: INVITED, JOINED | String | |
| membershipCount | count of members with given type and state | AppsDynamiteSharedSegmentedMembershipCount | Contains info on membership count for member types: HUMAN_USER, APP_USER & ROSTER_MEMBER different states: INVITED, JOINED | integer |
| membershipState | AppsDynamiteSharedSegmentedMembershipCount | Contains info on membership count for member types: HUMAN_USER, APP_USER & ROSTER_MEMBER different states: INVITED, JOINED | String | |
| value | AppsDynamiteSharedSegmentedMembershipCounts | list(AppsDynamiteSharedSegmentedMembershipCount) | ||
| id | The hierarchy of IDs. Each individual ID is “flat” and the repeated list defines the hierarchy. Namespaces define the “validity” of this hierachy (depth, naming convention, etc) and the server will reject invalid IDs. | AppsPeopleActivityBackendDestinationStream | A DestinationStream is a /namespace/id[0]/id[1]/…/id[n] that represents a collection of Activities. Example destinations: -The Profile Stream on http://plus.google.com/+JohnDoe/posts -A Square Stream on http://plus.google.com/squares/123 -A “comment Stream” (Fountain) on http://www.youtube.com/watch?id=123 It’s possible for a single Activity to show in each of these destinations – and it might behave/look slightly differently for each one. Destinations can have their own business logic associated with them at both write-time and read-time server-side (these are documented below). Each DestinationStream is indexed and can be retrieved using the GetDestinationStreamRequest. For the repeated ID space indexing happens at all levels, e.g. if you have: /square/123/abc /square/123/efd /square/456 You can fetch /square/123/abc directly or /square/123 (which includes all Activities in both /square/123/abc and /square/123/efd), or even /square which retrieves all Activities in the Square namespace (visible for that user). On the storage layer, we represent DestinationStream as Channel (http://cs/#google3/social/common/channel/channel.proto), since the storage does not have the concept of a Stream. Both terms are used interchangeably within the service layer, but client of Social Infrastructure should use the term DestinationStream. Next ID: 3 | list(String) |
| namespace | AppsPeopleActivityBackendDestinationStream | A DestinationStream is a /namespace/id[0]/id[1]/…/id[n] that represents a collection of Activities. Example destinations: -The Profile Stream on http://plus.google.com/+JohnDoe/posts -A Square Stream on http://plus.google.com/squares/123 -A “comment Stream” (Fountain) on http://www.youtube.com/watch?id=123 It’s possible for a single Activity to show in each of these destinations – and it might behave/look slightly differently for each one. Destinations can have their own business logic associated with them at both write-time and read-time server-side (these are documented below). Each DestinationStream is indexed and can be retrieved using the GetDestinationStreamRequest. For the repeated ID space indexing happens at all levels, e.g. if you have: /square/123/abc /square/123/efd /square/456 You can fetch /square/123/abc directly or /square/123 (which includes all Activities in both /square/123/abc and /square/123/efd), or even /square which retrieves all Activities in the Square namespace (visible for that user). On the storage layer, we represent DestinationStream as Channel (http://cs/#google3/social/common/channel/channel.proto), since the storage does not have the concept of a Stream. Both terms are used interchangeably within the service layer, but client of Social Infrastructure should use the term DestinationStream. Next ID: 3 | String | |
| reportCompromised | Corresponds on “This account might be compromised or hacked” reporting action. | AppsPeopleActivityStreamqualityDistillerEngagements | Stores the number of different kind of user engagement actions. Abuse Report is also consider an engagement. Currently we only have abuse report engagements but in future we might add other types of engagements as well. | String |
| reportHarassment | Corresponds on “Harassment or bullying” reporting action. | AppsPeopleActivityStreamqualityDistillerEngagements | Stores the number of different kind of user engagement actions. Abuse Report is also consider an engagement. Currently we only have abuse report engagements but in future we might add other types of engagements as well. | String |
| reportHate | Corresponds on “Hate speach or graphic violence” reporting action. | AppsPeopleActivityStreamqualityDistillerEngagements | Stores the number of different kind of user engagement actions. Abuse Report is also consider an engagement. Currently we only have abuse report engagements but in future we might add other types of engagements as well. | String |
| reportPorn | Corresponds on “Pornography or sexually explicit material” reporting action. | AppsPeopleActivityStreamqualityDistillerEngagements | Stores the number of different kind of user engagement actions. Abuse Report is also consider an engagement. Currently we only have abuse report engagements but in future we might add other types of engagements as well. | String |
| reportSpam | Corresponds on “Unwanted commercial content or spam” reporting action. | AppsPeopleActivityStreamqualityDistillerEngagements | Stores the number of different kind of user engagement actions. Abuse Report is also consider an engagement. Currently we only have abuse report engagements but in future we might add other types of engagements as well. | String |
| serveCount | Number of times this activity was served out of asbe/stanza. | AppsPeopleActivityStreamqualityDistillerEngagements | Stores the number of different kind of user engagement actions. Abuse Report is also consider an engagement. Currently we only have abuse report engagements but in future we might add other types of engagements as well. | String |
| timeSec | Timestamp in seconds for which time this record is valid. | AppsPeopleActivityStreamqualityDistillerEngagements | Stores the number of different kind of user engagement actions. Abuse Report is also consider an engagement. Currently we only have abuse report engagements but in future we might add other types of engagements as well. | String |
| ytThumbsDown | Corresponds on Distiller comment thumbs down action. | AppsPeopleActivityStreamqualityDistillerEngagements | Stores the number of different kind of user engagement actions. Abuse Report is also consider an engagement. Currently we only have abuse report engagements but in future we might add other types of engagements as well. | String |
| contentType | AppsPeopleOzExternalMergedpeopleapiAbout | String | ||
| metadata | AppsPeopleOzExternalMergedpeopleapiAbout | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| safeHtmlValue | Sanitized HTML value that is only populated when the SANITIZE_ABOUT_HTML extension is requested. | AppsPeopleOzExternalMergedpeopleapiAbout | WebutilHtmlTypesSafeHtmlProto | |
| value | AppsPeopleOzExternalMergedpeopleapiAbout | String | ||
| nameDisplayOptions | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedData | Extension data for use in AboutMe. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataNameDisplayOptions | |
| photosCompareData | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedData | Extension data for use in AboutMe. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareData | |
| profileEditability | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedData | Extension data for use in AboutMe. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataProfileEditability | |
| profileNameModificationHistory | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedData | Extension data for use in AboutMe. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataProfileNameModificationHistory | |
| nicknameOption | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataNameDisplayOptions | See NameDisplayOptions in //depot/google3/focus/backend/proto/backend.proto. See also go/nickname-mess. | String | |
| diffData | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareData | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareDataDiffData | ||
| highResUrl | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareData | String | ||
| inconsistentPhoto | True if photo diff is greater than 0.01 on any color band, or if the user has a low res photo but no high res photo. This field is primarily for use in About Me and for other uses it’s recommended to use the DiffData values directly instead. The cutoff is based on a heuristic determined in go/comparing-profile-photos | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareData | boolean | |
| lowResData | Only present if the photo diff is greater than 0.01 on any color band. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareData | String | |
| lowResUrl | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareData | String | ||
| monogramUrl | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareData | String | ||
| privateLowResAcl | True if the low-res photo has a private ACL set. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareData | boolean | |
| blueDiff | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareDataDiffData | number | ||
| greenDiff | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareDataDiffData | number | ||
| redDiff | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareDataDiffData | number | ||
| lockedField | Read-only set of zero or more field paths that are locked for update on this person, such as “person.name”, “person.email”, etc. The set of fields is only populated for the requester’s profile. Fields in the set cannot be edited, added, or deleted from the profile. Attempting to update any of these fields will result in an exception. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataProfileEditability | See UserEditedLockedMask in //depot/google3/focus/backend/proto/backend.proto. | list(String) |
| computedNameChangesRemaining | The number of name changes remaining at RPC request time. This can be more than name_changes_remaining, if user hasn’t changed name for some time and accrued quota since last change. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataProfileNameModificationHistory | See ABUSE_NAME_LAST_MODIFIED in //depot/google3/focus/backend/proto/backend.proto which maps to //depot/google3/focus/proto/profileattribute.proto | integer |
| computedNicknameChangesRemaining | The number of nickname changes remaining at RPC request time. This can be more than nickname_changes_remaining, if user hasn’t changed nickname for some time and accrued quota since last change. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataProfileNameModificationHistory | See ABUSE_NAME_LAST_MODIFIED in //depot/google3/focus/backend/proto/backend.proto which maps to //depot/google3/focus/proto/profileattribute.proto | integer |
| nameChangesRemaining | The number of name changes remaining at the time the name was last modified. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataProfileNameModificationHistory | See ABUSE_NAME_LAST_MODIFIED in //depot/google3/focus/backend/proto/backend.proto which maps to //depot/google3/focus/proto/profileattribute.proto | integer |
| nameLastModified | The last time the profile name was modified in milliseconds UTC. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataProfileNameModificationHistory | See ABUSE_NAME_LAST_MODIFIED in //depot/google3/focus/backend/proto/backend.proto which maps to //depot/google3/focus/proto/profileattribute.proto | String |
| nicknameChangesRemaining | The number of nickname changes remaining at the time the nickname was last modified. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataProfileNameModificationHistory | See ABUSE_NAME_LAST_MODIFIED in //depot/google3/focus/backend/proto/backend.proto which maps to //depot/google3/focus/proto/profileattribute.proto | integer |
| nicknameLastModified | The last time the profile nickname was modified in milliseconds UTC. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataProfileNameModificationHistory | See ABUSE_NAME_LAST_MODIFIED in //depot/google3/focus/backend/proto/backend.proto which maps to //depot/google3/focus/proto/profileattribute.proto | String |
| quotaEnforcementStatus | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataProfileNameModificationHistory | See ABUSE_NAME_LAST_MODIFIED in //depot/google3/focus/backend/proto/backend.proto which maps to //depot/google3/focus/proto/profileattribute.proto | String | |
| AppsPeopleOzExternalMergedpeopleapiAccountEmail | String | |||
| rawDeviceContactInfo | When the container is a DEVICE_CONTACT, this list provides account information from the raw contact which is the source of this field. | AppsPeopleOzExternalMergedpeopleapiAdditionalContainerInfo | Additional information about a container. TO BE DELETED: replaced by DeviceContactInfo. | list(AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo) |
| country | AppsPeopleOzExternalMergedpeopleapiAddress | String | ||
| countryCode | AppsPeopleOzExternalMergedpeopleapiAddress | String | ||
| encodedPlaceId | FeatureId associated with the address. The format is the same as that used for ids in PLACE containers in SourceIdentity. | AppsPeopleOzExternalMergedpeopleapiAddress | String | |
| extendedAddress | AppsPeopleOzExternalMergedpeopleapiAddress | String | ||
| formatted | AppsPeopleOzExternalMergedpeopleapiAddress | String | ||
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiAddress | String | |
| locality | AppsPeopleOzExternalMergedpeopleapiAddress | String | ||
| metadata | AppsPeopleOzExternalMergedpeopleapiAddress | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| poBox | AppsPeopleOzExternalMergedpeopleapiAddress | String | ||
| pointSpec | AppsPeopleOzExternalMergedpeopleapiAddress | AppsPeopleOzExternalMergedpeopleapiPointSpec | ||
| postalCode | AppsPeopleOzExternalMergedpeopleapiAddress | String | ||
| region | AppsPeopleOzExternalMergedpeopleapiAddress | String | ||
| streetAddress | AppsPeopleOzExternalMergedpeopleapiAddress | String | ||
| type | The type of the address. The type can be free form or one of these predefined values: * `home` * `work` * `other` | AppsPeopleOzExternalMergedpeopleapiAddress | String | |
| affinityMetadata | Contains extra ranking information returned by DAS. | AppsPeopleOzExternalMergedpeopleapiAffinity | Similar to social.graph.storage.Affinity, but pared down to what the clients of the People API are interested in. | SocialGraphWireProtoPeopleapiAffinityMetadata |
| affinityType | AppsPeopleOzExternalMergedpeopleapiAffinity | Similar to social.graph.storage.Affinity, but pared down to what the clients of the People API are interested in. | String | |
| containerId | The ID of the container | AppsPeopleOzExternalMergedpeopleapiAffinity | Similar to social.graph.storage.Affinity, but pared down to what the clients of the People API are interested in. | String |
| containerType | The type of container to which this affinity applies | AppsPeopleOzExternalMergedpeopleapiAffinity | Similar to social.graph.storage.Affinity, but pared down to what the clients of the People API are interested in. | String |
| loggingId | Used to log events for this affinity value, for disco diagnostic-purposes. See go/disco-diagnostics. | AppsPeopleOzExternalMergedpeopleapiAffinity | Similar to social.graph.storage.Affinity, but pared down to what the clients of the People API are interested in. | String |
| value | Affinity value. Frequently represented as an inverse ranking, sometimes with additional data encoded. If data_formats.affinity_formats.score_format is set to RAW_SCORE then the value will be the score returned by DAS. | AppsPeopleOzExternalMergedpeopleapiAffinity | Similar to social.graph.storage.Affinity, but pared down to what the clients of the People API are interested in. | float |
| ageInYears | Please read go/people-api-howto:age on how to get age data. Age of the user. The field is set based on profile storage fields such as account birthday. If the source fields are not present, `age_in_years` will be left unset. | AppsPeopleOzExternalMergedpeopleapiAgeRangeType | Please read go/people-api-howto:age on how to get age data. Message for the `Person.age_range_repeated` field. Replaces the existing `Person.age_range` field. | integer |
| ageOfConsentStatus | Deprecated. Use go/supervised-accounts#capabilities-for-child-accounts instead. Denotes whether the user is under the region based Age of Consent. The user’s region is based on ClientUserInfo.GlobalTos.AgreedLocation The age is inferred from Birthday field or CertifiedBornBefore field. The region based AoC is specified at go/aoc. | AppsPeopleOzExternalMergedpeopleapiAgeRangeType | Please read go/people-api-howto:age on how to get age data. Message for the `Person.age_range_repeated` field. Replaces the existing `Person.age_range` field. | String |
| ageRange | Deprecated. Please read go/people-api-howto:age on how to get age data. Age range is populated based on `account_birthday` and `certified_born_before`, which may not be set for dasher users. | AppsPeopleOzExternalMergedpeopleapiAgeRangeType | Please read go/people-api-howto:age on how to get age data. Message for the `Person.age_range_repeated` field. Replaces the existing `Person.age_range` field. | String |
| metadata | AppsPeopleOzExternalMergedpeopleapiAgeRangeType | Please read go/people-api-howto:age on how to get age data. Message for the `Person.age_range_repeated` field. Replaces the existing `Person.age_range` field. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| appUniqueId | Store the app unique id endpoint. This will be passed over to app to fulfill the action. For example, app_unique_id for Whatsapp will be “[email protected]” | AppsPeopleOzExternalMergedpeopleapiAppUniqueInfo | Store all app unique info that are needed for app action fulfillment. | String |
| contactInfoSource | Where this contact info was retrieved from. Note: only added for Assistant usage, and will not be populated by PAPI. This is due to the coupling between Assistant Proto, and PAPI proto. (//depot/google3/quality/qrewrite/servlets/proto/focus_name.proto) | AppsPeopleOzExternalMergedpeopleapiAppUniqueInfo | Store all app unique info that are needed for app action fulfillment. | String |
| displayAppUniqueId | Store third party endpoint that is displayed to users. For example, display_app_unique_id for Whatsapp will be “Message +11234567890”. | AppsPeopleOzExternalMergedpeopleapiAppUniqueInfo | Store all app unique info that are needed for app action fulfillment. | String |
| label | Store third party endpoint label. For example, “HOME”, “WORK” | AppsPeopleOzExternalMergedpeopleapiAppUniqueInfo | Store all app unique info that are needed for app action fulfillment. | String |
| mimetype | Store mimetype of this endpoint. We will use this as the differentiator for Assistant to know whether to use the RawContact for messaging, call or video call. For example, send message mimetype for whatsapp: “vnd.android.cursor.item/vnd.com.whatsapp.profile” voice call mimetype for whatsapp: “vnd.android.cursor.item/vnd.com.whatsapp.voip.call” | AppsPeopleOzExternalMergedpeopleapiAppUniqueInfo | Store all app unique info that are needed for app action fulfillment. | String |
| containerType | The container the suggested name was sourced from | AppsPeopleOzExternalMergedpeopleapiBestDisplayName | The best suggested name to use for the Person from the available source fields, which may include FileAs, Name, Org, Email, IM, Phone, … Rough source container priority order is Contact, then Profile, then Place. | String |
| displayName | The display name. This name is intended to be the best name to display for this Person. It may be built from a variety of fields, even if those fields are not explicitly requested in the request mask. Generally, the display name is formatted in ‘first last’ format. If the name appears to be a CJK name (as determined by a heuristic), the ‘last first’ format will be used. There may be other cases that the ‘last first’ format is used which are not documented here. See the code at: http://google3/java/com/google/focus/backend/client/DisplayNameFormatter.java?l=659&rcl=351360938 | AppsPeopleOzExternalMergedpeopleapiBestDisplayName | The best suggested name to use for the Person from the available source fields, which may include FileAs, Name, Org, Email, IM, Phone, … Rough source container priority order is Contact, then Profile, then Place. | String |
| displayNameLastFirst | The display name, always in ‘last first’ format. This field does not depend on the format of `display_name` and will always be in ‘last first’ format. | AppsPeopleOzExternalMergedpeopleapiBestDisplayName | The best suggested name to use for the Person from the available source fields, which may include FileAs, Name, Org, Email, IM, Phone, … Rough source container priority order is Contact, then Profile, then Place. | String |
| ageDisableGracePeriod | Only supported for PROFILE/DOMAIN_PROFILE/ACCOUNT container. | AppsPeopleOzExternalMergedpeopleapiBirthday | IMPORTANT NOTES: – Requesting person.birthday requires membership in the purpose limited data ACL group sgbe-ac-d-birthday-(read|mutate). Contact people-api-eng@ for assistance with initial setup. – The birthday field should not be used to calculate the requester’s age! To determine the requester’s age, use person.age_range_repeated. – For more details about age see go/peopleapi-howto/age Birthday value may not be present: – Consumer users generally required to have account birthday set (required at account creation), though some users created via legacy flows may not have birthday present. – Dasher users generally don’t require birthday, but could optionally have it set by users. – Any other types of accounts (e.g. robot, service) do not have birthdays. – Account Birthday field may be present but without birthday value set for grace period birthday (provisional new birthday). For users that do have birthday data: – “Profile Birthday” (person.birthday.metadata.container is PROFILE) may not have a year set if user “hides” the year. – “Account Birthday” (see api-specific notes below) will only be returned for the requester’s own profile. – People API (go/peopleapi): * Account birthday is only supported in GetPeople for PeopleAPI. * If account birthday is needed, use a request mask with: `include_field { paths: “person.birthday” }` `include_container: ACCOUNT` – People API++ (go/peopleapi++): * Account birthday is supported for most apis in PeopleAPI++. * If account birthday is needed, use a request mask with: `include_field { paths: “person.account_birthday” }` `include_container: PROFILE` (note: it will also need `include_container: DOMAIN_PROFILE` because they must be requested together: go/people-api-masks#profile-domain_profile) – See go/papi-vs-papi++#birthday for more details. | AppsPeopleOzExternalMergedpeopleapiBirthdayAgeDisableGracePeriod |
| birthdayDecoration | Whether the user has opted in to display their birthday via photo decorations. Only supported for PROFILE/DOMAIN_PROFILE container. | AppsPeopleOzExternalMergedpeopleapiBirthday | IMPORTANT NOTES: – Requesting person.birthday requires membership in the purpose limited data ACL group sgbe-ac-d-birthday-(read|mutate). Contact people-api-eng@ for assistance with initial setup. – The birthday field should not be used to calculate the requester’s age! To determine the requester’s age, use person.age_range_repeated. – For more details about age see go/peopleapi-howto/age Birthday value may not be present: – Consumer users generally required to have account birthday set (required at account creation), though some users created via legacy flows may not have birthday present. – Dasher users generally don’t require birthday, but could optionally have it set by users. – Any other types of accounts (e.g. robot, service) do not have birthdays. – Account Birthday field may be present but without birthday value set for grace period birthday (provisional new birthday). For users that do have birthday data: – “Profile Birthday” (person.birthday.metadata.container is PROFILE) may not have a year set if user “hides” the year. – “Account Birthday” (see api-specific notes below) will only be returned for the requester’s own profile. – People API (go/peopleapi): * Account birthday is only supported in GetPeople for PeopleAPI. * If account birthday is needed, use a request mask with: `include_field { paths: “person.birthday” }` `include_container: ACCOUNT` – People API++ (go/peopleapi++): * Account birthday is supported for most apis in PeopleAPI++. * If account birthday is needed, use a request mask with: `include_field { paths: “person.account_birthday” }` `include_container: PROFILE` (note: it will also need `include_container: DOMAIN_PROFILE` because they must be requested together: go/people-api-masks#profile-domain_profile) – See go/papi-vs-papi++#birthday for more details. | SocialGraphApiProtoBirthdayDecoration |
| birthdayResolution | Only supported for PROFILE/DOMAIN_PROFILE/ACCOUNT container. | AppsPeopleOzExternalMergedpeopleapiBirthday | IMPORTANT NOTES: – Requesting person.birthday requires membership in the purpose limited data ACL group sgbe-ac-d-birthday-(read|mutate). Contact people-api-eng@ for assistance with initial setup. – The birthday field should not be used to calculate the requester’s age! To determine the requester’s age, use person.age_range_repeated. – For more details about age see go/peopleapi-howto/age Birthday value may not be present: – Consumer users generally required to have account birthday set (required at account creation), though some users created via legacy flows may not have birthday present. – Dasher users generally don’t require birthday, but could optionally have it set by users. – Any other types of accounts (e.g. robot, service) do not have birthdays. – Account Birthday field may be present but without birthday value set for grace period birthday (provisional new birthday). For users that do have birthday data: – “Profile Birthday” (person.birthday.metadata.container is PROFILE) may not have a year set if user “hides” the year. – “Account Birthday” (see api-specific notes below) will only be returned for the requester’s own profile. – People API (go/peopleapi): * Account birthday is only supported in GetPeople for PeopleAPI. * If account birthday is needed, use a request mask with: `include_field { paths: “person.birthday” }` `include_container: ACCOUNT` – People API++ (go/peopleapi++): * Account birthday is supported for most apis in PeopleAPI++. * If account birthday is needed, use a request mask with: `include_field { paths: “person.account_birthday” }` `include_container: PROFILE` (note: it will also need `include_container: DOMAIN_PROFILE` because they must be requested together: go/people-api-masks#profile-domain_profile) – See go/papi-vs-papi++#birthday for more details. | String |
| calendarDay | Birthdays are more accurately represented as a calendar day that does not depend on a timestamp representation at all. When given a timestamp, there are lots of opportunities to make mistakes, so a CalendarDay proto is replacing timestamps. Currently this is always returned by PeopleApi on reads that include birthday fields. New clients should write using calendar_day. Clients that were already writing via date_ms are allowlisted such that writes use that field. Old callers should migrate to writing BOTH date_ms and calendar_day values. If those are consistent, they may be removed from the ‘legacy_timestamp_event_write_behavior_enabled’ capability. | AppsPeopleOzExternalMergedpeopleapiBirthday | IMPORTANT NOTES: – Requesting person.birthday requires membership in the purpose limited data ACL group sgbe-ac-d-birthday-(read|mutate). Contact people-api-eng@ for assistance with initial setup. – The birthday field should not be used to calculate the requester’s age! To determine the requester’s age, use person.age_range_repeated. – For more details about age see go/peopleapi-howto/age Birthday value may not be present: – Consumer users generally required to have account birthday set (required at account creation), though some users created via legacy flows may not have birthday present. – Dasher users generally don’t require birthday, but could optionally have it set by users. – Any other types of accounts (e.g. robot, service) do not have birthdays. – Account Birthday field may be present but without birthday value set for grace period birthday (provisional new birthday). For users that do have birthday data: – “Profile Birthday” (person.birthday.metadata.container is PROFILE) may not have a year set if user “hides” the year. – “Account Birthday” (see api-specific notes below) will only be returned for the requester’s own profile. – People API (go/peopleapi): * Account birthday is only supported in GetPeople for PeopleAPI. * If account birthday is needed, use a request mask with: `include_field { paths: “person.birthday” }` `include_container: ACCOUNT` – People API++ (go/peopleapi++): * Account birthday is supported for most apis in PeopleAPI++. * If account birthday is needed, use a request mask with: `include_field { paths: “person.account_birthday” }` `include_container: PROFILE` (note: it will also need `include_container: DOMAIN_PROFILE` because they must be requested together: go/people-api-masks#profile-domain_profile) – See go/papi-vs-papi++#birthday for more details. | GoogleTypeDate |
| dateMs | Birthdays are currently represented as timestamp values, although the interpretation of these timestamp values is a calendar date. Clients are recommended to read the calendar_day field, which is easier to work with than date_ms. New clients writing to PeopleApi must set calendar_day instead of date_ms. There are a few important details about how this value should be mapped to a calendar date that should be consistent among all clients. 1. Epoch – The epoch or calendar date equivalent to 0 ms is chosen to be 1970-01-01 UTC. 2. Timezone – All of the conversions to calendars should occur in the UTC timezone. We don’t typically think of someones birthday changing when they travel, so clients should not use local times. 3. Calendar – The calendar used for the dates should be a Gregorian proleptic calendar. Proleptic means that the rules of the Gregorian calendar are retrofitted to before its adoption. It is easy to get this wrong, particularly with the java GregorianCalendar class, which by default is a mixed Gregorian/Julian calendar. Joda Time makes this easy, but if it’s not an option, look into GregorianCalendar.setGregorianChange(). 4. Omitted years – Clients have chosen to represent birthdays or events without years as timestamps within the year zero. When the computed date has a year of 0, it means the client did not specify a year. Note that a year 0 does not exist in a chronology like the familiar Anno Domini (A.D. and B.C.); clients must agree on year numbering. 5. Year Numbering – The chronology used to map dates to the calendar should use Astronomical Year Numbering so that the year 0 is defined and dates before it have a negative year. If libraries only provide Anno Domini, then the year of 1 BC corresponds to year zero and an omitted user provided year. Other BC values are presumed rare, but clients should still not ignore the era and interpret the year as an A.D. value, especially if writing values back to PeopleApi. | AppsPeopleOzExternalMergedpeopleapiBirthday | IMPORTANT NOTES: – Requesting person.birthday requires membership in the purpose limited data ACL group sgbe-ac-d-birthday-(read|mutate). Contact people-api-eng@ for assistance with initial setup. – The birthday field should not be used to calculate the requester’s age! To determine the requester’s age, use person.age_range_repeated. – For more details about age see go/peopleapi-howto/age Birthday value may not be present: – Consumer users generally required to have account birthday set (required at account creation), though some users created via legacy flows may not have birthday present. – Dasher users generally don’t require birthday, but could optionally have it set by users. – Any other types of accounts (e.g. robot, service) do not have birthdays. – Account Birthday field may be present but without birthday value set for grace period birthday (provisional new birthday). For users that do have birthday data: – “Profile Birthday” (person.birthday.metadata.container is PROFILE) may not have a year set if user “hides” the year. – “Account Birthday” (see api-specific notes below) will only be returned for the requester’s own profile. – People API (go/peopleapi): * Account birthday is only supported in GetPeople for PeopleAPI. * If account birthday is needed, use a request mask with: `include_field { paths: “person.birthday” }` `include_container: ACCOUNT` – People API++ (go/peopleapi++): * Account birthday is supported for most apis in PeopleAPI++. * If account birthday is needed, use a request mask with: `include_field { paths: “person.account_birthday” }` `include_container: PROFILE` (note: it will also need `include_container: DOMAIN_PROFILE` because they must be requested together: go/people-api-masks#profile-domain_profile) – See go/papi-vs-papi++#birthday for more details. | String |
| dateMsAsNumber | date_ms_as_number contains the same data as date_ms, but has a different type in generated javascript bindings. Non javascript clients can ignore it. | AppsPeopleOzExternalMergedpeopleapiBirthday | IMPORTANT NOTES: – Requesting person.birthday requires membership in the purpose limited data ACL group sgbe-ac-d-birthday-(read|mutate). Contact people-api-eng@ for assistance with initial setup. – The birthday field should not be used to calculate the requester’s age! To determine the requester’s age, use person.age_range_repeated. – For more details about age see go/peopleapi-howto/age Birthday value may not be present: – Consumer users generally required to have account birthday set (required at account creation), though some users created via legacy flows may not have birthday present. – Dasher users generally don’t require birthday, but could optionally have it set by users. – Any other types of accounts (e.g. robot, service) do not have birthdays. – Account Birthday field may be present but without birthday value set for grace period birthday (provisional new birthday). For users that do have birthday data: – “Profile Birthday” (person.birthday.metadata.container is PROFILE) may not have a year set if user “hides” the year. – “Account Birthday” (see api-specific notes below) will only be returned for the requester’s own profile. – People API (go/peopleapi): * Account birthday is only supported in GetPeople for PeopleAPI. * If account birthday is needed, use a request mask with: `include_field { paths: “person.birthday” }` `include_container: ACCOUNT` – People API++ (go/peopleapi++): * Account birthday is supported for most apis in PeopleAPI++. * If account birthday is needed, use a request mask with: `include_field { paths: “person.account_birthday” }` `include_container: PROFILE` (note: it will also need `include_container: DOMAIN_PROFILE` because they must be requested together: go/people-api-masks#profile-domain_profile) – See go/papi-vs-papi++#birthday for more details. | String |
| metadata | AppsPeopleOzExternalMergedpeopleapiBirthday | IMPORTANT NOTES: – Requesting person.birthday requires membership in the purpose limited data ACL group sgbe-ac-d-birthday-(read|mutate). Contact people-api-eng@ for assistance with initial setup. – The birthday field should not be used to calculate the requester’s age! To determine the requester’s age, use person.age_range_repeated. – For more details about age see go/peopleapi-howto/age Birthday value may not be present: – Consumer users generally required to have account birthday set (required at account creation), though some users created via legacy flows may not have birthday present. – Dasher users generally don’t require birthday, but could optionally have it set by users. – Any other types of accounts (e.g. robot, service) do not have birthdays. – Account Birthday field may be present but without birthday value set for grace period birthday (provisional new birthday). For users that do have birthday data: – “Profile Birthday” (person.birthday.metadata.container is PROFILE) may not have a year set if user “hides” the year. – “Account Birthday” (see api-specific notes below) will only be returned for the requester’s own profile. – People API (go/peopleapi): * Account birthday is only supported in GetPeople for PeopleAPI. * If account birthday is needed, use a request mask with: `include_field { paths: “person.birthday” }` `include_container: ACCOUNT` – People API++ (go/peopleapi++): * Account birthday is supported for most apis in PeopleAPI++. * If account birthday is needed, use a request mask with: `include_field { paths: “person.account_birthday” }` `include_container: PROFILE` (note: it will also need `include_container: DOMAIN_PROFILE` because they must be requested together: go/people-api-masks#profile-domain_profile) – See go/papi-vs-papi++#birthday for more details. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| prompt | People Prompts settings for contact birthday data. Only supported for CONTACT container. | AppsPeopleOzExternalMergedpeopleapiBirthday | IMPORTANT NOTES: – Requesting person.birthday requires membership in the purpose limited data ACL group sgbe-ac-d-birthday-(read|mutate). Contact people-api-eng@ for assistance with initial setup. – The birthday field should not be used to calculate the requester’s age! To determine the requester’s age, use person.age_range_repeated. – For more details about age see go/peopleapi-howto/age Birthday value may not be present: – Consumer users generally required to have account birthday set (required at account creation), though some users created via legacy flows may not have birthday present. – Dasher users generally don’t require birthday, but could optionally have it set by users. – Any other types of accounts (e.g. robot, service) do not have birthdays. – Account Birthday field may be present but without birthday value set for grace period birthday (provisional new birthday). For users that do have birthday data: – “Profile Birthday” (person.birthday.metadata.container is PROFILE) may not have a year set if user “hides” the year. – “Account Birthday” (see api-specific notes below) will only be returned for the requester’s own profile. – People API (go/peopleapi): * Account birthday is only supported in GetPeople for PeopleAPI. * If account birthday is needed, use a request mask with: `include_field { paths: “person.birthday” }` `include_container: ACCOUNT` – People API++ (go/peopleapi++): * Account birthday is supported for most apis in PeopleAPI++. * If account birthday is needed, use a request mask with: `include_field { paths: “person.account_birthday” }` `include_container: PROFILE` (note: it will also need `include_container: DOMAIN_PROFILE` because they must be requested together: go/people-api-masks#profile-domain_profile) – See go/papi-vs-papi++#birthday for more details. | SocialGraphApiProtoPrompt |
| value | Actual value entered. Allows unstructured values. | AppsPeopleOzExternalMergedpeopleapiBirthday | IMPORTANT NOTES: – Requesting person.birthday requires membership in the purpose limited data ACL group sgbe-ac-d-birthday-(read|mutate). Contact people-api-eng@ for assistance with initial setup. – The birthday field should not be used to calculate the requester’s age! To determine the requester’s age, use person.age_range_repeated. – For more details about age see go/peopleapi-howto/age Birthday value may not be present: – Consumer users generally required to have account birthday set (required at account creation), though some users created via legacy flows may not have birthday present. – Dasher users generally don’t require birthday, but could optionally have it set by users. – Any other types of accounts (e.g. robot, service) do not have birthdays. – Account Birthday field may be present but without birthday value set for grace period birthday (provisional new birthday). For users that do have birthday data: – “Profile Birthday” (person.birthday.metadata.container is PROFILE) may not have a year set if user “hides” the year. – “Account Birthday” (see api-specific notes below) will only be returned for the requester’s own profile. – People API (go/peopleapi): * Account birthday is only supported in GetPeople for PeopleAPI. * If account birthday is needed, use a request mask with: `include_field { paths: “person.birthday” }` `include_container: ACCOUNT` – People API++ (go/peopleapi++): * Account birthday is supported for most apis in PeopleAPI++. * If account birthday is needed, use a request mask with: `include_field { paths: “person.account_birthday” }` `include_container: PROFILE` (note: it will also need `include_container: DOMAIN_PROFILE` because they must be requested together: go/people-api-masks#profile-domain_profile) – See go/papi-vs-papi++#birthday for more details. | String |
| calendarDay | Provisional birthday | AppsPeopleOzExternalMergedpeopleapiBirthdayAgeDisableGracePeriod | Whether this field is set or not determines whether an account is in the grace period. While in the grace period, the user is unable to change their birthday on their own, and will be age-disabled if they don’t act in a limited amount of time. Applies only to ServiceData Birthday. Users enter the grace period if they choose a birthday below the Age of Consent (go/aoc). After the grace period ends, the account will be age disabled. See go/age-disable-grace-period-dd. | GoogleTypeDate |
|
| gracePeriodEnd | Timestamp which signifies the end of the grace period for this account. | AppsPeopleOzExternalMergedpeopleapiBirthdayAgeDisableGracePeriod | Whether this field is set or not determines whether an account is in the grace period. While in the grace period, the user is unable to change their birthday on their own, and will be age-disabled if they don’t act in a limited amount of time. Applies only to ServiceData Birthday. Users enter the grace period if they choose a birthday below the Age of Consent (go/aoc). After the grace period ends, the account will be age disabled. See go/age-disable-grace-period-dd. | DateTime |
| gracePeriodStart | Timestamp which signifies the start of the grace period for this account. | AppsPeopleOzExternalMergedpeopleapiBirthdayAgeDisableGracePeriod | Whether this field is set or not determines whether an account is in the grace period. While in the grace period, the user is unable to change their birthday on their own, and will be age-disabled if they don’t act in a limited amount of time. Applies only to ServiceData Birthday. Users enter the grace period if they choose a birthday below the Age of Consent (go/aoc). After the grace period ends, the account will be age disabled. See go/age-disable-grace-period-dd. | DateTime |
| gracePeriodType | AppsPeopleOzExternalMergedpeopleapiBirthdayAgeDisableGracePeriod | Whether this field is set or not determines whether an account is in the grace period. While in the grace period, the user is unable to change their birthday on their own, and will be age-disabled if they don’t act in a limited amount of time. Applies only to ServiceData Birthday. Users enter the grace period if they choose a birthday below the Age of Consent (go/aoc). After the grace period ends, the account will be age disabled. See go/age-disable-grace-period-dd. | String | |
| manualGracePeriodInfo | AppsPeopleOzExternalMergedpeopleapiBirthdayAgeDisableGracePeriod | Whether this field is set or not determines whether an account is in the grace period. While in the grace period, the user is unable to change their birthday on their own, and will be age-disabled if they don’t act in a limited amount of time. Applies only to ServiceData Birthday. Users enter the grace period if they choose a birthday below the Age of Consent (go/aoc). After the grace period ends, the account will be age disabled. See go/age-disable-grace-period-dd. | AppsPeopleOzExternalMergedpeopleapiBirthdayAgeDisableGracePeriodManualGracePeriodInfo | |
| escalateTo | The Gaia ID of an email that ops can send inquiries to for appeals. | AppsPeopleOzExternalMergedpeopleapiBirthdayAgeDisableGracePeriodManualGracePeriodInfo | Information provided within MutateDataRequest when setting a user into AgeDisableGracePeriod manually. When the grace period expires, this info will be forwarded to Gaia when disabling the user. cs//symbol:InitiateAgeDisableGracePeriodArguments | String |
| executedBy | The Gaia ID of a Googler who initiated this disable. | AppsPeopleOzExternalMergedpeopleapiBirthdayAgeDisableGracePeriodManualGracePeriodInfo | Information provided within MutateDataRequest when setting a user into AgeDisableGracePeriod manually. When the grace period expires, this info will be forwarded to Gaia when disabling the user. cs//symbol:InitiateAgeDisableGracePeriodArguments | String |
| reason | When setting a user into age grace period manually, the requester can additionally supply a short human-readable reason of why the account is put into manual grace period. The description will be forwarded to Gaia when we disable the account when the grace period expires. | AppsPeopleOzExternalMergedpeopleapiBirthdayAgeDisableGracePeriodManualGracePeriodInfo | Information provided within MutateDataRequest when setting a user into AgeDisableGracePeriod manually. When the grace period expires, this info will be forwarded to Gaia when disabling the user. cs//symbol:InitiateAgeDisableGracePeriodArguments | String |
| metadata | AppsPeopleOzExternalMergedpeopleapiBraggingRights | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| value | AppsPeopleOzExternalMergedpeopleapiBraggingRights | String | ||
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiCalendar | A url to the person’s calendar. As of 03/2018 is not supported for user Profile. | String |
| metadata | AppsPeopleOzExternalMergedpeopleapiCalendar | A url to the person’s calendar. As of 03/2018 is not supported for user Profile. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| type | The type of the calendar URL. The type can be free form or one of these predefined values: * `home` * `freeBusy` * `work` | AppsPeopleOzExternalMergedpeopleapiCalendar | A url to the person’s calendar. As of 03/2018 is not supported for user Profile. | String |
| url | AppsPeopleOzExternalMergedpeopleapiCalendar | A url to the person’s calendar. As of 03/2018 is not supported for user Profile. | String | |
| callerIdSource | Indicates which data source was used to populate the caller ID result | AppsPeopleOzExternalMergedpeopleapiCallerIdExtendedData | AppsPeopleOzExternalMergedpeopleapiCallerIdExtendedDataCallerIdSource | |
| sourceType | AppsPeopleOzExternalMergedpeopleapiCallerIdExtendedDataCallerIdSource | String | ||
| bornBefore | Indicates that the user was born at or before this time. | AppsPeopleOzExternalMergedpeopleapiCertifiedBornBefore | Information related to domain administrator (or authority) certification of a users age. | DateTime |
| metadata | AppsPeopleOzExternalMergedpeopleapiCertifiedBornBefore | Information related to domain administrator (or authority) certification of a users age. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| channelId | Unique ID that corresponds to a Youtube channel. | AppsPeopleOzExternalMergedpeopleapiChannelData | String | |
| commentCount | Number of comments for a given Youtube channel. | AppsPeopleOzExternalMergedpeopleapiChannelData | String | |
| description | Description of the channel. | AppsPeopleOzExternalMergedpeopleapiChannelData | String | |
| playlistCount | AppsPeopleOzExternalMergedpeopleapiChannelData | String | ||
| profilePictureUrl | A FIFE URL pointing to the channel’s profile image (go/avatar-fife-urls) with default fife url options. Also refer to go/people-api-concepts:photos for People API’s FIFE best practices. The image could be up to a couple of days stale, though it is much fresher in practice. If a fresh image is required, contact the YouTubeAccountProfileService. The URL itself expires ~30 days after generation. | AppsPeopleOzExternalMergedpeopleapiChannelData | String | |
| profileUrl | URL of user’s Youtube channel profile. | AppsPeopleOzExternalMergedpeopleapiChannelData | String | |
| subscriberCount | Number of subscribers for a given Youtube channel. | AppsPeopleOzExternalMergedpeopleapiChannelData | String | |
| title | Title of the YouTube channel | AppsPeopleOzExternalMergedpeopleapiChannelData | String | |
| usesYoutubeNames | Whether or not the channel’s profile has a title/avatar that is canonical in YouTube. Used to determine if the product profile card should be part of the core persona or have their own persona. | AppsPeopleOzExternalMergedpeopleapiChannelData | boolean | |
| videoCount | Number of videos uploaded in a given Youtube channel. | AppsPeopleOzExternalMergedpeopleapiChannelData | String | |
| circleId | The circle that the person belongs to. | AppsPeopleOzExternalMergedpeopleapiCircleMembership | A circle membership that the person has. A circle membership is created by adding a person to a circle by person-id or by email. | String |
| metadata | AppsPeopleOzExternalMergedpeopleapiCircleMembership | A circle membership that the person has. A circle membership is created by adding a person to a circle by person-id or by email. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| key | AppsPeopleOzExternalMergedpeopleapiClientData | Arbitrary client data that is populated based on the client | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiClientData | Arbitrary client data that is populated based on the client | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| namespace | AppsPeopleOzExternalMergedpeopleapiClientData | Arbitrary client data that is populated based on the client | String | |
| value | AppsPeopleOzExternalMergedpeopleapiClientData | Arbitrary client data that is populated based on the client | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiCommunicationEmail | Email for Google product communication with the user. This is only allowed in ServiceData. It is purely synthesized and read-only, and contains at most one field. It proxies from RawCommunicationEmail and only includes the primary field if exists. Otherwise if RawCommunicationEmail does not have primary, this includes a field synthesized from valid Gaia primary account email. Otherwise if Gaia primary account email is invalid, this field is empty. See go/comm-email-use for more details. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| value | AppsPeopleOzExternalMergedpeopleapiCommunicationEmail | Email for Google product communication with the user. This is only allowed in ServiceData. It is purely synthesized and read-only, and contains at most one field. It proxies from RawCommunicationEmail and only includes the primary field if exists. Otherwise if RawCommunicationEmail does not have primary, this includes a field synthesized from valid Gaia primary account email. Otherwise if Gaia primary account email is invalid, this field is empty. See go/comm-email-use for more details. | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiConnectionReminder | Contact-level people-prompts settings and contact-level connection reminders. Part of go/people-prompts. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| prompt | Contact-level “reminder to connect” prompts for this contact. | AppsPeopleOzExternalMergedpeopleapiConnectionReminder | Contact-level people-prompts settings and contact-level connection reminders. Part of go/people-prompts. | list(SocialGraphApiProtoPrompt) |
| contactCreateContext | AppsPeopleOzExternalMergedpeopleapiContactCreateContextInfo | Contact creation timestamps and related metadata. See go/contact-edit-history. This message is a pure wrapper of the shared ContactCreactionContext message so that it can be a top-level person field. No other fields should be added to the message. | SocialGraphApiProtoContactCreateContext | |
| metadata | AppsPeopleOzExternalMergedpeopleapiContactCreateContextInfo | Contact creation timestamps and related metadata. See go/contact-edit-history. This message is a pure wrapper of the shared ContactCreactionContext message so that it can be a top-level person field. No other fields should be added to the message. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| contactEditContext | AppsPeopleOzExternalMergedpeopleapiContactEditContextInfo | Contact edit timestamps and related metadata. See go/contact-edit-history. This message is a pure wrapper of the shared ContactCreactionContext message so that it can be a top-level person field. No other fields should be added to the message. | SocialGraphApiProtoContactEditContext | |
| metadata | AppsPeopleOzExternalMergedpeopleapiContactEditContextInfo | Contact edit timestamps and related metadata. See go/contact-edit-history. This message is a pure wrapper of the shared ContactCreactionContext message so that it can be a top-level person field. No other fields should be added to the message. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| contactGroupId | The contact-group that the person belong to. The id can be either a hex-formatted id or a camel-cased SystemContactGroup predefined group name. The id will be predefined group name iff the system_contact_group_id has a value. | AppsPeopleOzExternalMergedpeopleapiContactGroupMembership | A membership that the person has. The person can be a member of multiple circles and multiple contact-groups. A circle membership is created by adding a person to a circle by person-id or by email. A contact-group membership is created by adding a contact to a contact-group. | String |
| delegatedGroupInfo | Information related to delegated group that this contact belongs to. | AppsPeopleOzExternalMergedpeopleapiContactGroupMembership | A membership that the person has. The person can be a member of multiple circles and multiple contact-groups. A circle membership is created by adding a person to a circle by person-id or by email. A contact-group membership is created by adding a contact to a contact-group. | AppsPeopleOzExternalMergedpeopleapiDelegatedGroupInfo |
| metadata | AppsPeopleOzExternalMergedpeopleapiContactGroupMembership | A membership that the person has. The person can be a member of multiple circles and multiple contact-groups. A circle membership is created by adding a person to a circle by person-id or by email. A contact-group membership is created by adding a contact to a contact-group. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| systemContactGroupId | This field will be populated when the membership is in a system-reserved contact-group. | AppsPeopleOzExternalMergedpeopleapiContactGroupMembership | A membership that the person has. The person can be a member of multiple circles and multiple contact-groups. A circle membership is created by adding a person to a circle by person-id or by email. A contact-group membership is created by adding a contact to a contact-group. | String |
| contactPromptSettings | AppsPeopleOzExternalMergedpeopleapiContactPromptSettingsInfo | Contact level People Prompt settings. This message is a pure wrapper of the shared ContactPromptSettings message so that it can be a top-level person field. No other fields should be added to the message. | SocialGraphApiProtoContactPromptSettings | |
| metadata | AppsPeopleOzExternalMergedpeopleapiContactPromptSettingsInfo | Contact level People Prompt settings. This message is a pure wrapper of the shared ContactPromptSettings message so that it can be a top-level person field. No other fields should be added to the message. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| contactState | AppsPeopleOzExternalMergedpeopleapiContactStateInfo | Contact state and related metadata. See go/fbs-contacts-trash. This message is a pure wrapper of the shared ContactState message so that it can be a top-level person field. No other fields should be added to the message. | SocialGraphApiProtoContactState | |
| metadata | AppsPeopleOzExternalMergedpeopleapiContactStateInfo | Contact state and related metadata. See go/fbs-contacts-trash. This message is a pure wrapper of the shared ContactState message so that it can be a top-level person field. No other fields should be added to the message. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| imageHeight | AppsPeopleOzExternalMergedpeopleapiCoverPhoto | CoverPhoto is the long banner photo (also called full bleed photo) at the top of G+ profile page. | integer | |
| imageId | AppsPeopleOzExternalMergedpeopleapiCoverPhoto | CoverPhoto is the long banner photo (also called full bleed photo) at the top of G+ profile page. | String | |
| imageUrl | AppsPeopleOzExternalMergedpeopleapiCoverPhoto | CoverPhoto is the long banner photo (also called full bleed photo) at the top of G+ profile page. | String | |
| imageWidth | AppsPeopleOzExternalMergedpeopleapiCoverPhoto | CoverPhoto is the long banner photo (also called full bleed photo) at the top of G+ profile page. | integer | |
| isAnimated | AppsPeopleOzExternalMergedpeopleapiCoverPhoto | CoverPhoto is the long banner photo (also called full bleed photo) at the top of G+ profile page. | boolean | |
| isDefault | AppsPeopleOzExternalMergedpeopleapiCoverPhoto | CoverPhoto is the long banner photo (also called full bleed photo) at the top of G+ profile page. | boolean | |
| metadata | AppsPeopleOzExternalMergedpeopleapiCoverPhoto | CoverPhoto is the long banner photo (also called full bleed photo) at the top of G+ profile page. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| customerId | DEPRECATED. Use obfuscated_customer_id instead. If result has a GSuite Customer ID, this field will continue to be populated with -1 to indicate the presence of a value for backwards compatibility with clients in the wild. See b/144596193. | AppsPeopleOzExternalMergedpeopleapiCustomerInfo | Contains customer data for profile owner proxied from D3. | String |
| customerName | Customer organization name for dasher user. | AppsPeopleOzExternalMergedpeopleapiCustomerInfo | Contains customer data for profile owner proxied from D3. | String |
| obfuscatedCustomerId | Obfuscated FlexOrgs customer ID for Dasher user. See cs/symbol:CustomerIdObfuscator. | AppsPeopleOzExternalMergedpeopleapiCustomerInfo | Contains customer data for profile owner proxied from D3. | String |
| fieldDisplayName | AppsPeopleOzExternalMergedpeopleapiCustomSchemaField | Custom fields associated with a person, from the custom schema defined on the domain. See go/custompeopleapi and go/customfocus. NOTE: these are only updatable via Cloud Directory (go/cd). | String | |
| fieldId | AppsPeopleOzExternalMergedpeopleapiCustomSchemaField | Custom fields associated with a person, from the custom schema defined on the domain. See go/custompeopleapi and go/customfocus. NOTE: these are only updatable via Cloud Directory (go/cd). | String | |
| fieldType | AppsPeopleOzExternalMergedpeopleapiCustomSchemaField | Custom fields associated with a person, from the custom schema defined on the domain. See go/custompeopleapi and go/customfocus. NOTE: these are only updatable via Cloud Directory (go/cd). | String | |
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiCustomSchemaField | Custom fields associated with a person, from the custom schema defined on the domain. See go/custompeopleapi and go/customfocus. NOTE: these are only updatable via Cloud Directory (go/cd). | String |
| metadata | AppsPeopleOzExternalMergedpeopleapiCustomSchemaField | Custom fields associated with a person, from the custom schema defined on the domain. See go/custompeopleapi and go/customfocus. NOTE: these are only updatable via Cloud Directory (go/cd). | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| multiValued | AppsPeopleOzExternalMergedpeopleapiCustomSchemaField | Custom fields associated with a person, from the custom schema defined on the domain. See go/custompeopleapi and go/customfocus. NOTE: these are only updatable via Cloud Directory (go/cd). | boolean | |
| schemaDisplayName | AppsPeopleOzExternalMergedpeopleapiCustomSchemaField | Custom fields associated with a person, from the custom schema defined on the domain. See go/custompeopleapi and go/customfocus. NOTE: these are only updatable via Cloud Directory (go/cd). | String | |
| schemaId | AppsPeopleOzExternalMergedpeopleapiCustomSchemaField | Custom fields associated with a person, from the custom schema defined on the domain. See go/custompeopleapi and go/customfocus. NOTE: these are only updatable via Cloud Directory (go/cd). | String | |
| type | The type of the custom schema field. The type can be free form or one of these predefined values: * `home` * `other` * `work` | AppsPeopleOzExternalMergedpeopleapiCustomSchemaField | Custom fields associated with a person, from the custom schema defined on the domain. See go/custompeopleapi and go/customfocus. NOTE: these are only updatable via Cloud Directory (go/cd). | String |
| value | String representation of the value, based on FieldType | AppsPeopleOzExternalMergedpeopleapiCustomSchemaField | Custom fields associated with a person, from the custom schema defined on the domain. See go/custompeopleapi and go/customfocus. NOTE: these are only updatable via Cloud Directory (go/cd). | String |
| containerType | See SourceIdentity.container_type | AppsPeopleOzExternalMergedpeopleapiDedupedContainerInfo | Container information for deduping. When two fields have the same value and only differ by field.metadata a service implementation can choose to avoid duplicating the fields and instead set field.metadata.other_deduped_containers This type can include information on the dedupe type (for example, strict value match vs. lenient value match) | String |
| id | See SourceIdentity.id | AppsPeopleOzExternalMergedpeopleapiDedupedContainerInfo | Container information for deduping. When two fields have the same value and only differ by field.metadata a service implementation can choose to avoid duplicating the fields and instead set field.metadata.other_deduped_containers This type can include information on the dedupe type (for example, strict value match vs. lenient value match) | String |
| delegatedGroupId | Required. The additional id specifically for a delegated group. | AppsPeopleOzExternalMergedpeopleapiDelegatedGroupInfo | Information related to delegated group that this contact belongs to. | SocialGraphApiProtoDelegatedGroupId |
| attributes | Attributes for this device contact. | AppsPeopleOzExternalMergedpeopleapiDeviceContactExtraMetadata | Extra metadata for an aggregated or raw device contact. | list(String) |
| usageInfo | Usage info for this device contact. | AppsPeopleOzExternalMergedpeopleapiDeviceContactExtraMetadata | Extra metadata for an aggregated or raw device contact. | list(SocialGraphApiProtoUsageInfo) |
| contactId | Aggregated device contact id on the source device. | AppsPeopleOzExternalMergedpeopleapiDeviceContactId | Unique id for an aggregated device contact. | String |
| deviceId | Source device id (go/client-instance-id) of this device contact. | AppsPeopleOzExternalMergedpeopleapiDeviceContactId | Unique id for an aggregated device contact. | String |
| deviceContactMetadata | Metadata for this device contact. | AppsPeopleOzExternalMergedpeopleapiDeviceContactInfo | Device contact information. | AppsPeopleOzExternalMergedpeopleapiDeviceContactExtraMetadata |
| hasCrossDeviceData | Output only. True if any of the contact’s phone, email or address fields can be used on devices other than the one it originated from. Note that there can be other fields, typically name, and metadata such as some of the raw_contact_infos that can be used on other devices. Assigned by the server. | AppsPeopleOzExternalMergedpeopleapiDeviceContactInfo | Device contact information. | boolean |
| id | Id of the device contact. | AppsPeopleOzExternalMergedpeopleapiDeviceContactInfo | Device contact information. | AppsPeopleOzExternalMergedpeopleapiDeviceContactId |
| lastClientUpdateTime | Last time a device contact was updated on device. | AppsPeopleOzExternalMergedpeopleapiDeviceContactInfo | Device contact information. | DateTime |
| lookupKey | An opaque value used by the device to look up this contact if its row id changed as a result of a sync or aggregation. See: https://developer.android.com/reference/android/provider/ContactsContract.ContactsColumns.html#LOOKUP_KEY | AppsPeopleOzExternalMergedpeopleapiDeviceContactInfo | Device contact information. | String |
| rawContactInfo | Info about the raw device contacts that make up this device contact. | AppsPeopleOzExternalMergedpeopleapiDeviceContactInfo | Device contact information. | list(AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo) |
| containerId | The container ID of the entity this field creates a join to. See `SourceIdentity.id`. | AppsPeopleOzExternalMergedpeopleapiEdgeKeyInfo | String | |
| containerType | The type of container that this edge points to. See `SourceIdentity.container_type`. | AppsPeopleOzExternalMergedpeopleapiEdgeKeyInfo | String | |
| extendedData | Data that is added to the proto by peopleapi read extensions. | AppsPeopleOzExternalMergedpeopleapiEdgeKeyInfo | AppsPeopleOzExternalMergedpeopleapiEdgeKeyInfoExtensionData | |
| materialized | True indicates this edge links this source to a container represented by this person object. Note: Except for certain legacy clients, EdgeKeyInfo is only created for for edges to an entity in this person and this will always be true. | AppsPeopleOzExternalMergedpeopleapiEdgeKeyInfo | boolean | |
| gdataCompatibilityExtensionId | The GDataCompatibilityExtension will (temporarily) return mobile_owner_id for profile containers. | AppsPeopleOzExternalMergedpeopleapiEdgeKeyInfoExtensionData | String | |
| certificate | AppsPeopleOzExternalMergedpeopleapiEmail | list(AppsPeopleOzExternalMergedpeopleapiEmailCertificate) | ||
| classification | AppsPeopleOzExternalMergedpeopleapiEmail | String | ||
| contactGroupPreference | To read or update, use the CONTACT_GROUP_PREFERENCE mask field. | AppsPeopleOzExternalMergedpeopleapiEmail | list(AppsPeopleOzExternalMergedpeopleapiEmailContactGroupPreference) | |
| displayName | AppsPeopleOzExternalMergedpeopleapiEmail | String | ||
| extendedData | AppsPeopleOzExternalMergedpeopleapiEmail | AppsPeopleOzExternalMergedpeopleapiEmailExtendedData | ||
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiEmail | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiEmail | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| signupEmailMetadata | AppsPeopleOzExternalMergedpeopleapiEmail | AppsPeopleOzExternalMergedpeopleapiEmailSignupEmailMetadata | ||
| type | The type of the email address. The type can be free form or one of these predefined values: * `home` * `work` * `other` | AppsPeopleOzExternalMergedpeopleapiEmail | String | |
| value | AppsPeopleOzExternalMergedpeopleapiEmail | String | ||
| configurationName | The name of this certificate configuration. Examples could be “High security level” or “For domain emails only”. | AppsPeopleOzExternalMergedpeopleapiEmailCertificate | Represents a S/MIME certificate config for use with Gmail. See //caribou/smime/proto/certificate_status.proto. There can be zero or more certificates associated with an email address, be it profile email or contact email. | String |
| metadata | It is conceivable that certificates could be ACLed. We also need to indicate which certificate is the default. The PersonFieldMetadata can accomplish both of these. | AppsPeopleOzExternalMergedpeopleapiEmailCertificate | Represents a S/MIME certificate config for use with Gmail. See //caribou/smime/proto/certificate_status.proto. There can be zero or more certificates associated with an email address, be it profile email or contact email. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata |
| status | AppsPeopleOzExternalMergedpeopleapiEmailCertificate | Represents a S/MIME certificate config for use with Gmail. See //caribou/smime/proto/certificate_status.proto. There can be zero or more certificates associated with an email address, be it profile email or contact email. | AppsPeopleOzExternalMergedpeopleapiEmailCertificateCertificateStatus | |
| notAfterSec | The certificate expiration timestamp in seconds. | AppsPeopleOzExternalMergedpeopleapiEmailCertificateCertificateStatus | Minimal S/MIME certificate status i.e. two fields per email address. | String |
| statusCode | Current status of the email’s certificate chain. | AppsPeopleOzExternalMergedpeopleapiEmailCertificateCertificateStatus | Minimal S/MIME certificate status i.e. two fields per email address. | String |
| contactGroupId | AppsPeopleOzExternalMergedpeopleapiEmailContactGroupPreference | Preferred email addresses for contact groups. | String | |
| isSynthetic | If the Preference was implicitly set by PeopleApi/Contacts Service. A preference with this bit will not be saved to storage. See go/contact-group-email-preference-papi-problem for more info. | AppsPeopleOzExternalMergedpeopleapiEmailContactGroupPreference | Preferred email addresses for contact groups. | boolean |
| type | AppsPeopleOzExternalMergedpeopleapiEmailContactGroupPreference | Preferred email addresses for contact groups. | String | |
| internalExternal | For use with the CUSTOMER_INFO_ADDITIONAL_DATA extension. This includes information on whether the given email is internal to or external to the requesting user’s domain. | AppsPeopleOzExternalMergedpeopleapiEmailExtendedData | Extension data for a person email. | PeoplestackFlexorgsProtoInternalExternal |
| isPlaceholder | For ListPeoplebyKnownId to indicate an email is sythesized from a lookup email. | AppsPeopleOzExternalMergedpeopleapiEmailExtendedData | Extension data for a person email. | boolean |
| smtpServerSupportsTls | For use with the TLS extension. Whether the SMTP server that handles delivery for this email address supports TLS encryption. | AppsPeopleOzExternalMergedpeopleapiEmailExtendedData | Extension data for a person email. | boolean |
| usesConfusingCharacters | For use with the Gmail Homograph Warning extension. Whether the email contains mixed character sets that could be used to decieve users. This field is populated by the GMAIL_SECURITY_DATA extension. | AppsPeopleOzExternalMergedpeopleapiEmailExtendedData | Extension data for a person email. | boolean |
| primary | This is considered to be the primary signup email. At most 1 signup email will have this set. | AppsPeopleOzExternalMergedpeopleapiEmailSignupEmailMetadata | Additional metadata for a signup email. This will only be set if the email’s classification is SIGNUP_EMAIL. | boolean |
| metadata | AppsPeopleOzExternalMergedpeopleapiEmergencyInfo | Emergency info for Person. See go/emergency-trusted-contacts-papi. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| pomeroyId | Opaque id from Pomeroy (go/pomeroy). Non-empty pomeroy_id means that this contact has the potential to become trusted contact or it’s already trusted contact. Trust is eventually gaia<->gaia link, but when the trust link is initiated gaia might not be known. Until gaia is discovered, pomeroy_id is used to identify the contact uniquely. If trust_level is missing or set to TRUST_LEVEL_UNSPECIFIED pomeroy_id must be empty. | AppsPeopleOzExternalMergedpeopleapiEmergencyInfo | Emergency info for Person. See go/emergency-trusted-contacts-papi. | String |
| trustLevel | AppsPeopleOzExternalMergedpeopleapiEmergencyInfo | Emergency info for Person. See go/emergency-trusted-contacts-papi. | String | |
| calendarDay | Event are more accurately represented as a calendar day that does not depend on a timestamp representation at all. When given a timestamp, there are lots of opportunities to make mistakes, so a CalendarDay proto is replacing timestamps. PeopleApi will return these values on reads, and unless the client is a legacy caller in the legacy_timestamp_event_write_behavior_enabled capability allowlist, this value is what is used for Person writes. | AppsPeopleOzExternalMergedpeopleapiEvent | GoogleTypeDate | |
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiEvent | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiEvent | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| prompt | People Prompts settings for contact event data. | AppsPeopleOzExternalMergedpeopleapiEvent | SocialGraphApiProtoPrompt | |
| timestampMillis | Clients are recommended to read the calendar_day field instead of timestamp_millis. When writing events, new clients must set calendar_day instead of timestamp_millis. Events are currently represented as timestamp values, although the interpretation of these timestamp values is a calendar date. There are a few important details about how this value should be mapped to a calendar date that should be consistent among all clients. For detailed information, see Birthday.date_ms. | AppsPeopleOzExternalMergedpeopleapiEvent | String | |
| type | The type of the event. The type can be free form or one of these predefined values: * `anniversary` * `other` | AppsPeopleOzExternalMergedpeopleapiEvent | String | |
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiExternalId | External identifier associated with the person. | String |
| metadata | AppsPeopleOzExternalMergedpeopleapiExternalId | External identifier associated with the person. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| type | The type of the external ID. The type can be free form or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization` | AppsPeopleOzExternalMergedpeopleapiExternalId | External identifier associated with the person. | String |
| value | AppsPeopleOzExternalMergedpeopleapiExternalId | External identifier associated with the person. | String | |
| aclEntry | A custom type of field ACL entry. The set of all ACL entries includes those listed in acl_entry as well as predefined_acl_entry. | AppsPeopleOzExternalMergedpeopleapiFieldAcl | The field ACL. Currently only populated on profile fields for the profile owner. A Person field ACL; see http://go/peopleapi-acl | list(AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntry) |
| authorizedViewers | Set of users that will be authorized to view the field by this field ACL. If the ACL is public, this will only contain ALL_USERS. This field is synthesized, read-only, and currently only used for profile photos. It’s populated under “person.photo.metadata.field_acl” for the current photo ACL and “person.photo.metadata.acl_choices” for available photo ACL choices. Note: The set of authorized viewers for a given FieldAcl may depend on the user’s account type and domain configuration. For example, a PRIVATE_READ FieldAcl could have any of the following authorized viewers: Consumer user: [IDENTITY_ACL_ESTABLISHED] Dasher user without domain contact sharing: [IDENTITY_ACL_ESTABLISHED] Unicorn user: [SAME_UNICORN_FAMILY] Hafez user: [] | AppsPeopleOzExternalMergedpeopleapiFieldAcl | The field ACL. Currently only populated on profile fields for the profile owner. A Person field ACL; see http://go/peopleapi-acl | list(String) |
| predefinedAclEntry | A common type of field ACL entry. A predefined ACL entry is a shortcut for a commonly occurring case of role and scope. For example, PUBLIC_READ is the same as an AclEntry with role = READER and scope.all_users = true. The set of all ACL entries includes those listed in acl_entry as well as predefined_acl_entry. | AppsPeopleOzExternalMergedpeopleapiFieldAcl | The field ACL. Currently only populated on profile fields for the profile owner. A Person field ACL; see http://go/peopleapi-acl | list(String) |
| role | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntry | String | ||
| scope | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntry | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScope | ||
| allUsers | Indicates that the field is accessible to all users including unauthenticated users. For some fields this means “to everyone except blocked users”. | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScope | boolean | |
| domainUsers | This is a “synthetic” field. In reality domains are treated as gaia- groups. This field will be ‘true’ when the field is ACLed to the gaia-group of the requester’s domain. | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScope | boolean | |
| membership | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScope | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopeMembershipAcl | ||
| person | Indicates that the field is accessible to a person. | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScope | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopePersonAcl | |
| circle | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopeMembershipAcl | Used when the field is accessible to a membership that the person has. | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopeMembershipAclCircleAcl | |
| contactGroup | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopeMembershipAcl | Used when the field is accessible to a membership that the person has. | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopeMembershipAclContactGroupAcl | |
| circleId | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopeMembershipAclCircleAcl | Used when a field is accessible to a circle. | String | |
| circleSet | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopeMembershipAclCircleAcl | Used when a field is accessible to a circle. | String | |
| displayName | Equivalent to Circle.display_name for the circle_id. Included when FieldAclOption.FULL_ACL_WITH_DETAILS is requested. This field is read-only and ignored on update. | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopeMembershipAclCircleAcl | Used when a field is accessible to a circle. | String |
| contactGroupId | A contact group ID. This is either a user-defined contact group hex ID, or it is the string name of the enum constant in Group.PredefinedId in FBS backend.proto for predefined groups. Common values for the predefined name include, but are not limited to: all, myContacts, starred, chatBuddies, friends, family, coworkers, and blocked. | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopeMembershipAclContactGroupAcl | Used when a field is accessible to a legacy contact group. Contact groups are discouraged and may be deprecated soon. ContactGroupAcls are read-only. If they are included as part of an ACL on an Update, an exception is thrown. | String |
| displayName | The localized display name for the predefined group, if known; or, the display name for the user-defined contact group. Included when FieldAclOption.FULL_ACL_WITH_DETAILS is requested. | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopeMembershipAclContactGroupAcl | Used when a field is accessible to a legacy contact group. Contact groups are discouraged and may be deprecated soon. ContactGroupAcls are read-only. If they are included as part of an ACL on an Update, an exception is thrown. | String |
| displayName | DEPRECATED. This is not different than reading from person.name for a self-read; ACLs to a circle or to a non-self person are no longer supported. Equivalent to Name.display_name for the person_id profile. Included when the profile Name is ACLed to the requester and FieldAclOption.FULL_ACL_WITH_DETAILS is requested. This field is read-only and ignored on update. | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopePersonAcl | Used when a field is accessible to a person. NOTE: ACLs to a circle or to a non-self person are no longer supported, so this can only be applied to the requester self. | String |
| personId | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopePersonAcl | Used when a field is accessible to a person. NOTE: ACLs to a circle or to a non-self person are no longer supported, so this can only be applied to the requester self. | String | |
| photoUrl | DEPRECATED. This is not different than reading from person.photo for a self-read; ACLs to a circle or to a non-self person are no longer supported. Equivalent to Photo.url for the person_id profile. Included when the profile Photo is ACLed to the requester and FieldAclOption.FULL_ACL_WITH_DETAILS is requested. This field is read-only and ignored on update. | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopePersonAcl | Used when a field is accessible to a person. NOTE: ACLs to a circle or to a non-self person are no longer supported, so this can only be applied to the requester self. | String |
| emergencyLevel | AppsPeopleOzExternalMergedpeopleapiFieldEmergencyInfo | Emergency information for Person field, such as Phone or Email. See go/emergency-trusted-contacts-papi. | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiFileAs | The FileAs field in Contacts is used to override the DisplayName of a Contact for that User. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| value | AppsPeopleOzExternalMergedpeopleapiFileAs | The FileAs field in Contacts is used to override the DisplayName of a Contact for that User. | String | |
| addressMeAs | Preferred pronoun choice. It’s unclear whether this value is constrained to a finite domain by UIs. `address_me_as` may be populated regardless of whether `type` is “male”, “female”, or “other”, although most writers only set it if `type` is “other”. | AppsPeopleOzExternalMergedpeopleapiGender | Gender in PeopleApi has some odd semantics about writing and reading that are not obvious from the proto definition. First, the `type` string, when read, always maps to the constrained domain of “male”, “female”, and “other”, aside from a pathological case that PeopleApi would like to fix. There are two typical patterns: 1. `type` is either “male” or “female” and `custom_type` and `address_me_as` are exactly as specified by an update to PeopleApi, although they are most often absent for “male” and “female” writes. 2. `type` is “other” and `custom_type` is set to a freeform string from the request. `address_me_as` is equal to whatever was provided at write time. When writing, the free-form string for `custom_type` can come from either `custom_type` if the field is present on the request, or if `custom_type` is absent, the string value of `type` will be copied into it. Any value in `type` will be coerced to “other” and the free-form value will be copied into `custom_type`, even if `type` is exactly “other”. Prefer to explicitly set `custom_type` and set type to “other” instead of setting type to a free-form value. There are weird edge cases when the value is “unknown”. Consider the behavior for `type` == “unknown” unspecified. Clients reading the gender should use the value from `formatted_type` if `type` is “male” or “female”. If `type` is “other”, `formatted_type` will be “Other” (or some translation) and clients should read `custom_type` for more specificity. | String |
| customType | A free-form string indicating what the user entered as their gender. `custom_type` may exist even if the type is “male” or “female”, although most writers do not set it unless `type` is “other”. | AppsPeopleOzExternalMergedpeopleapiGender | Gender in PeopleApi has some odd semantics about writing and reading that are not obvious from the proto definition. First, the `type` string, when read, always maps to the constrained domain of “male”, “female”, and “other”, aside from a pathological case that PeopleApi would like to fix. There are two typical patterns: 1. `type` is either “male” or “female” and `custom_type` and `address_me_as` are exactly as specified by an update to PeopleApi, although they are most often absent for “male” and “female” writes. 2. `type` is “other” and `custom_type` is set to a freeform string from the request. `address_me_as` is equal to whatever was provided at write time. When writing, the free-form string for `custom_type` can come from either `custom_type` if the field is present on the request, or if `custom_type` is absent, the string value of `type` will be copied into it. Any value in `type` will be coerced to “other” and the free-form value will be copied into `custom_type`, even if `type` is exactly “other”. Prefer to explicitly set `custom_type` and set type to “other” instead of setting type to a free-form value. There are weird edge cases when the value is “unknown”. Consider the behavior for `type` == “unknown” unspecified. Clients reading the gender should use the value from `formatted_type` if `type` is “male” or “female”. If `type` is “other”, `formatted_type` will be “Other” (or some translation) and clients should read `custom_type` for more specificity. | String |
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiGender | Gender in PeopleApi has some odd semantics about writing and reading that are not obvious from the proto definition. First, the `type` string, when read, always maps to the constrained domain of “male”, “female”, and “other”, aside from a pathological case that PeopleApi would like to fix. There are two typical patterns: 1. `type` is either “male” or “female” and `custom_type` and `address_me_as` are exactly as specified by an update to PeopleApi, although they are most often absent for “male” and “female” writes. 2. `type` is “other” and `custom_type` is set to a freeform string from the request. `address_me_as` is equal to whatever was provided at write time. When writing, the free-form string for `custom_type` can come from either `custom_type` if the field is present on the request, or if `custom_type` is absent, the string value of `type` will be copied into it. Any value in `type` will be coerced to “other” and the free-form value will be copied into `custom_type`, even if `type` is exactly “other”. Prefer to explicitly set `custom_type` and set type to “other” instead of setting type to a free-form value. There are weird edge cases when the value is “unknown”. Consider the behavior for `type` == “unknown” unspecified. Clients reading the gender should use the value from `formatted_type` if `type` is “male” or “female”. If `type` is “other”, `formatted_type` will be “Other” (or some translation) and clients should read `custom_type` for more specificity. | String |
| metadata | AppsPeopleOzExternalMergedpeopleapiGender | Gender in PeopleApi has some odd semantics about writing and reading that are not obvious from the proto definition. First, the `type` string, when read, always maps to the constrained domain of “male”, “female”, and “other”, aside from a pathological case that PeopleApi would like to fix. There are two typical patterns: 1. `type` is either “male” or “female” and `custom_type` and `address_me_as` are exactly as specified by an update to PeopleApi, although they are most often absent for “male” and “female” writes. 2. `type` is “other” and `custom_type` is set to a freeform string from the request. `address_me_as` is equal to whatever was provided at write time. When writing, the free-form string for `custom_type` can come from either `custom_type` if the field is present on the request, or if `custom_type` is absent, the string value of `type` will be copied into it. Any value in `type` will be coerced to “other” and the free-form value will be copied into `custom_type`, even if `type` is exactly “other”. Prefer to explicitly set `custom_type` and set type to “other” instead of setting type to a free-form value. There are weird edge cases when the value is “unknown”. Consider the behavior for `type` == “unknown” unspecified. Clients reading the gender should use the value from `formatted_type` if `type` is “male” or “female”. If `type` is “other”, `formatted_type` will be “Other” (or some translation) and clients should read `custom_type` for more specificity. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| type | The gender. “male”, “female”, or “other”. If “other”, typically, additional fields will have additional information. | AppsPeopleOzExternalMergedpeopleapiGender | Gender in PeopleApi has some odd semantics about writing and reading that are not obvious from the proto definition. First, the `type` string, when read, always maps to the constrained domain of “male”, “female”, and “other”, aside from a pathological case that PeopleApi would like to fix. There are two typical patterns: 1. `type` is either “male” or “female” and `custom_type` and `address_me_as` are exactly as specified by an update to PeopleApi, although they are most often absent for “male” and “female” writes. 2. `type` is “other” and `custom_type` is set to a freeform string from the request. `address_me_as` is equal to whatever was provided at write time. When writing, the free-form string for `custom_type` can come from either `custom_type` if the field is present on the request, or if `custom_type` is absent, the string value of `type` will be copied into it. Any value in `type` will be coerced to “other” and the free-form value will be copied into `custom_type`, even if `type` is exactly “other”. Prefer to explicitly set `custom_type` and set type to “other” instead of setting type to a free-form value. There are weird edge cases when the value is “unknown”. Consider the behavior for `type` == “unknown” unspecified. Clients reading the gender should use the value from `formatted_type` if `type` is “male” or “female”. If `type` is “other”, `formatted_type` will be “Other” (or some translation) and clients should read `custom_type` for more specificity. | String |
| failure | Failure type if there is an error when fetching product profile data. | AppsPeopleOzExternalMergedpeopleapiGPayExtendedData | Extension data for use in GPay Product Profile. go/gpay-product-profile-1-pager Contact: [email protected] | AppsPeopleOzExternalMergedpeopleapiProductProfileFailure |
| internationalNumber | A number in international format including the country code that is made user readable by including formatting such as spaces. Example: “+41 44 668 1800” DEPRECATED: A user’s phone number should be masked and not in an international format | AppsPeopleOzExternalMergedpeopleapiGPayExtendedData | Extension data for use in GPay Product Profile. go/gpay-product-profile-1-pager Contact: [email protected] | String |
| maskedNumber | The masked string of a user’s phone number The number will be obfucsated with * except the last 4 digits. Refer to: //java/com/google/nbu/paisa/common/PhoneNumberMasker.java | AppsPeopleOzExternalMergedpeopleapiGPayExtendedData | Extension data for use in GPay Product Profile. go/gpay-product-profile-1-pager Contact: [email protected] | String |
| contentRestriction | AppsPeopleOzExternalMergedpeopleapiGplusExtendedData | String | ||
| isEnterpriseUser | Equivalent to having the DASHER_POLICY bit in the REGISTERED state. | AppsPeopleOzExternalMergedpeopleapiGplusExtendedData | boolean | |
| hadPastHangoutState | AppsPeopleOzExternalMergedpeopleapiHangoutsExtendedData | Extension data for use in Hangouts. | String | |
| invitationStatus | Populated for all contacts. Only set if had_past_hangout_state == HAD_PAST_HANGOUT. INVITATION_NEEDED is not a valid value because there already is a past hangout, which means either the invitation is still pending or it’s been accepted. | AppsPeopleOzExternalMergedpeopleapiHangoutsExtendedData | Extension data for use in Hangouts. | String |
| isBot | True if this is a Hangouts bot. | AppsPeopleOzExternalMergedpeopleapiHangoutsExtendedData | Extension data for use in Hangouts. | boolean |
| isDismissed | AppsPeopleOzExternalMergedpeopleapiHangoutsExtendedData | Extension data for use in Hangouts. | boolean | |
| isFavorite | AppsPeopleOzExternalMergedpeopleapiHangoutsExtendedData | Extension data for use in Hangouts. | boolean | |
| isPinned | AppsPeopleOzExternalMergedpeopleapiHangoutsExtendedData | Extension data for use in Hangouts. | boolean | |
| userType | AppsPeopleOzExternalMergedpeopleapiHangoutsExtendedData | Extension data for use in Hangouts. | String | |
| originalLookupToken | Original lookup token from the request that resulted in this person or one of its containers. | AppsPeopleOzExternalMergedpeopleapiIdentityInfo | list(String) | |
| previousPersonId | Any former IDs this person may have had, in the case that their ID may have changed. Populated only for sync requests. Examples of such changes include adding an edge to a contact that links to a profile. The ID will change from being contact-oriented to being profile-oriented. To be used to clear out old versions of a person. | AppsPeopleOzExternalMergedpeopleapiIdentityInfo | list(String) | |
| sourceIds | A list of sources contributing to the merged person, including profiles (with gaia-id), contacts and synthetic-contacts. | AppsPeopleOzExternalMergedpeopleapiIdentityInfo | list(AppsPeopleOzExternalMergedpeopleapiSourceIdentity) | |
| formattedProtocol | The `protocol` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiIm | String | |
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiIm | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiIm | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| protocol | The protocol of the IM. The protocol can be free form or one of these predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting` | AppsPeopleOzExternalMergedpeopleapiIm | String | |
| type | The type of the IM. The type can be free form or one of these predefined values: * `home` * `work` * `other` | AppsPeopleOzExternalMergedpeopleapiIm | String | |
| value | AppsPeopleOzExternalMergedpeopleapiIm | String | ||
| app | AppsPeopleOzExternalMergedpeopleapiInAppNotificationTarget | How and where to send notifications to this person in other apps, and why the requester can do so. See go/reachability for more info. “How” and “where” identify the recipient in a P2P Bridge (glossary/p2p bridge), and “why” may be helpful in a UI to disambiguate which of several ways may be used to contact the recipient. How: Via a Google profile or a reachable-only phone number that the requester has access to. Specified in the target “type” and “value”. Where: Apps in which the profile/phone number owner may receive notifications. Specified in the repeated “app”. Why: Which fields in, e.g., a contact associated with this person make the notification target info visible to the requester. Specified in the repeated originating_field param. Example: Alice has a contact Bob, with: Email 0 = [email protected] Phone 0 = +12223334444 Phone 1 = +15556667777 Email 0 and Phone 0 let Alice see Bob’s public profile (obfuscated gaia ID = 123). Public profiles are visible by email by default, and Bob has explicitly made it visible via Phone 0. Bob says people can send notifications to his public profile in YouTube. Phone 2 is associated with another Google profile that Bob owns, but he doesn’t want others to see it. He is okay with people sending notifications to him in Who’s Down if they have this phone number, however. There will be separate InAppNotificationTargets: one for Bob’s public Google profile, and one for the second phone number, which is in his private profile. IANT #1 – targeting Bob’s public profile (visible via Email 0 and Phone 0): app = [YOUTUBE] type = OBFUSCATED_GAIA_ID value = 123 originating_field: [ { field_type = EMAIL, field_index = 0 } // For Email 0 { field_type = PHONE, field_index = 0 } // For Phone 0 ] IANT #2 – targeting Bob’s private profile phone number Phone 1: app = [WHOS_DOWN] type = PHONE value = +15556667777 originating_field: [ { field_type = PHONE, field_index = 1 } // For Phone 1 ] | list(String) | |
| clientData | AppsPeopleOzExternalMergedpeopleapiInAppNotificationTarget | How and where to send notifications to this person in other apps, and why the requester can do so. See go/reachability for more info. “How” and “where” identify the recipient in a P2P Bridge (glossary/p2p bridge), and “why” may be helpful in a UI to disambiguate which of several ways may be used to contact the recipient. How: Via a Google profile or a reachable-only phone number that the requester has access to. Specified in the target “type” and “value”. Where: Apps in which the profile/phone number owner may receive notifications. Specified in the repeated “app”. Why: Which fields in, e.g., a contact associated with this person make the notification target info visible to the requester. Specified in the repeated originating_field param. Example: Alice has a contact Bob, with: Email 0 = [email protected] Phone 0 = +12223334444 Phone 1 = +15556667777 Email 0 and Phone 0 let Alice see Bob’s public profile (obfuscated gaia ID = 123). Public profiles are visible by email by default, and Bob has explicitly made it visible via Phone 0. Bob says people can send notifications to his public profile in YouTube. Phone 2 is associated with another Google profile that Bob owns, but he doesn’t want others to see it. He is okay with people sending notifications to him in Who’s Down if they have this phone number, however. There will be separate InAppNotificationTargets: one for Bob’s public Google profile, and one for the second phone number, which is in his private profile. IANT #1 – targeting Bob’s public profile (visible via Email 0 and Phone 0): app = [YOUTUBE] type = OBFUSCATED_GAIA_ID value = 123 originating_field: [ { field_type = EMAIL, field_index = 0 } // For Email 0 { field_type = PHONE, field_index = 0 } // For Phone 0 ] IANT #2 – targeting Bob’s private profile phone number Phone 1: app = [WHOS_DOWN] type = PHONE value = +15556667777 originating_field: [ { field_type = PHONE, field_index = 1 } // For Phone 1 ] | list(AppsPeopleOzExternalMergedpeopleapiInAppNotificationTargetClientData) | |
| metadata | AppsPeopleOzExternalMergedpeopleapiInAppNotificationTarget | How and where to send notifications to this person in other apps, and why the requester can do so. See go/reachability for more info. “How” and “where” identify the recipient in a P2P Bridge (glossary/p2p bridge), and “why” may be helpful in a UI to disambiguate which of several ways may be used to contact the recipient. How: Via a Google profile or a reachable-only phone number that the requester has access to. Specified in the target “type” and “value”. Where: Apps in which the profile/phone number owner may receive notifications. Specified in the repeated “app”. Why: Which fields in, e.g., a contact associated with this person make the notification target info visible to the requester. Specified in the repeated originating_field param. Example: Alice has a contact Bob, with: Email 0 = [email protected] Phone 0 = +12223334444 Phone 1 = +15556667777 Email 0 and Phone 0 let Alice see Bob’s public profile (obfuscated gaia ID = 123). Public profiles are visible by email by default, and Bob has explicitly made it visible via Phone 0. Bob says people can send notifications to his public profile in YouTube. Phone 2 is associated with another Google profile that Bob owns, but he doesn’t want others to see it. He is okay with people sending notifications to him in Who’s Down if they have this phone number, however. There will be separate InAppNotificationTargets: one for Bob’s public Google profile, and one for the second phone number, which is in his private profile. IANT #1 – targeting Bob’s public profile (visible via Email 0 and Phone 0): app = [YOUTUBE] type = OBFUSCATED_GAIA_ID value = 123 originating_field: [ { field_type = EMAIL, field_index = 0 } // For Email 0 { field_type = PHONE, field_index = 0 } // For Phone 0 ] IANT #2 – targeting Bob’s private profile phone number Phone 1: app = [WHOS_DOWN] type = PHONE value = +15556667777 originating_field: [ { field_type = PHONE, field_index = 1 } // For Phone 1 ] | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| originatingField | There may be more than one field from which this IANT originates, as in the case of Bob’s public profile. | AppsPeopleOzExternalMergedpeopleapiInAppNotificationTarget | How and where to send notifications to this person in other apps, and why the requester can do so. See go/reachability for more info. “How” and “where” identify the recipient in a P2P Bridge (glossary/p2p bridge), and “why” may be helpful in a UI to disambiguate which of several ways may be used to contact the recipient. How: Via a Google profile or a reachable-only phone number that the requester has access to. Specified in the target “type” and “value”. Where: Apps in which the profile/phone number owner may receive notifications. Specified in the repeated “app”. Why: Which fields in, e.g., a contact associated with this person make the notification target info visible to the requester. Specified in the repeated originating_field param. Example: Alice has a contact Bob, with: Email 0 = [email protected] Phone 0 = +12223334444 Phone 1 = +15556667777 Email 0 and Phone 0 let Alice see Bob’s public profile (obfuscated gaia ID = 123). Public profiles are visible by email by default, and Bob has explicitly made it visible via Phone 0. Bob says people can send notifications to his public profile in YouTube. Phone 2 is associated with another Google profile that Bob owns, but he doesn’t want others to see it. He is okay with people sending notifications to him in Who’s Down if they have this phone number, however. There will be separate InAppNotificationTargets: one for Bob’s public Google profile, and one for the second phone number, which is in his private profile. IANT #1 – targeting Bob’s public profile (visible via Email 0 and Phone 0): app = [YOUTUBE] type = OBFUSCATED_GAIA_ID value = 123 originating_field: [ { field_type = EMAIL, field_index = 0 } // For Email 0 { field_type = PHONE, field_index = 0 } // For Phone 0 ] IANT #2 – targeting Bob’s private profile phone number Phone 1: app = [WHOS_DOWN] type = PHONE value = +15556667777 originating_field: [ { field_type = PHONE, field_index = 1 } // For Phone 1 ] | list(AppsPeopleOzExternalMergedpeopleapiInAppNotificationTargetOriginatingField) |
| type | AppsPeopleOzExternalMergedpeopleapiInAppNotificationTarget | How and where to send notifications to this person in other apps, and why the requester can do so. See go/reachability for more info. “How” and “where” identify the recipient in a P2P Bridge (glossary/p2p bridge), and “why” may be helpful in a UI to disambiguate which of several ways may be used to contact the recipient. How: Via a Google profile or a reachable-only phone number that the requester has access to. Specified in the target “type” and “value”. Where: Apps in which the profile/phone number owner may receive notifications. Specified in the repeated “app”. Why: Which fields in, e.g., a contact associated with this person make the notification target info visible to the requester. Specified in the repeated originating_field param. Example: Alice has a contact Bob, with: Email 0 = [email protected] Phone 0 = +12223334444 Phone 1 = +15556667777 Email 0 and Phone 0 let Alice see Bob’s public profile (obfuscated gaia ID = 123). Public profiles are visible by email by default, and Bob has explicitly made it visible via Phone 0. Bob says people can send notifications to his public profile in YouTube. Phone 2 is associated with another Google profile that Bob owns, but he doesn’t want others to see it. He is okay with people sending notifications to him in Who’s Down if they have this phone number, however. There will be separate InAppNotificationTargets: one for Bob’s public Google profile, and one for the second phone number, which is in his private profile. IANT #1 – targeting Bob’s public profile (visible via Email 0 and Phone 0): app = [YOUTUBE] type = OBFUSCATED_GAIA_ID value = 123 originating_field: [ { field_type = EMAIL, field_index = 0 } // For Email 0 { field_type = PHONE, field_index = 0 } // For Phone 0 ] IANT #2 – targeting Bob’s private profile phone number Phone 1: app = [WHOS_DOWN] type = PHONE value = +15556667777 originating_field: [ { field_type = PHONE, field_index = 1 } // For Phone 1 ] | String | |
| value | The value of the target, used for delivery. E.g., the obfuscated gaia ID for a visible profile. | AppsPeopleOzExternalMergedpeopleapiInAppNotificationTarget | How and where to send notifications to this person in other apps, and why the requester can do so. See go/reachability for more info. “How” and “where” identify the recipient in a P2P Bridge (glossary/p2p bridge), and “why” may be helpful in a UI to disambiguate which of several ways may be used to contact the recipient. How: Via a Google profile or a reachable-only phone number that the requester has access to. Specified in the target “type” and “value”. Where: Apps in which the profile/phone number owner may receive notifications. Specified in the repeated “app”. Why: Which fields in, e.g., a contact associated with this person make the notification target info visible to the requester. Specified in the repeated originating_field param. Example: Alice has a contact Bob, with: Email 0 = [email protected] Phone 0 = +12223334444 Phone 1 = +15556667777 Email 0 and Phone 0 let Alice see Bob’s public profile (obfuscated gaia ID = 123). Public profiles are visible by email by default, and Bob has explicitly made it visible via Phone 0. Bob says people can send notifications to his public profile in YouTube. Phone 2 is associated with another Google profile that Bob owns, but he doesn’t want others to see it. He is okay with people sending notifications to him in Who’s Down if they have this phone number, however. There will be separate InAppNotificationTargets: one for Bob’s public Google profile, and one for the second phone number, which is in his private profile. IANT #1 – targeting Bob’s public profile (visible via Email 0 and Phone 0): app = [YOUTUBE] type = OBFUSCATED_GAIA_ID value = 123 originating_field: [ { field_type = EMAIL, field_index = 0 } // For Email 0 { field_type = PHONE, field_index = 0 } // For Phone 0 ] IANT #2 – targeting Bob’s private profile phone number Phone 1: app = [WHOS_DOWN] type = PHONE value = +15556667777 originating_field: [ { field_type = PHONE, field_index = 1 } // For Phone 1 ] | String |
| app | The app to which this client data applies. | AppsPeopleOzExternalMergedpeopleapiInAppNotificationTargetClientData | Client-specific data pertaining to app reachability. No PII data or user content should be stored in this blob. | String |
| byteValue | AppsPeopleOzExternalMergedpeopleapiInAppNotificationTargetClientData | Client-specific data pertaining to app reachability. No PII data or user content should be stored in this blob. | String | |
| fieldIndex | The index of the relevant field in the merged person | AppsPeopleOzExternalMergedpeopleapiInAppNotificationTargetOriginatingField | Info for identifying the specific field in this person that lets the requester send them notifications. These are typically fields added to a contact (e.g., email). There will not always be in originating field, typically in the case that whatever permits the requester to see this target info is not something that can be used on its own for contacting this person. | integer |
| fieldType | AppsPeopleOzExternalMergedpeopleapiInAppNotificationTargetOriginatingField | Info for identifying the specific field in this person that lets the requester send them notifications. These are typically fields added to a contact (e.g., email). There will not always be in originating field, typically in the case that whatever permits the requester to see this target info is not something that can be used on its own for contacting this person. | String | |
| value | The value of the origin field | AppsPeopleOzExternalMergedpeopleapiInAppNotificationTargetOriginatingField | Info for identifying the specific field in this person that lets the requester send them notifications. These are typically fields added to a contact (e.g., email). There will not always be in originating field, typically in the case that whatever permits the requester to see this target info is not something that can be used on its own for contacting this person. | String |
| appType | AppsPeopleOzExternalMergedpeopleapiInAppReachability | This is deprecated in PEOPLE_API/SHARPEN, and should only be used for PROFILES. Clients should use InAppNotificationTarget field instead. Which apps the person has indicated they are reachable at for the requester. See go/d13y and com.google.focus.proto.InAppReachability. | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiInAppReachability | This is deprecated in PEOPLE_API/SHARPEN, and should only be used for PROFILES. Clients should use InAppNotificationTarget field instead. Which apps the person has indicated they are reachable at for the requester. See go/d13y and com.google.focus.proto.InAppReachability. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| reachabilityKey | AppsPeopleOzExternalMergedpeopleapiInAppReachability | This is deprecated in PEOPLE_API/SHARPEN, and should only be used for PROFILES. Clients should use InAppNotificationTarget field instead. Which apps the person has indicated they are reachable at for the requester. See go/d13y and com.google.focus.proto.InAppReachability. | AppsPeopleOzExternalMergedpeopleapiInAppReachabilityReachabilityKey | |
| status | AppsPeopleOzExternalMergedpeopleapiInAppReachability | This is deprecated in PEOPLE_API/SHARPEN, and should only be used for PROFILES. Clients should use InAppNotificationTarget field instead. Which apps the person has indicated they are reachable at for the requester. See go/d13y and com.google.focus.proto.InAppReachability. | String | |
| keyType | AppsPeopleOzExternalMergedpeopleapiInAppReachabilityReachabilityKey | Information pertaining to how this reachable state was established. | String | |
| keyValue | The value of the key by which the user said they may be reachable. E.g., the phone number. | AppsPeopleOzExternalMergedpeopleapiInAppReachabilityReachabilityKey | Information pertaining to how this reachable state was established. | String |
| allowed | AppsPeopleOzExternalMergedpeopleapiInteractionSettings | Defines interactions that are allowed or disallowed with this person. | boolean | |
| interaction | AppsPeopleOzExternalMergedpeopleapiInteractionSettings | Defines interactions that are allowed or disallowed with this person. | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiInteractionSettings | Defines interactions that are allowed or disallowed with this person. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| metadata | AppsPeopleOzExternalMergedpeopleapiInterest | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| value | AppsPeopleOzExternalMergedpeopleapiInterest | String | ||
| metadata | AppsPeopleOzExternalMergedpeopleapiLanguage | The value can either by a language code conforming to the IETF BCP 47 specification or a custom freeform value. By default the returned value is proxied from FBS Profile.Language. If `include_account_locale` is set on the `MergePersonSourceOptions` the language from go/uls is preferred and returned as primary along with a secondary language from FBS. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| value | AppsPeopleOzExternalMergedpeopleapiLanguage | The value can either by a language code conforming to the IETF BCP 47 specification or a custom freeform value. By default the returned value is proxied from FBS Profile.Language. If `include_account_locale` is set on the `MergePersonSourceOptions` the language from go/uls is preferred and returned as primary along with a secondary language from FBS. | String | |
| lat | AppsPeopleOzExternalMergedpeopleapiLatLng | float | ||
| lng | AppsPeopleOzExternalMergedpeopleapiLatLng | float | ||
| mobileOwnerId | Mobile obfuscated gaia id. This is the same gaia id in metadata.owner_id, but obfuscated with the legacy mobile obfuscator. | AppsPeopleOzExternalMergedpeopleapiLegacyFields | Fields used in legacy applications. Useful for joining legacy and new data streams. Most applications should not care about these fields. | String |
| limitedProfileSettings | AppsPeopleOzExternalMergedpeopleapiLimitedProfileSettingsField | SocialGraphApiProtoLimitedProfileSettings | ||
| metadata | AppsPeopleOzExternalMergedpeopleapiLimitedProfileSettingsField | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| buildingId | AppsPeopleOzExternalMergedpeopleapiLocation | String | ||
| buildingName | The building_name field is only filled if the DESK_LOCATION_ADDITIONAL_DATA extension is active. | AppsPeopleOzExternalMergedpeopleapiLocation | String | |
| current | AppsPeopleOzExternalMergedpeopleapiLocation | boolean | ||
| deskCode | Most specific textual description of individual desk location. | AppsPeopleOzExternalMergedpeopleapiLocation | String | |
| floorName | AppsPeopleOzExternalMergedpeopleapiLocation | String | ||
| floorSection | AppsPeopleOzExternalMergedpeopleapiLocation | String | ||
| lastUpdateTime | Indicates the time this location was added or last edited. | AppsPeopleOzExternalMergedpeopleapiLocation | DateTime | |
| metadata | AppsPeopleOzExternalMergedpeopleapiLocation | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| source | Value indicates the origin of this location information. | AppsPeopleOzExternalMergedpeopleapiLocation | String | |
| type | Describes the type of location. E.g. Grew_up, Desk. Corresponds to FBS backend.proto Location.StandardTag | AppsPeopleOzExternalMergedpeopleapiLocation | String | |
| value | AppsPeopleOzExternalMergedpeopleapiLocation | String | ||
| indirectManager | List of managers in the chain. If user has manager email “[email protected]” and manager’s manager has email “[email protected]” then the list will be: [0]: { email: “[email protected]” } [1]: { email: “[email protected]” } | AppsPeopleOzExternalMergedpeopleapiManagementUpchain | list(AppsPeopleOzExternalMergedpeopleapiManagementUpchainIndirectManager) | |
| metadata | AppsPeopleOzExternalMergedpeopleapiManagementUpchain | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| status | AppsPeopleOzExternalMergedpeopleapiManagementUpchain | String | ||
| AppsPeopleOzExternalMergedpeopleapiManagementUpchainIndirectManager | String | |||
| personId | AppsPeopleOzExternalMergedpeopleapiManagementUpchainIndirectManager | String | ||
| failure | Failure type if there is an error when fetching product profile data. | AppsPeopleOzExternalMergedpeopleapiMapsExtendedData | Extension data for use in Maps Product Profile. | AppsPeopleOzExternalMergedpeopleapiProductProfileFailure |
| followeeCount | Number of people the user is following. | AppsPeopleOzExternalMergedpeopleapiMapsExtendedData | Extension data for use in Maps Product Profile. | String |
| followerCount | Number of people who are following the user. | AppsPeopleOzExternalMergedpeopleapiMapsExtendedData | Extension data for use in Maps Product Profile. | integer |
| numContributions | Sum of creators contributions i.e. reviews, rating, questions, etc. | AppsPeopleOzExternalMergedpeopleapiMapsExtendedData | Extension data for use in Maps Product Profile. | String |
| profilePhotoUrl | The user’s profile photo that might have a badge rendered at the corner if the user is eligible for a badge. | AppsPeopleOzExternalMergedpeopleapiMapsExtendedData | Extension data for use in Maps Product Profile. | String |
| tagline | A user’s bio, or tagline. | AppsPeopleOzExternalMergedpeopleapiMapsExtendedData | Extension data for use in Maps Product Profile. | String |
| topicExpertise | A topic that creator has expertise in. This will be in the format: emoji associated with the topic, display name of the topic, topic score | AppsPeopleOzExternalMergedpeopleapiMapsExtendedData | Extension data for use in Maps Product Profile. | list(String) |
| userCaption | A user’s caption displayed under the user name on their profile page i.e. ‘Local Guide Level 8’ | AppsPeopleOzExternalMergedpeopleapiMapsExtendedData | Extension data for use in Maps Product Profile. | String |
| fieldRestriction | AppsPeopleOzExternalMergedpeopleapiMapsProfile | Maps Profile Data. See go/product-profiles-backend-api. | list(AppsPeopleOzExternalMergedpeopleapiMapsProfileFieldRestriction) | |
| metadata | AppsPeopleOzExternalMergedpeopleapiMapsProfile | Maps Profile Data. See go/product-profiles-backend-api. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| tagline | AppsPeopleOzExternalMergedpeopleapiMapsProfile | Maps Profile Data. See go/product-profiles-backend-api. | String | |
| websiteLink | A link to the profile owner’s website to be displayed in profile. | AppsPeopleOzExternalMergedpeopleapiMapsProfile | Maps Profile Data. See go/product-profiles-backend-api. | AppsPeopleOzExternalMergedpeopleapiMapsProfileUrlLink |
| clientData | Opaque data associated with this restriction e.g. abuse status. | AppsPeopleOzExternalMergedpeopleapiMapsProfileFieldRestriction | String | |
| type | AppsPeopleOzExternalMergedpeopleapiMapsProfileFieldRestriction | String | ||
| anchorText | Anchor text to be displayed as clickable link. If not present, the URL should be displayed directly. | AppsPeopleOzExternalMergedpeopleapiMapsProfileUrlLink | String | |
| url | The URL to be linked to. | AppsPeopleOzExternalMergedpeopleapiMapsProfileUrlLink | String | |
| match | The list of matches ordered by most relevant matching for autocomplete coming first. | AppsPeopleOzExternalMergedpeopleapiMatchInfo | Represents the matching information for a field when there is a query. | list(AppsPeopleOzExternalMergedpeopleapiMatchInfoLookupTokenMatch) |
| query | The query token we are matching against. | AppsPeopleOzExternalMergedpeopleapiMatchInfo | Represents the matching information for a field when there is a query. | String |
| endIndex | Index right after the last character that matches the query. length = end-start, we have substring = [start, end). | AppsPeopleOzExternalMergedpeopleapiMatchInfoLookupTokenMatch | All the substring that were matched for the given query against the current field. Represents a substring of another string. | integer |
| startIndex | Index of the first unicode character that matches the query. | AppsPeopleOzExternalMergedpeopleapiMatchInfoLookupTokenMatch | All the substring that were matched for the given query against the current field. Represents a substring of another string. | integer |
| circleId | A circle that the person belongs to. | AppsPeopleOzExternalMergedpeopleapiMembership | A membership that the person has. The person can be a member of multiple circles and multiple contact-groups. A circle membership is created by adding a person to a circle by person-id or by email. A contact-group membership is created by adding a contact to a contact-group. | String |
| contactGroupId | A contact-group that the person belong to. The id can be either a hex-formatted id or a camel-cased SystemContactGroup predefined group name. The id will be predefined group name iff the system_contact_group_id has a value. | AppsPeopleOzExternalMergedpeopleapiMembership | A membership that the person has. The person can be a member of multiple circles and multiple contact-groups. A circle membership is created by adding a person to a circle by person-id or by email. A contact-group membership is created by adding a contact to a contact-group. | String |
| metadata | The metadata field can be used to determine which container generated the membership. For example, when the membership has a contact_group_id, the metadata.container will be CONTACT and the container_id will be the contact Id. | AppsPeopleOzExternalMergedpeopleapiMembership | A membership that the person has. The person can be a member of multiple circles and multiple contact-groups. A circle membership is created by adding a person to a circle by person-id or by email. A contact-group membership is created by adding a contact to a contact-group. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata |
| systemContactGroupId | The membership has a contact_group_id, this field will be populated when the membership is in a system-reserved contact-group. | AppsPeopleOzExternalMergedpeopleapiMembership | A membership that the person has. The person can be a member of multiple circles and multiple contact-groups. A circle membership is created by adding a person to a circle by person-id or by email. A contact-group membership is created by adding a contact to a contact-group. | String |
| metadata | AppsPeopleOzExternalMergedpeopleapiMission | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| value | AppsPeopleOzExternalMergedpeopleapiMission | String | ||
| displayName | Read-only. A name synthesized based on `unstructured_name` and the structured name fields. Example: “John Smith” If a language code is passed in the side channel using http://cs/symbol:framework.rpc.DeprecatedPropagatedLanguageCode.value or http://cs/symbol:google.rpc.context.OriginContext.accept_language and the name does not have `honorific_prefix`, `middle_name`, or `honorific_suffix` set, the language code will be used to format `display_name`. If `include_account_locale` is set on the `MergePersonSourceOptions` and a language code is not passed in the side channel. The language code from go/uls will be used as the language code for formatting `display_name`. | AppsPeopleOzExternalMergedpeopleapiName | See go/people-api-howto:names for an overview of name usage in PeopleAPI. The `unstructured_name` field contains a free form name value. The `given_name`, `middle_name`, `family_name`, etc, fields contain the structured name. For CONTACT mutates, (i.e. when Name.metadata.container is CONTACT), it is recommended for clients to set either the `unstructured_name` or the set of structured name fields, not both. * When only the `unstructured_name` is set, it is parsed to produce a best-guess set of structured name values for the `given_name`, `family_name`, etc. * When only the structured name fields are set, the various values are combined to produce an `unstructured_name`. * When both are set, the `unstructured_name` is saved as-is and the structured name fields are saved as-is. This may be confusing as they might not “match”. For PROFILE mutates, (i.e. when Name.metadata.container is PROFILE), it is _required_ for clients to use the structured name fields as the unstructured field value is ignored on write. The unstructured name fields are generated for convenience on read. For DEVICE_CONTACTS, see b/156020778. | String |
| displayNameLastFirst | Read-only. A name synthesized based on `unstructured_name` and the structured name fields with the last name first. Example: “Smith, John” | AppsPeopleOzExternalMergedpeopleapiName | See go/people-api-howto:names for an overview of name usage in PeopleAPI. The `unstructured_name` field contains a free form name value. The `given_name`, `middle_name`, `family_name`, etc, fields contain the structured name. For CONTACT mutates, (i.e. when Name.metadata.container is CONTACT), it is recommended for clients to set either the `unstructured_name` or the set of structured name fields, not both. * When only the `unstructured_name` is set, it is parsed to produce a best-guess set of structured name values for the `given_name`, `family_name`, etc. * When only the structured name fields are set, the various values are combined to produce an `unstructured_name`. * When both are set, the `unstructured_name` is saved as-is and the structured name fields are saved as-is. This may be confusing as they might not “match”. For PROFILE mutates, (i.e. when Name.metadata.container is PROFILE), it is _required_ for clients to use the structured name fields as the unstructured field value is ignored on write. The unstructured name fields are generated for convenience on read. For DEVICE_CONTACTS, see b/156020778. | String |
| displayNameSource | Read-only. The source of the display name. | AppsPeopleOzExternalMergedpeopleapiName | See go/people-api-howto:names for an overview of name usage in PeopleAPI. The `unstructured_name` field contains a free form name value. The `given_name`, `middle_name`, `family_name`, etc, fields contain the structured name. For CONTACT mutates, (i.e. when Name.metadata.container is CONTACT), it is recommended for clients to set either the `unstructured_name` or the set of structured name fields, not both. * When only the `unstructured_name` is set, it is parsed to produce a best-guess set of structured name values for the `given_name`, `family_name`, etc. * When only the structured name fields are set, the various values are combined to produce an `unstructured_name`. * When both are set, the `unstructured_name` is saved as-is and the structured name fields are saved as-is. This may be confusing as they might not “match”. For PROFILE mutates, (i.e. when Name.metadata.container is PROFILE), it is _required_ for clients to use the structured name fields as the unstructured field value is ignored on write. The unstructured name fields are generated for convenience on read. For DEVICE_CONTACTS, see b/156020778. | SocialGraphApiProtoDisplayNameSource |
| familyName | AppsPeopleOzExternalMergedpeopleapiName | See go/people-api-howto:names for an overview of name usage in PeopleAPI. The `unstructured_name` field contains a free form name value. The `given_name`, `middle_name`, `family_name`, etc, fields contain the structured name. For CONTACT mutates, (i.e. when Name.metadata.container is CONTACT), it is recommended for clients to set either the `unstructured_name` or the set of structured name fields, not both. * When only the `unstructured_name` is set, it is parsed to produce a best-guess set of structured name values for the `given_name`, `family_name`, etc. * When only the structured name fields are set, the various values are combined to produce an `unstructured_name`. * When both are set, the `unstructured_name` is saved as-is and the structured name fields are saved as-is. This may be confusing as they might not “match”. For PROFILE mutates, (i.e. when Name.metadata.container is PROFILE), it is _required_ for clients to use the structured name fields as the unstructured field value is ignored on write. The unstructured name fields are generated for convenience on read. For DEVICE_CONTACTS, see b/156020778. | String | |
| formattedName | DEPRECATED(b/70571931). Use `unstructured_name` instead. | AppsPeopleOzExternalMergedpeopleapiName | See go/people-api-howto:names for an overview of name usage in PeopleAPI. The `unstructured_name` field contains a free form name value. The `given_name`, `middle_name`, `family_name`, etc, fields contain the structured name. For CONTACT mutates, (i.e. when Name.metadata.container is CONTACT), it is recommended for clients to set either the `unstructured_name` or the set of structured name fields, not both. * When only the `unstructured_name` is set, it is parsed to produce a best-guess set of structured name values for the `given_name`, `family_name`, etc. * When only the structured name fields are set, the various values are combined to produce an `unstructured_name`. * When both are set, the `unstructured_name` is saved as-is and the structured name fields are saved as-is. This may be confusing as they might not “match”. For PROFILE mutates, (i.e. when Name.metadata.container is PROFILE), it is _required_ for clients to use the structured name fields as the unstructured field value is ignored on write. The unstructured name fields are generated for convenience on read. For DEVICE_CONTACTS, see b/156020778. | String |
| givenName | AppsPeopleOzExternalMergedpeopleapiName | See go/people-api-howto:names for an overview of name usage in PeopleAPI. The `unstructured_name` field contains a free form name value. The `given_name`, `middle_name`, `family_name`, etc, fields contain the structured name. For CONTACT mutates, (i.e. when Name.metadata.container is CONTACT), it is recommended for clients to set either the `unstructured_name` or the set of structured name fields, not both. * When only the `unstructured_name` is set, it is parsed to produce a best-guess set of structured name values for the `given_name`, `family_name`, etc. * When only the structured name fields are set, the various values are combined to produce an `unstructured_name`. * When both are set, the `unstructured_name` is saved as-is and the structured name fields are saved as-is. This may be confusing as they might not “match”. For PROFILE mutates, (i.e. when Name.metadata.container is PROFILE), it is _required_ for clients to use the structured name fields as the unstructured field value is ignored on write. The unstructured name fields are generated for convenience on read. For DEVICE_CONTACTS, see b/156020778. | String | |
| honorificPrefix | AppsPeopleOzExternalMergedpeopleapiName | See go/people-api-howto:names for an overview of name usage in PeopleAPI. The `unstructured_name` field contains a free form name value. The `given_name`, `middle_name`, `family_name`, etc, fields contain the structured name. For CONTACT mutates, (i.e. when Name.metadata.container is CONTACT), it is recommended for clients to set either the `unstructured_name` or the set of structured name fields, not both. * When only the `unstructured_name` is set, it is parsed to produce a best-guess set of structured name values for the `given_name`, `family_name`, etc. * When only the structured name fields are set, the various values are combined to produce an `unstructured_name`. * When both are set, the `unstructured_name` is saved as-is and the structured name fields are saved as-is. This may be confusing as they might not “match”. For PROFILE mutates, (i.e. when Name.metadata.container is PROFILE), it is _required_ for clients to use the structured name fields as the unstructured field value is ignored on write. The unstructured name fields are generated for convenience on read. For DEVICE_CONTACTS, see b/156020778. | String | |
| honorificSuffix | AppsPeopleOzExternalMergedpeopleapiName | See go/people-api-howto:names for an overview of name usage in PeopleAPI. The `unstructured_name` field contains a free form name value. The `given_name`, `middle_name`, `family_name`, etc, fields contain the structured name. For CONTACT mutates, (i.e. when Name.metadata.container is CONTACT), it is recommended for clients to set either the `unstructured_name` or the set of structured name fields, not both. * When only the `unstructured_name` is set, it is parsed to produce a best-guess set of structured name values for the `given_name`, `family_name`, etc. * When only the structured name fields are set, the various values are combined to produce an `unstructured_name`. * When both are set, the `unstructured_name` is saved as-is and the structured name fields are saved as-is. This may be confusing as they might not “match”. For PROFILE mutates, (i.e. when Name.metadata.container is PROFILE), it is _required_ for clients to use the structured name fields as the unstructured field value is ignored on write. The unstructured name fields are generated for convenience on read. For DEVICE_CONTACTS, see b/156020778. | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiName | See go/people-api-howto:names for an overview of name usage in PeopleAPI. The `unstructured_name` field contains a free form name value. The `given_name`, `middle_name`, `family_name`, etc, fields contain the structured name. For CONTACT mutates, (i.e. when Name.metadata.container is CONTACT), it is recommended for clients to set either the `unstructured_name` or the set of structured name fields, not both. * When only the `unstructured_name` is set, it is parsed to produce a best-guess set of structured name values for the `given_name`, `family_name`, etc. * When only the structured name fields are set, the various values are combined to produce an `unstructured_name`. * When both are set, the `unstructured_name` is saved as-is and the structured name fields are saved as-is. This may be confusing as they might not “match”. For PROFILE mutates, (i.e. when Name.metadata.container is PROFILE), it is _required_ for clients to use the structured name fields as the unstructured field value is ignored on write. The unstructured name fields are generated for convenience on read. For DEVICE_CONTACTS, see b/156020778. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| middleName | AppsPeopleOzExternalMergedpeopleapiName | See go/people-api-howto:names for an overview of name usage in PeopleAPI. The `unstructured_name` field contains a free form name value. The `given_name`, `middle_name`, `family_name`, etc, fields contain the structured name. For CONTACT mutates, (i.e. when Name.metadata.container is CONTACT), it is recommended for clients to set either the `unstructured_name` or the set of structured name fields, not both. * When only the `unstructured_name` is set, it is parsed to produce a best-guess set of structured name values for the `given_name`, `family_name`, etc. * When only the structured name fields are set, the various values are combined to produce an `unstructured_name`. * When both are set, the `unstructured_name` is saved as-is and the structured name fields are saved as-is. This may be confusing as they might not “match”. For PROFILE mutates, (i.e. when Name.metadata.container is PROFILE), it is _required_ for clients to use the structured name fields as the unstructured field value is ignored on write. The unstructured name fields are generated for convenience on read. For DEVICE_CONTACTS, see b/156020778. | String | |
| pronunciations | This field is stored in contact annotations and merged at read-time. It is available with CONTACT_ANNOTATION container type at read time. | AppsPeopleOzExternalMergedpeopleapiName | See go/people-api-howto:names for an overview of name usage in PeopleAPI. The `unstructured_name` field contains a free form name value. The `given_name`, `middle_name`, `family_name`, etc, fields contain the structured name. For CONTACT mutates, (i.e. when Name.metadata.container is CONTACT), it is recommended for clients to set either the `unstructured_name` or the set of structured name fields, not both. * When only the `unstructured_name` is set, it is parsed to produce a best-guess set of structured name values for the `given_name`, `family_name`, etc. * When only the structured name fields are set, the various values are combined to produce an `unstructured_name`. * When both are set, the `unstructured_name` is saved as-is and the structured name fields are saved as-is. This may be confusing as they might not “match”. For PROFILE mutates, (i.e. when Name.metadata.container is PROFILE), it is _required_ for clients to use the structured name fields as the unstructured field value is ignored on write. The unstructured name fields are generated for convenience on read. For DEVICE_CONTACTS, see b/156020778. | SocialGraphApiProtoPronunciations |
| shortDisplayName | NOTE: this is currently NOT IMPLEMENTED due to changed priorities. Clients usually rely on “first name” instead, when a short name is needed. Read-only. A possibly shorter version of the user’s name. – The purpose of this field is to address the needs of UIs where a full display name might be too large to fit. Instead of relying on `first_name`, which might not be present, `short_display_name` is preferred. – This is only available for PROFILE and DOMAIN_PROFILE container types. – About the actual content in this field: will be the first name when it’s visible to the requester, or the same as `display_name`, otherwise. A sample scenario where the first name may not be visible is when the limited profile is returned. For more info, see: http://shortn/_9iV7TJ33la | AppsPeopleOzExternalMergedpeopleapiName | See go/people-api-howto:names for an overview of name usage in PeopleAPI. The `unstructured_name` field contains a free form name value. The `given_name`, `middle_name`, `family_name`, etc, fields contain the structured name. For CONTACT mutates, (i.e. when Name.metadata.container is CONTACT), it is recommended for clients to set either the `unstructured_name` or the set of structured name fields, not both. * When only the `unstructured_name` is set, it is parsed to produce a best-guess set of structured name values for the `given_name`, `family_name`, etc. * When only the structured name fields are set, the various values are combined to produce an `unstructured_name`. * When both are set, the `unstructured_name` is saved as-is and the structured name fields are saved as-is. This may be confusing as they might not “match”. For PROFILE mutates, (i.e. when Name.metadata.container is PROFILE), it is _required_ for clients to use the structured name fields as the unstructured field value is ignored on write. The unstructured name fields are generated for convenience on read. For DEVICE_CONTACTS, see b/156020778. | String |
| unstructuredName | The free form name value. For contact mutates it is recommended for clients to set either the `unstructured_name` or the set of structured name fields, not both. | AppsPeopleOzExternalMergedpeopleapiName | See go/people-api-howto:names for an overview of name usage in PeopleAPI. The `unstructured_name` field contains a free form name value. The `given_name`, `middle_name`, `family_name`, etc, fields contain the structured name. For CONTACT mutates, (i.e. when Name.metadata.container is CONTACT), it is recommended for clients to set either the `unstructured_name` or the set of structured name fields, not both. * When only the `unstructured_name` is set, it is parsed to produce a best-guess set of structured name values for the `given_name`, `family_name`, etc. * When only the structured name fields are set, the various values are combined to produce an `unstructured_name`. * When both are set, the `unstructured_name` is saved as-is and the structured name fields are saved as-is. This may be confusing as they might not “match”. For PROFILE mutates, (i.e. when Name.metadata.container is PROFILE), it is _required_ for clients to use the structured name fields as the unstructured field value is ignored on write. The unstructured name fields are generated for convenience on read. For DEVICE_CONTACTS, see b/156020778. | String |
| yomiFamilyName | AppsPeopleOzExternalMergedpeopleapiName | See go/people-api-howto:names for an overview of name usage in PeopleAPI. The `unstructured_name` field contains a free form name value. The `given_name`, `middle_name`, `family_name`, etc, fields contain the structured name. For CONTACT mutates, (i.e. when Name.metadata.container is CONTACT), it is recommended for clients to set either the `unstructured_name` or the set of structured name fields, not both. * When only the `unstructured_name` is set, it is parsed to produce a best-guess set of structured name values for the `given_name`, `family_name`, etc. * When only the structured name fields are set, the various values are combined to produce an `unstructured_name`. * When both are set, the `unstructured_name` is saved as-is and the structured name fields are saved as-is. This may be confusing as they might not “match”. For PROFILE mutates, (i.e. when Name.metadata.container is PROFILE), it is _required_ for clients to use the structured name fields as the unstructured field value is ignored on write. The unstructured name fields are generated for convenience on read. For DEVICE_CONTACTS, see b/156020778. | String | |
| yomiFullName | AppsPeopleOzExternalMergedpeopleapiName | See go/people-api-howto:names for an overview of name usage in PeopleAPI. The `unstructured_name` field contains a free form name value. The `given_name`, `middle_name`, `family_name`, etc, fields contain the structured name. For CONTACT mutates, (i.e. when Name.metadata.container is CONTACT), it is recommended for clients to set either the `unstructured_name` or the set of structured name fields, not both. * When only the `unstructured_name` is set, it is parsed to produce a best-guess set of structured name values for the `given_name`, `family_name`, etc. * When only the structured name fields are set, the various values are combined to produce an `unstructured_name`. * When both are set, the `unstructured_name` is saved as-is and the structured name fields are saved as-is. This may be confusing as they might not “match”. For PROFILE mutates, (i.e. when Name.metadata.container is PROFILE), it is _required_ for clients to use the structured name fields as the unstructured field value is ignored on write. The unstructured name fields are generated for convenience on read. For DEVICE_CONTACTS, see b/156020778. | String | |
| yomiGivenName | AppsPeopleOzExternalMergedpeopleapiName | See go/people-api-howto:names for an overview of name usage in PeopleAPI. The `unstructured_name` field contains a free form name value. The `given_name`, `middle_name`, `family_name`, etc, fields contain the structured name. For CONTACT mutates, (i.e. when Name.metadata.container is CONTACT), it is recommended for clients to set either the `unstructured_name` or the set of structured name fields, not both. * When only the `unstructured_name` is set, it is parsed to produce a best-guess set of structured name values for the `given_name`, `family_name`, etc. * When only the structured name fields are set, the various values are combined to produce an `unstructured_name`. * When both are set, the `unstructured_name` is saved as-is and the structured name fields are saved as-is. This may be confusing as they might not “match”. For PROFILE mutates, (i.e. when Name.metadata.container is PROFILE), it is _required_ for clients to use the structured name fields as the unstructured field value is ignored on write. The unstructured name fields are generated for convenience on read. For DEVICE_CONTACTS, see b/156020778. | String | |
| yomiHonorificPrefix | AppsPeopleOzExternalMergedpeopleapiName | See go/people-api-howto:names for an overview of name usage in PeopleAPI. The `unstructured_name` field contains a free form name value. The `given_name`, `middle_name`, `family_name`, etc, fields contain the structured name. For CONTACT mutates, (i.e. when Name.metadata.container is CONTACT), it is recommended for clients to set either the `unstructured_name` or the set of structured name fields, not both. * When only the `unstructured_name` is set, it is parsed to produce a best-guess set of structured name values for the `given_name`, `family_name`, etc. * When only the structured name fields are set, the various values are combined to produce an `unstructured_name`. * When both are set, the `unstructured_name` is saved as-is and the structured name fields are saved as-is. This may be confusing as they might not “match”. For PROFILE mutates, (i.e. when Name.metadata.container is PROFILE), it is _required_ for clients to use the structured name fields as the unstructured field value is ignored on write. The unstructured name fields are generated for convenience on read. For DEVICE_CONTACTS, see b/156020778. | String | |
| yomiHonorificSuffix | AppsPeopleOzExternalMergedpeopleapiName | See go/people-api-howto:names for an overview of name usage in PeopleAPI. The `unstructured_name` field contains a free form name value. The `given_name`, `middle_name`, `family_name`, etc, fields contain the structured name. For CONTACT mutates, (i.e. when Name.metadata.container is CONTACT), it is recommended for clients to set either the `unstructured_name` or the set of structured name fields, not both. * When only the `unstructured_name` is set, it is parsed to produce a best-guess set of structured name values for the `given_name`, `family_name`, etc. * When only the structured name fields are set, the various values are combined to produce an `unstructured_name`. * When both are set, the `unstructured_name` is saved as-is and the structured name fields are saved as-is. This may be confusing as they might not “match”. For PROFILE mutates, (i.e. when Name.metadata.container is PROFILE), it is _required_ for clients to use the structured name fields as the unstructured field value is ignored on write. The unstructured name fields are generated for convenience on read. For DEVICE_CONTACTS, see b/156020778. | String | |
| yomiMiddleName | AppsPeopleOzExternalMergedpeopleapiName | See go/people-api-howto:names for an overview of name usage in PeopleAPI. The `unstructured_name` field contains a free form name value. The `given_name`, `middle_name`, `family_name`, etc, fields contain the structured name. For CONTACT mutates, (i.e. when Name.metadata.container is CONTACT), it is recommended for clients to set either the `unstructured_name` or the set of structured name fields, not both. * When only the `unstructured_name` is set, it is parsed to produce a best-guess set of structured name values for the `given_name`, `family_name`, etc. * When only the structured name fields are set, the various values are combined to produce an `unstructured_name`. * When both are set, the `unstructured_name` is saved as-is and the structured name fields are saved as-is. This may be confusing as they might not “match”. For PROFILE mutates, (i.e. when Name.metadata.container is PROFILE), it is _required_ for clients to use the structured name fields as the unstructured field value is ignored on write. The unstructured name fields are generated for convenience on read. For DEVICE_CONTACTS, see b/156020778. | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiNamePronunciationAudioMetadataInfo | Pronunciation audio metadata info. See go/name-pronunciation-backend. The metadata itself tracks the state of a user’s name pronunciation audio. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| namePronunciationAudioMetadata | Actual metadata proto, shared with FBS backends. | AppsPeopleOzExternalMergedpeopleapiNamePronunciationAudioMetadataInfo | Pronunciation audio metadata info. See go/name-pronunciation-backend. The metadata itself tracks the state of a user’s name pronunciation audio. | SocialGraphApiProtoNamePronunciationAudioMetadata |
| metadata | AppsPeopleOzExternalMergedpeopleapiNickname | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| type | AppsPeopleOzExternalMergedpeopleapiNickname | String | ||
| value | AppsPeopleOzExternalMergedpeopleapiNickname | String | ||
| metadata | AppsPeopleOzExternalMergedpeopleapiOccupation | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| value | AppsPeopleOzExternalMergedpeopleapiOccupation | String | ||
| openNow | Is this place open right now? Always present unless we lack time-of-day or timezone data for these opening hours. | AppsPeopleOzExternalMergedpeopleapiOpeningHours | The periods that this place is open during the week. The periods are in chronological order, starting with today in the place-local timezone. An empty (but not absent) value indicates a place that is never open, e.g. because it is closed temporarily for renovations. | boolean |
| periods | AppsPeopleOzExternalMergedpeopleapiOpeningHours | The periods that this place is open during the week. The periods are in chronological order, starting with today in the place-local timezone. An empty (but not absent) value indicates a place that is never open, e.g. because it is closed temporarily for renovations. | list(AppsPeopleOzExternalMergedpeopleapiOpeningHoursPeriod) | |
| weekdayTexts | Localized strings describing the opening hours of this place, one string for each day of the week. Will be empty if the hours are unknown or could not be converted to localized text. Example: “Sun: 18:00-06:00” | AppsPeopleOzExternalMergedpeopleapiOpeningHours | The periods that this place is open during the week. The periods are in chronological order, starting with today in the place-local timezone. An empty (but not absent) value indicates a place that is never open, e.g. because it is closed temporarily for renovations. | list(String) |
| day | A day of the week, as an integer in the range 0-6. 0 is Sunday, 1 is Monday, etc. | AppsPeopleOzExternalMergedpeopleapiOpeningHoursEndpoint | integer | |
| time | A time in 24-hour “hhmm” format (i.e. range is 0000 to 2359). | AppsPeopleOzExternalMergedpeopleapiOpeningHoursEndpoint | String | |
| close | AppsPeopleOzExternalMergedpeopleapiOpeningHoursPeriod | AppsPeopleOzExternalMergedpeopleapiOpeningHoursEndpoint | ||
| open | AppsPeopleOzExternalMergedpeopleapiOpeningHoursPeriod | AppsPeopleOzExternalMergedpeopleapiOpeningHoursEndpoint | ||
| assignment | AppsPeopleOzExternalMergedpeopleapiOrganization | list(AppsPeopleOzExternalMergedpeopleapiOrganizationAssignment) | ||
| certification | AppsPeopleOzExternalMergedpeopleapiOrganization | String | ||
| costCenter | AppsPeopleOzExternalMergedpeopleapiOrganization | String | ||
| current | AppsPeopleOzExternalMergedpeopleapiOrganization | boolean | ||
| department | AppsPeopleOzExternalMergedpeopleapiOrganization | String | ||
| description | AppsPeopleOzExternalMergedpeopleapiOrganization | String | ||
| domain | AppsPeopleOzExternalMergedpeopleapiOrganization | String | ||
| endCalendarDay | Start and End Dates are better represented as calendar entities. The intention is to replace timestamps. Not set if no value exists. Clients can choose whether to use has* semantics or default value semantics. For writes, the default proto and an absent message are equivalent. Legacy callers in the legacy_timestamp_event_write_behavior_enabled capability allowlist should write to PeopleApi via end_ms and migrate to setting both so they can be removed from the whitelist. | AppsPeopleOzExternalMergedpeopleapiOrganization | GoogleTypeDate | |
| endMs | Clients are encouraged to read the end_calendar_day instead. PeopleApi writes will still use end_ms for legacy callers that are in the legacy_timestamp_event_write_behavior_enabled capability allowlist. New writers must use the calendar_day fields. | AppsPeopleOzExternalMergedpeopleapiOrganization | String | |
| endMsAsNumber | AppsPeopleOzExternalMergedpeopleapiOrganization | String | ||
| formattedStringType | The `string_type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiOrganization | String | |
| fteMilliPercent | AppsPeopleOzExternalMergedpeopleapiOrganization | integer | ||
| importance | AppsPeopleOzExternalMergedpeopleapiOrganization | number | ||
| location | AppsPeopleOzExternalMergedpeopleapiOrganization | String | ||
| metadata | AppsPeopleOzExternalMergedpeopleapiOrganization | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| name | AppsPeopleOzExternalMergedpeopleapiOrganization | String | ||
| project | AppsPeopleOzExternalMergedpeopleapiOrganization | list(AppsPeopleOzExternalMergedpeopleapiOrganizationProject) | ||
| startCalendarDay | Start and End Dates are better represented as calendar entities. The intention is to replace timestamps. Not set if no value exists. Clients can choose whether to use has* semantics or default value semantics. For writes, the default proto and an absent message are equivalent. Legacy callers in the legacy_timestamp_event_write_behavior_enabled capability allowlist should write to PeopleApi via start_ms and migrate to setting both so they can be removed from the allowlist. | AppsPeopleOzExternalMergedpeopleapiOrganization | GoogleTypeDate | |
| startMs | Clients are encouraged to read the start_calendar_day instead. PeopleApi writes will still use start_ms for legacy callers that are in the legacy_timestamp_event_write_behavior_enabled capability allowlist. New writers must use the calendar_day fields. | AppsPeopleOzExternalMergedpeopleapiOrganization | String | |
| startMsAsNumber | AppsPeopleOzExternalMergedpeopleapiOrganization | String | ||
| stringType | The type of the organization. The type can be free form or one of these predefined values: * `work` * `school` | AppsPeopleOzExternalMergedpeopleapiOrganization | String | |
| symbol | AppsPeopleOzExternalMergedpeopleapiOrganization | String | ||
| title | AppsPeopleOzExternalMergedpeopleapiOrganization | String | ||
| type | AppsPeopleOzExternalMergedpeopleapiOrganization | String | ||
| yomiName | AppsPeopleOzExternalMergedpeopleapiOrganization | String | ||
| name | AppsPeopleOzExternalMergedpeopleapiOrganizationAssignment | String | ||
| url | AppsPeopleOzExternalMergedpeopleapiOrganizationAssignment | String | ||
| description | AppsPeopleOzExternalMergedpeopleapiOrganizationProject | String | ||
| name | AppsPeopleOzExternalMergedpeopleapiOrganizationProject | String | ||
| role | AppsPeopleOzExternalMergedpeopleapiOrganizationProject | String | ||
| type | Mapped from StandardProjectTag / CustomProjectTag | AppsPeopleOzExternalMergedpeopleapiOrganizationProject | String | |
| url | AppsPeopleOzExternalMergedpeopleapiOrganizationProject | String | ||
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiOtherKeyword | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiOtherKeyword | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| source | AppsPeopleOzExternalMergedpeopleapiOtherKeyword | String | ||
| type | The type of the event. The type depends on the `OtherKeyword.source`. `OUTLOOK` source fields must be one of: * `billing_information` * `directory_server` * `keyword` * `mileage` * `sensitivity` * `user` * `subject` All other fields are treated as a `CUSTOM` source field. The value can be free form or one of these predefined values: * `home` * `other` * `work` | AppsPeopleOzExternalMergedpeopleapiOtherKeyword | String | |
| value | AppsPeopleOzExternalMergedpeopleapiOtherKeyword | String | ||
| relation | See go/relation-vs-relationship for relation vs relationship explanation. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiRelation) |
| photo | See go/people-api-concepts/photos for usage details | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiPhoto) |
| organization | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiOrganization) | |
| mission | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiMission) | |
| customSchemaField | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiCustomSchemaField) | |
| coverPhoto | DEPRECATED. Now always returns a default cover photo. See go/sunset-cover-photo. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiCoverPhoto) |
| linkedPerson | Other person resources linked indirectly by an edge. The full person or just the IDs may be populated depending on request parameters. We consider linked people distinct people, but they share information. Example: A contact with two outgoing edges. The two edges are considered separate, but linked people. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiPerson) |
| name | See go/people-api-howto:names for details about names in PeopleAPI. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiName) |
| sortKeys | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | AppsPeopleOzExternalMergedpeopleapiSortKeys | |
| sipAddress | SipAddress is currently in use by contacts. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiSipAddress) |
| inAppReachability | Used only by profile service, deprecated for PeopleAPI and Sharpen. If you aren’t sure, contact people-api-users@ and profile-service-eng@. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiInAppReachability) |
| calendar | b/145671020: Deprecated for Profiles, but not for Contacts. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiCalendar) |
| socialConnection | NOTE: this is used by go/starlight, but not actually used or returned in PeopleAPI. See b/27281119 for context. Please reach out to people-api-eng@ if you have questions. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiSocialConnection) |
| plusPageInfo | DEPRECATED. Info about plus pages in the person. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiPlusPageInfo) |
| externalId | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiExternalId) | |
| mapsProfile | MapsProfile, see go/product-profiles-backend-api | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiMapsProfile) |
| tagline | Only supported for PLACE container results, no data will be returned for profiles. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiTagline) |
| interactionSettings | DEPRECATED. This field isn’t populated in people.list. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiInteractionSettings) |
| peopleInCommon | DEPRECATED. This feature was stubbed, but never implemented. This field will not be populated with any results. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiPerson) |
| connectionReminder | Reminder to connect with a Contact (part of go/people-prompts). Also contains contact-level prompts settings. Each Contact can have a single `connection_reminder` (but can have multiple Prompts inside of it). Field is repeated per PeopleAPI data model go/people-api-concepts#repeated. Only supported for CONTACT container. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiConnectionReminder) |
| limitedProfileSettings | Settings for the limited profile. See go/limited-profiles-api. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiLimitedProfileSettingsField) |
| metadata | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | |
| birthday | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiBirthday) | |
| AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiEmail) | ||
| otherKeyword | Legacy arbitrary key value fields | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiOtherKeyword) |
| inAppNotificationTarget | Ways to send in-app notifications to this person. See go/reachability. This field is read-only and ignored for mutates. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiInAppNotificationTarget) |
| placeDetails | Data specific to places. Data which also applies to contacts and profiles such as name, phone, photo, etc. are returned in the corresponding Person fields. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiPlaceDetails) |
| rightOfPublicityState | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiRightOfPublicityState) | |
| im | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiIm) | |
| legacyFields | DEPRECATED. This field was only for backwards compatibility with legacy GData callers, and should not be used by new clients. Legacy fields used for mobile clients. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | AppsPeopleOzExternalMergedpeopleapiLegacyFields |
| occupation | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiOccupation) | |
| sshPublicKey | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiSshPublicKey) | |
| namePronunciationAudioMetadataInfo | Metadata info for a user’s name pronunciation audio. See go/name-pronunication-backend. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiNamePronunciationAudioMetadataInfo) |
| relationshipInterest | DEPRECATED. No data is returned for this field anymore. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiRelationshipInterest) |
| skills | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiSkills) | |
| contactPromptSettingsInfo | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiContactPromptSettingsInfo) | |
| profileUrl | DEPRECATED. No data is returned for this field anymore. (go/people-api-concepts#repeated): Use person.profile_url_repeated instead. Access to this field is restricted to a set of legacy clients. This is a Google+-only field. See go/fbs-g+-deprecation. NOTE: `Person.profile_url` is only populated for profile-centric person. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | String |
| managementUpchain | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiManagementUpchain) | |
| contactEditContextInfo | ContactEditContextInfo is a timestamp and additional metadata (e.g. the source of the edit) for the last ‘human initiated edit’. See also `ContactCreateContextInfo`. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiContactEditContextInfo) |
| website | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiWebsite) | |
| phone | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiPhone) | |
| teamsExtendedData | DEPRECATED. *UNSUPPORTED*. This field is never populated. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | AppsPeopleOzExternalMergedpeopleapiTeamsExtendedData |
| contactCreateContextInfo | ContactCreateContextInfo has a timestamp timestamp and additional metadata (e.g. the source of the creation) for when the contact was created. See also `ContactEditContextInfo`. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiContactCreateContextInfo) |
| personAttribute | In order to request this field, the client must set desired PersonAttributeKey in the dedicated RequestMask field `person_attribute`. Unlike other person fields, this field cannot be requested in the `include_field` field mask. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiPersonAttribute) |
| location | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiLocation) | |
| pronoun | Pronouns are not supported for consumer profiles. See go/pronouns-in-people-system-prd for more details. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiPronoun) |
| ageRangeRepeated | Data on the person’s age range, adult status, and age of consent. NOTE: Please read go/people-api-howto:age on how to correctly get age data. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiAgeRangeType) |
| posixAccount | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiPosixAccount) | |
| language | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiLanguage) | |
| profileUrlRepeated | DEPRECATED. No data is returned for this field anymore. This is a Google+-only field. See go/fbs-g+-deprecation. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiProfileUrl) |
| userDefined | UserDefined is currently in use by contacts. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiUserDefined) |
| event | Event is currently in use by contacts. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiEvent) |
| rosterDetails | Data specific to rosters (such as Google Groups and Chat Rooms). Data which also applies to contacts and profiles such as name, email, and photo, etc are returned in the corresponding Person fields. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiRosterDetails) |
| emergencyInfo | Emergency information. See go/emergency-trusted-contacts-papi. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiEmergencyInfo) |
| visibleToGuests | Add annotation_id and metadata (product_source) for visible to guests contacts go/visible-to-guests. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiVisibleToGuests) |
| ageRange | Deprecated. If age is needed use `person.age_range_repeated` instead. Please see go/people-api-howto:age on how to correctly get age data. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | String |
| searchProfile | Profile for Janata and Search. go/janata-profile-in-sgbe | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiSearchProfile) |
| contactStateInfo | Contact state and related metadata. See go/fbs-contacts-trash. If this field was requested but is not set on the Person then the contact is in the DEFAULT contact state. This field is read-only, and should not be set on a mutate (e.g. UpdatePerson) call. Clients must call the explicit APIs (e.g. UntrashPerson) to change contact state. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiContactStateInfo) |
| extendedData | Data added by extensions that are not specific to a particular field. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData |
| nickname | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiNickname) | |
| about | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiAbout) | |
| personId | The ID of the person. This is determined by the backend, is unstable, and may not be the same as a user_id. Internally referred as ‘personKey’ to distinguish from the common PersonId pojo. See go/people-api-concepts#person-id | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | String |
| fileAs | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiFileAs) | |
| readOnlyProfileInfo | Information about the profiles that are a part of this Person. This is only applicable to PROFILE and DOMAIN_PROFILE containers. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiReadOnlyProfileInfo) |
| relationshipStatus | DEPRECATED. No data is returned for this field anymore. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiRelationshipStatus) |
| interest | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiInterest) | |
| contactGroupMembership | Contact groups that this person is a member of. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiContactGroupMembership) |
| address | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiAddress) | |
| circleMembership | Circles that this person is a member of. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiCircleMembership) |
| certifiedBornBefore | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiCertifiedBornBefore) | |
| braggingRights | Used only by contacts, no data will be returned for profiles. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiBraggingRights) |
| gender | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiGender) | |
| fingerprint | A fingerprint that can be used to reliably determine if a resource has changed. Externally it is used as part of the etag. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | String |
| membership | DEPRECATED. Please use `circle_membership` or `contact_group_membership` instead. Contact-groups and circles that this person is a member of. | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiMembership) |
| communicationEmail | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiCommunicationEmail) | |
| clientData | AppsPeopleOzExternalMergedpeopleapiPerson | Merged-person combines multiple sources of data like contacts and profiles. See go/people-api and go/understanding-merged-person NOTE: Why are all the fields repeated? See go/people-api-concepts#repeated | list(AppsPeopleOzExternalMergedpeopleapiClientData) | |
| attributeKey | AppsPeopleOzExternalMergedpeopleapiPersonAttribute | Client-specific binary blob stored with Person data. This differs from ClientData, which stores structured, key-value pairs. | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiPersonAttribute | Client-specific binary blob stored with Person data. This differs from ClientData, which stores structured, key-value pairs. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| value | AppsPeopleOzExternalMergedpeopleapiPersonAttribute | Client-specific binary blob stored with Person data. This differs from ClientData, which stores structured, key-value pairs. | String | |
| aboutMeExtendedData | For use by AboutMe and SmartProfile clients. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedData |
| appsWaldoExtendedData | For use with Apps Waldo Availability Data extension | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | SocialGraphWireProtoPeopleapiExtensionAppsWaldoExtendedData |
| callerIdExtendedData | For use with caller ID extension | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | AppsPeopleOzExternalMergedpeopleapiCallerIdExtendedData |
| contactsExtendedData | For use with Contacts extension. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | AppsPeopleOzExternalMergedpeopleapiWebContactsExtendedData |
| domainName | Hosted domain this person is a member of. The domain_name is also returned as part of the person’s ReadOnlyProfileInfo, so requesting it via this extension is no longer necessary. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | list(String) |
| dynamiteExtendedData | For use with Dynamite extension. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | SocialGraphWireProtoPeopleapiExtensionDynamiteExtendedData |
| gpayExtendedData | For use with Google Pay extension. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | AppsPeopleOzExternalMergedpeopleapiGPayExtendedData |
| gplusExtendedData | For use with Google+ extension. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | AppsPeopleOzExternalMergedpeopleapiGplusExtendedData |
| hangoutsExtendedData | For use with Hangouts extension. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | AppsPeopleOzExternalMergedpeopleapiHangoutsExtendedData |
| isPlaceholder | For use with gmail extensions and lookup by email. If true, no person was actually found using the specified email address, but we want to return TLS info about the email address regardless. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | boolean |
| mapsExtendedData | For use with Maps extension. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | AppsPeopleOzExternalMergedpeopleapiMapsExtendedData |
| paisaExtendedData | For use with Paisa extension | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | SocialGraphWireProtoPeopleapiExtensionPaisaExtendedData |
| peopleStackExtendedData | DEPRECATED: Use people_stack_person_extended_data instead. For use with PeopleStack extension. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | SocialGraphWireProtoPeopleapiExtensionPeopleStackExtendedData |
| peopleStackPersonExtendedData | For use with PeopleStack extension. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | SocialGraphWireProtoPeopleapiExtensionPeopleStackPersonExtendedData |
| playGamesExtendedData | For use with Play Games Product Profile extension. See go/jam-games-profile. The play games profile will be returned only for profile-centric requests. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedData |
| tlsIsPlaceholder | For use with the TLS extension and lookup by email. If true, no person was actually found using the specified email address, but we want to return TLS info about the email address regardless. DEPRECATED: Use is_placeholder instead. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | boolean |
| youtubeExtendedData | For use with Youtube extension. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | AppsPeopleOzExternalMergedpeopleapiYoutubeExtendedData |
| aclChoices | When the container is PROFILE/DOMAIN_PROFILE and the profile owner is the requester, this read-only, synthesized field indicates which ACLs the user is allowed to set on the profile field. This is distinct from field_acl, which is the field’s currently set ACL. field_acl will always be a valid ACL choice, except for the case of default synthesized profile fields like monogram profile photos. For those, field_acl does not represent a user-set field ACL, so it may or may not be a valid choice. In all cases, default_acl_choice will always be a valid choice. This is currently only populated on the photo field when the “person.photo.metadata.acl_choices” mask is set. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | list(AppsPeopleOzExternalMergedpeopleapiFieldAcl) |
| additionalContainerInfo | Additional information about the container of this field. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | AppsPeopleOzExternalMergedpeopleapiAdditionalContainerInfo |
| affinity | For field-level affinity scores. The affinity between the requester and this particular field in the Person (e.g., frequency of calling a particular phone number). | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | list(AppsPeopleOzExternalMergedpeopleapiAffinity) |
| contactVisibility | Each field can have different visibility settings Only returned when explicitly requested. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | list(String) |
| container | DEPRECATED. Use container_type instead. Having the Container be an enum at the PFM message level causes circular dependency when other types try to refer to it. It breaks javascript build targets. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | String |
| containerId | DEPRECATED. Use encoded_container_id instead. The numeric id of the data source. The id is only unique within a single container type. This is only set when the id of the container is numeric, e.g. contact id. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | String |
| containerPrimary | Indicates if this field is the primary field for the container and container_id. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | boolean |
| containerType | The source for the data in the field. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | String |
| crossDeviceAllowed | True if this field can be used on other devices than the one it originated from. Assigned by the server. Currently only used for device contacts. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | boolean |
| defaultAclChoice | When the container is PROFILE/DOMAIN_PROFILE and the profile owner is the requester, this read-only, synthesized field contains the default ACL choice. This can be used to select a preferred choice from acl_choices. Generally, default_acl_choice should only be preferred for default synthesized profile fields like monogram profile photos. Otherwise, the existing field_acl should be preferred. This is currently only populated on the photo field when the “person.photo.metadata.acl_choices” mask is set. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | AppsPeopleOzExternalMergedpeopleapiFieldAcl |
| deprecatedContactContainerId | DEPRECATED. Use container_id. Not populated or used at all. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | String |
| edgeKey | Field is an edge key for this person. Modifying it breaks the link between data sources. This is equivalent to edge_key_info having at least one entry with materialized = true. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | boolean |
| edgeKeyInfo | Edges that this field creates. This includes all edges and not necessarily just the edge relevant to the joined entities. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | list(AppsPeopleOzExternalMergedpeopleapiEdgeKeyInfo) |
| encodedContainerId | The encoded id of the data source. The id is only unique within a single container type. This field correlates to person.metadata.identity_info.source_id.id. This field may not be populated in some special cases, where the id is not visible to the querying user. e.g. ListAutocompletions with full phone number query. For value format, see google3/social/graph/api/proto/main_merged_person.proto?q=symbol:SourceIdentity.id | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | String |
| fieldAcl | When the container is PROFILE and the profile owner is the requester, this field indicates how the profile field is accessible. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | AppsPeopleOzExternalMergedpeopleapiFieldAcl |
| lastUpdateTime | Indicates the time that the field was added or last edited. Currently this is populated for: (1) person.birthday with ContainerType PROFILE, DOMAIN_PROFILE or ACCOUNT. (2) person.name, person.address, person.relation, person.email and person.phone with ContainerType CONTACT_ANNOTATION; | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | DateTime |
| matchingInfo | The matching informations if there was a query against this field. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | list(AppsPeopleOzExternalMergedpeopleapiMatchInfo) |
| otherDedupedContainers | When deduping fields by value, list of containers of the fields that where deduped. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | list(AppsPeopleOzExternalMergedpeopleapiDedupedContainerInfo) |
| primary | If true, indicates this field is the Person’s primary field eg. Contact, and (Profile) Person could have different Name fields, and the Name represented by the Person is primary. For selecting a primary field from RepeatedFields within a Person, use container_primary. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | boolean |
| productMetadata | The product(s) that generated the data in this field. Empty is equivalent to DEFAULT. ST_USER_METADATA | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | list(AppsPeopleOzExternalMergedpeopleapiProductMetadata) |
| verified | Indicates whether this is a verified field. It is synthesized from verification and is read-only. If there is at least one verification with status PASSED, the field is considered verified. Currently this is applicable to address, email, name, and phone for PROFILE and DOMAIN_PROFILE. Use .metadata.verified in the request mask. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | boolean |
| visibility | Currently, only people.get may set this value | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | String |
| writeable | Whether the field is writeable to the requester. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | boolean |
| people | AppsPeopleOzExternalMergedpeopleapiPersonListWithTotalNumber | A person list with total number specified. | list(AppsPeopleOzExternalMergedpeopleapiPerson) | |
| totalNumber | The total number of people, which is aways no less than the size of the above list. | AppsPeopleOzExternalMergedpeopleapiPersonListWithTotalNumber | A person list with total number specified. | integer |
| affinity | Affinities associated with the person, with respect to the requester. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | list(AppsPeopleOzExternalMergedpeopleapiAffinity) |
| attribution | Populated when the data for the MergedPerson comes from a 3rd party provider or data source. Clients must display these attributions to the user if they are present. NOTE: This field is only relevant when requesting the following containers: – PLACE (data read from Maps) | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | list(String) |
| bestDisplayName | The best name to use for this person for user-facing display. See go/people-api-howto:names for details about how this field is computed. In many cases this will simply be Person.name[0]. However, Person.name returns only explicit Name fields, but other fields maybe usable as a name (for example: nicknames, file_as, …). `best_display_name` will be calculated from all fields in storage which are usable as a name, even fields which are not explicitly requested in the MergedPerson result. See go/javagoog/apps/tacotown/socialgraph/entity/PersonNameFormatter.java | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | AppsPeopleOzExternalMergedpeopleapiBestDisplayName |
| blockType | DEPRECATED. Indicates whether the profile owner has blocked this person. Please use `person.read_only_profile_info.block_type` instead. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | list(String) |
| circleId | DEPRECATED. The circles the person belongs to. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | list(String) |
| contactGroupId | DEPRECATED. Please use `person.contact_group_memberships` instead. The contact groups the person belongs to. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | list(String) |
| contactId | The IDs of all contacts contributing to this person. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | list(String) |
| customResponseMaskingType | DEPRECATED. Customized masking of the response similar to the legacy People2RequestMask People2Params request message. NOTE: This param is inherently client-specific, limited to specific legacy clients, and not open to new usage. NOTE: Effects may be applied to a subset of people in the response. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | String |
| deleted | For sync requests (i.e., changed since the provided sync_token), indicates the resource is a tombstone for a Person resource that has been entirely deleted. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | boolean |
| deprecatedBlocked | DEPRECATED. Please use `person.read_only_profile_info.block_type` instead. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | boolean |
| deprecatedMembershipCircleId | DEPRECATED. This field is no longer populated or read. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | list(String) |
| deprecatedMembershipContactGroupId | DEPRECATED. This field is no longer populated or read. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | list(String) |
| deviceContactInfo | Info about the aggregated device contacts. When the person contains RAW_DEVICE_CONTACT containers, each DeviceContactInfo represents a single aggregate device contact made up of one or more raw device contacts. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | list(AppsPeopleOzExternalMergedpeopleapiDeviceContactInfo) |
| identityInfo | Detailed metadata about the lookup IDs and data sources included in a MergedPerson result. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | AppsPeopleOzExternalMergedpeopleapiIdentityInfo |
| inViewerDomain | DEPRECATED. Indicates whether this person is in the same domain as the viewer. For proxying trust between two users based on organization membership, see: – go/flex-orgs-platform – go/flex-orgs-compliance-handbook (especially http://shortn/_ChwfAY36Ys) | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | boolean |
| incomingBlockType | DEPRECATED. Indicates whether this person is blocking the profile owner. Please use `person.read_only_profile_info.incoming_block_type` instead. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | list(String) |
| lastUpdateTimeMicros | DEPRECATED. The last update timestamps for the constituent components of this person are available in `identity_info.source_ids`. The time of the most recent change to this person, in !!!NANOS!!! (due to a bug). May be a change to any of the underlying parts of the person (profile, contact, etc.). Not guaranteed to be the timestamp of the most recent change, due to limitations in the backend. This field is not fully deprecated for backend container-specific storage services like ProfileService which lack identity_info. The use is still discouraged in such systems and they should prefer to use the `last_update_time` field of this message instead. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | String |
| model | The person model that is used to construct this person. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | String |
| objectType | DEPRECATED. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | String |
| ownerId | DEPRECATED. Please use `person.read_only_profile_info.owner_id` instead. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | String |
| ownerUserType | DEPRECATED. See `person.read_only_profile_info.owner_user_type` instead. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | list(String) |
| plusPageType | DEPRECATED. Please use `Person.plus_page_info` instead. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | String |
| previousPersonId | DEPRECATED. This field is no longer populated or read. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | list(String) |
| profileOwnerStats | DEPRECATED. Stats/counters pertaining to followers and incoming edges. Please use `person.read_only_profile_info.profile_owner_stats` instead. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | AppsPeopleOzExternalMergedpeopleapiProfileOwnerStats |
| scoringInfo | Contact people-directory-dev-team@ if you want to use this field. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | AppsPeopleOzExternalMergedpeopleapiPersonMetadataScoringInfo |
| userVisibleStats | DEPRECATED. This field is no longer populated or read. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | AppsPeopleOzExternalMergedpeopleapiUserVisibleStats |
| rawMatchQualityScore | Only populated on a SearchDirectoryPeople call, when results are scored. Contact people-directory-dev-team@ if you want to use this field. | AppsPeopleOzExternalMergedpeopleapiPersonMetadataScoringInfo | float | |
| stExpressionResults | Only populated on a SearchDirectoryPeople call that sends a request with StFieldSpecExpressions. – Used for linking indexed terms with query terms for go/better-name-matching – Name should be alphanumeric or underscores – Value should be an st expression following the syntax at go/stsyntax Contact people-directory-dev-team@ if you want to use this field. | AppsPeopleOzExternalMergedpeopleapiPersonMetadataScoringInfo | list(AppsPeopleOzExternalMergedpeopleapiPersonMetadataScoringInfoStExpressionResult) | |
| name | AppsPeopleOzExternalMergedpeopleapiPersonMetadataScoringInfoStExpressionResult | String | ||
| value | AppsPeopleOzExternalMergedpeopleapiPersonMetadataScoringInfoStExpressionResult | String | ||
| canonicalizedForm | Canonicalized form that follows ITU-T E.164 international public telecommunication numbering plan. | AppsPeopleOzExternalMergedpeopleapiPhone | String | |
| emergencyInfo | Emergency information. See go/emergency-trusted-contacts-papi. | AppsPeopleOzExternalMergedpeopleapiPhone | AppsPeopleOzExternalMergedpeopleapiFieldEmergencyInfo | |
| extendedData | Read-only. Field requested by specifying `HANGOUTS_PHONE_DATA` in `extension_set.extension_names`. | AppsPeopleOzExternalMergedpeopleapiPhone | AppsPeopleOzExternalMergedpeopleapiPhoneExtendedData | |
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiPhone | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiPhone | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| type | The type of the phone number. The type can be free form or one of these predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other` | AppsPeopleOzExternalMergedpeopleapiPhone | String | |
| uri | AppsPeopleOzExternalMergedpeopleapiPhone | String | ||
| value | AppsPeopleOzExternalMergedpeopleapiPhone | String | ||
| structuredPhone | For use with Hangouts extension. | AppsPeopleOzExternalMergedpeopleapiPhoneExtendedData | AppsPeopleOzExternalMergedpeopleapiStructuredPhone | |
| decoration | Read-only. Use UpdatePersonPhoto to change photo decorations. If this photo is decorated, this field contains information about its decorations. For now, this will contain at most one entry. | AppsPeopleOzExternalMergedpeopleapiPhoto | list(SocialGraphApiProtoDecorationOverlay) | |
| emojiAvatarUrl | URL of an emoji avatar as an image. See go/emoji-cdn. PeopleAPI will return the SVG format so that it can be scaled client side and so that the images will not be animated. All clients that use this field must also have fall-back handling for using the `Photo.url` field if this is empty. When we have FIFE-compatible emoji-image URLs we will drop this field and return the Photo.url instead. Clients that have their own go/emoji-rendering integration may prefer to render the emoji-avatar from `Photo.glyph` field using their rendering system so that the emoji version/style match the rest of the application. For further background, see go/chatroom-avatar-as-roster-metadata. This field will only be populated if all of: – The PersonFieldMetadata `container_type` for the Photo is NAMED_CHAT_ROOM – The chat room has an emoji type avatar image set | AppsPeopleOzExternalMergedpeopleapiPhoto | String | |
| glyph | Unicode emoji representation of the chat room emoji avatar. This can be used by clients that use go/emoji-rendering directly so that they can present this with the same version/style as the rest of their application. This value may also be useful to clients as alt-text for the image. This field will only be populated if all of: – The PersonFieldMetadata `container_type` for the Photo is NAMED_CHAT_ROOM – The chat room has an emoji type avatar image set | AppsPeopleOzExternalMergedpeopleapiPhoto | String | |
| htmlAttribution | A set of HTML data provider attributions that must be shown with the result. Supported for PLACES photos only. See: go/understanding-places-api-attribution-requirements | AppsPeopleOzExternalMergedpeopleapiPhoto | list(String) | |
| isDefault | True when the photo is synthetic or generated (i.e. a monogram or default photo), false when the person has a custom photo. | AppsPeopleOzExternalMergedpeopleapiPhoto | boolean | |
| isMonogram | Indicates if the photo is a monogram avatar. Combined with is_default, the type of photo can be determined by: is_default=true, is_monogram=true: Default monogram avatar. is_default=true, is_monogram=false: Default silhouette avatar. is_default=false: Custom photo. is_monogram is irrelevant in this case. | AppsPeopleOzExternalMergedpeopleapiPhoto | boolean | |
| metadata | AppsPeopleOzExternalMergedpeopleapiPhoto | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| monogramBackground | When is_monogram=true, this is the background color of the monogram photo as a hex RGB formatted string “RRGGBB”. | AppsPeopleOzExternalMergedpeopleapiPhoto | String | |
| originalPhoto | Read-only. A reference to the original, undecorated profile photo in storage. This field is not stored. It is populated by a live read to /SocialGraphImageService.GetActiveProfilePhoto. This field is only returned when “person.photo.original_photo” is specified in the request mask. | AppsPeopleOzExternalMergedpeopleapiPhoto | SocialGraphApiProtoImageReference | |
| photoId | For writes only. Indicates photo content for person photo-field update. Currently only used for profile-photo updates (not contact photos yet). | AppsPeopleOzExternalMergedpeopleapiPhoto | AppsPeopleOzExternalMergedpeopleapiPhotoPhotoStorageId | |
| photoToken | Most clients don’t need to worry about this field and should just use the `url` to fetch the photo. See go/phototoken-migration-plan for some more context about this field. If you think you want to use this please talk with people-api-eng@ first. | AppsPeopleOzExternalMergedpeopleapiPhoto | String | |
| url | See go/people-api-concepts/photos for info on the different representations of URLs. | AppsPeopleOzExternalMergedpeopleapiPhoto | String | |
| viewerUrl | A URL for a UI to view the photo in its original context. For example, for a place photo, this is the url of a Google Maps page displaying the photo. Supported for place photos only. | AppsPeopleOzExternalMergedpeopleapiPhoto | String | |
| mediaKey | For writes only, pass the media key that represents the image in photos backend. Note, this is not populated on reads. | AppsPeopleOzExternalMergedpeopleapiPhotoPhotoStorageId | Info necessary for looking up a photo in storage. | String |
| googleUrl | A URL hosted by Google providing more information about this place This is the URL returned by Places API in the Place.Url.google field | AppsPeopleOzExternalMergedpeopleapiPlaceDetails | Metadata specific to places. | String |
| latLng | AppsPeopleOzExternalMergedpeopleapiPlaceDetails | Metadata specific to places. | AppsPeopleOzExternalMergedpeopleapiLatLng | |
| metadata | AppsPeopleOzExternalMergedpeopleapiPlaceDetails | Metadata specific to places. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| openingHours | AppsPeopleOzExternalMergedpeopleapiPlaceDetails | Metadata specific to places. | AppsPeopleOzExternalMergedpeopleapiOpeningHours | |
| primaryTypeName | The name of the primary type. Examples of primary type are: “art_school”, “clothing_wholesaler”, etc. All primary types can be found at http://shortn/_veqh6UwWdc | AppsPeopleOzExternalMergedpeopleapiPlaceDetails | Metadata specific to places. | String |
| achievements | User’s top achievements that are sorted for example by rarity. | AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedData | Extension data for use in Play Games Product Profile. See go/jam-games-profile. | list(AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedDataAchievement) |
| avatarImageUrl | The avatar image to display for the user. | AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedData | Extension data for use in Play Games Product Profile. See go/jam-games-profile. | String |
| failure | Failure type if there is an error when fetching product profile data. | AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedData | Extension data for use in Play Games Product Profile. See go/jam-games-profile. | AppsPeopleOzExternalMergedpeopleapiProductProfileFailure |
| gamerTag | The gamer tag set by the user. Not set if the user hasn’t set a gamer tag yet. | AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedData | Extension data for use in Play Games Product Profile. See go/jam-games-profile. | String |
| playerLevel | User’s level. | AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedData | Extension data for use in Play Games Product Profile. See go/jam-games-profile. | integer |
| profileVisibility | Specifies the visibility of the player’s profile. | AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedData | Extension data for use in Play Games Product Profile. See go/jam-games-profile. | String |
| totalFriendsCount | Total number of friends. | AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedData | Extension data for use in Play Games Product Profile. See go/jam-games-profile. | String |
| totalUnlockedAchievements | How many achievements this player has unlocked. | AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedData | Extension data for use in Play Games Product Profile. See go/jam-games-profile. | String |
| achievementName | The name of the achievement. | AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedDataAchievement | Details of an achievement that the user has unlocked. | String |
| achievementUnlockedIconUrl | The achievement icon url shown to the user if it is unlocked. | AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedDataAchievement | Details of an achievement that the user has unlocked. | String |
| rarityPercentage | Rarity of unlocking this achievement (3% of players unlocked would be 3) | AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedDataAchievement | Details of an achievement that the user has unlocked. | number |
| applicationId | Int64 ID of packaging-service entry; if set, the plus page is associated with a third-party application. | AppsPeopleOzExternalMergedpeopleapiPlusPageInfo | Information about a plus page and the entity it represents. | String |
| entityType | AppsPeopleOzExternalMergedpeopleapiPlusPageInfo | Information about a plus page and the entity it represents. | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiPlusPageInfo | Information about a plus page and the entity it represents. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| bounds | AppsPeopleOzExternalMergedpeopleapiPointSpec | Map marker location for an address. | GeostoreRectProto | |
| point | AppsPeopleOzExternalMergedpeopleapiPointSpec | Map marker location for an address. | GeostorePointProto | |
| pointSource | AppsPeopleOzExternalMergedpeopleapiPointSpec | Map marker location for an address. | String | |
| accountId | The user visible value is used to distinguish identical posix account fields with different customer key values. | AppsPeopleOzExternalMergedpeopleapiPosixAccount | Custom field that represents POSIX account information. Description of the field family: go/fbs-posix. If account has non-empty Username or Uid we will enforce global uniqueness of (AccountNamespace, CustomerKey, SystemId, Uid) and (AccountNamespace, CustomerKey, SystemId, Username) tuples to ensure there are no duplicates. | String |
| accountNamespace | Value indicates the uniqueness namespace that applies to the POSIX information. The value is included in all POSIX account uniqueness indices. The indexing prevents two accounts within the same customer from having the same username. Namespacing allows Windows and Linux users to share the same username. | AppsPeopleOzExternalMergedpeopleapiPosixAccount | Custom field that represents POSIX account information. Description of the field family: go/fbs-posix. If account has non-empty Username or Uid we will enforce global uniqueness of (AccountNamespace, CustomerKey, SystemId, Uid) and (AccountNamespace, CustomerKey, SystemId, Username) tuples to ensure there are no duplicates. | String |
| accountType | Value indicates whether the POSIX information is associated with a non-human entity and the validation logic to apply during PosixAccount mutation. | AppsPeopleOzExternalMergedpeopleapiPosixAccount | Custom field that represents POSIX account information. Description of the field family: go/fbs-posix. If account has non-empty Username or Uid we will enforce global uniqueness of (AccountNamespace, CustomerKey, SystemId, Uid) and (AccountNamespace, CustomerKey, SystemId, Username) tuples to ensure there are no duplicates. | String |
| customerKey | The customer associated with the POSIX identity. If the user is already associated with a G Suite Customer, this field has the same value as http://google3/ccc/hosted/policies/settings/dthree_customer_info.proto | AppsPeopleOzExternalMergedpeopleapiPosixAccount | Custom field that represents POSIX account information. Description of the field family: go/fbs-posix. If account has non-empty Username or Uid we will enforce global uniqueness of (AccountNamespace, CustomerKey, SystemId, Uid) and (AccountNamespace, CustomerKey, SystemId, Username) tuples to ensure there are no duplicates. | String |
| fingerprint | The value is automatically set to a SHA-256 fingerprint of the POSIX account. A fingerprint should uniquely identify a POSIX account entry. | AppsPeopleOzExternalMergedpeopleapiPosixAccount | Custom field that represents POSIX account information. Description of the field family: go/fbs-posix. If account has non-empty Username or Uid we will enforce global uniqueness of (AccountNamespace, CustomerKey, SystemId, Uid) and (AccountNamespace, CustomerKey, SystemId, Username) tuples to ensure there are no duplicates. | String |
| gecos | The GECOS (user information) entry for this account. | AppsPeopleOzExternalMergedpeopleapiPosixAccount | Custom field that represents POSIX account information. Description of the field family: go/fbs-posix. If account has non-empty Username or Uid we will enforce global uniqueness of (AccountNamespace, CustomerKey, SystemId, Uid) and (AccountNamespace, CustomerKey, SystemId, Username) tuples to ensure there are no duplicates. | String |
| gid | The default group ID. | AppsPeopleOzExternalMergedpeopleapiPosixAccount | Custom field that represents POSIX account information. Description of the field family: go/fbs-posix. If account has non-empty Username or Uid we will enforce global uniqueness of (AccountNamespace, CustomerKey, SystemId, Uid) and (AccountNamespace, CustomerKey, SystemId, Username) tuples to ensure there are no duplicates. | String |
| homeDirectory | The path to the home directory for this account. | AppsPeopleOzExternalMergedpeopleapiPosixAccount | Custom field that represents POSIX account information. Description of the field family: go/fbs-posix. If account has non-empty Username or Uid we will enforce global uniqueness of (AccountNamespace, CustomerKey, SystemId, Uid) and (AccountNamespace, CustomerKey, SystemId, Username) tuples to ensure there are no duplicates. | String |
| metadata | AppsPeopleOzExternalMergedpeopleapiPosixAccount | Custom field that represents POSIX account information. Description of the field family: go/fbs-posix. If account has non-empty Username or Uid we will enforce global uniqueness of (AccountNamespace, CustomerKey, SystemId, Uid) and (AccountNamespace, CustomerKey, SystemId, Username) tuples to ensure there are no duplicates. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| operatingSystemType | Value indicates whether to use Linux or Windows specific validation logic during PosixAccount mutation. | AppsPeopleOzExternalMergedpeopleapiPosixAccount | Custom field that represents POSIX account information. Description of the field family: go/fbs-posix. If account has non-empty Username or Uid we will enforce global uniqueness of (AccountNamespace, CustomerKey, SystemId, Uid) and (AccountNamespace, CustomerKey, SystemId, Username) tuples to ensure there are no duplicates. | String |
| shell | The path to the login shell for this account. | AppsPeopleOzExternalMergedpeopleapiPosixAccount | Custom field that represents POSIX account information. Description of the field family: go/fbs-posix. If account has non-empty Username or Uid we will enforce global uniqueness of (AccountNamespace, CustomerKey, SystemId, Uid) and (AccountNamespace, CustomerKey, SystemId, Username) tuples to ensure there are no duplicates. | String |
| systemId | System identifier for which account Username or Uid apply to. If not specified on mutate by a caller it will default to empty value if either Username or Uid are being set. SystemId does require to have a value (even an empty one) because it is included into null-filtered Spanner index used to enforce uniqueness on Username and Uid fields. | AppsPeopleOzExternalMergedpeopleapiPosixAccount | Custom field that represents POSIX account information. Description of the field family: go/fbs-posix. If account has non-empty Username or Uid we will enforce global uniqueness of (AccountNamespace, CustomerKey, SystemId, Uid) and (AccountNamespace, CustomerKey, SystemId, Username) tuples to ensure there are no duplicates. | String |
| uid | The user ID. | AppsPeopleOzExternalMergedpeopleapiPosixAccount | Custom field that represents POSIX account information. Description of the field family: go/fbs-posix. If account has non-empty Username or Uid we will enforce global uniqueness of (AccountNamespace, CustomerKey, SystemId, Uid) and (AccountNamespace, CustomerKey, SystemId, Username) tuples to ensure there are no duplicates. | String |
| username | The username of the account. | AppsPeopleOzExternalMergedpeopleapiPosixAccount | Custom field that represents POSIX account information. Description of the field family: go/fbs-posix. If account has non-empty Username or Uid we will enforce global uniqueness of (AccountNamespace, CustomerKey, SystemId, Uid) and (AccountNamespace, CustomerKey, SystemId, Username) tuples to ensure there are no duplicates. | String |
| productSource | AppsPeopleOzExternalMergedpeopleapiProductMetadata | String | ||
| failureType | AppsPeopleOzExternalMergedpeopleapiProductProfileFailure | Product profiles failure type: the status of the rpc to fetch the product profile. | String | |
| incomingAnyCircleCount | Replacement for deprecated follower_count. Comes from the EdgeSummary. | AppsPeopleOzExternalMergedpeopleapiProfileOwnerStats | Stats pertaining to incoming edges and views, visible to the requester (with acls applied). Related to, but not equal to, com.google.focus.proto.Storage.UserVisibleStats. | String |
| viewCount | Deprecated. This field is no longer populated by the server. | AppsPeopleOzExternalMergedpeopleapiProfileOwnerStats | Stats pertaining to incoming edges and views, visible to the requester (with acls applied). Related to, but not equal to, com.google.focus.proto.Storage.UserVisibleStats. | String |
| metadata | AppsPeopleOzExternalMergedpeopleapiProfileUrl | This is a Google+-only field (and thus does not exist for consumer users). See go/fbs-g+-deprecation. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| url | AppsPeopleOzExternalMergedpeopleapiProfileUrl | This is a Google+-only field (and thus does not exist for consumer users). See go/fbs-g+-deprecation. | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiPronoun | Message to represent a user’s set of preferred pronouns, see go/pronouns-backend. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| pronounData | AppsPeopleOzExternalMergedpeopleapiPronoun | Message to represent a user’s set of preferred pronouns, see go/pronouns-backend. | SocialGraphApiProtoPronounData | |
| dataSet | The data set within the account that this raw contact belongs to. | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactAnalyticalInfo | String | |
| dirty | The CP2 dirty field which indicates the sync state of the raw contact: https://developer.android.com/reference/android/provider/ContactsContract.SyncColumns#DIRTY True if the row is changed but not synced | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactAnalyticalInfo | boolean | |
| sourceIdExist | Whether the source ID exists for non-Google contacts. Won’t set for Google contacts. | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactAnalyticalInfo | boolean | |
| syncInfo | The Sync Info of a raw contact. | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactAnalyticalInfo | SocialGraphApiProtoSyncInfo | |
| accountName | Account name of raw contact, e.g. “[email protected]”. | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo | Raw device contact information. | String |
| accountType | Account type of raw contact, e.g. “com.google” or “com.linkedin.android”. | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo | Raw device contact information. | String |
| appContactData | The detailed app-specific endpoint data available for the given RawDeviceContactInfo instance. This proto should be used to obtain the list of actions and mimetypes supported by the third-party app. Design: go/3p-contact-upload | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo | Raw device contact information. | list(SocialGraphApiAppContactData) |
| appInfo | The app-specific endpoint data needed for app action fulfillment. Usage of this field should be avoided on the server-side, and should use the more detailed |full_app_info| field. | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo | Raw device contact information. | AppsPeopleOzExternalMergedpeopleapiAppUniqueInfo |
| crossDeviceAllowed | If true, this raw contact can be used on other devices than the one it originated from. Assigned by the server. | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo | Raw device contact information. | boolean |
| deviceContactMetadata | Extra metadata for this raw contact. | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo | Raw device contact information. | AppsPeopleOzExternalMergedpeopleapiDeviceContactExtraMetadata |
| googleContactId | The focus contact id for Google contacts. | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo | Raw device contact information. | String |
| id | The base64 serialized social.graph.peopleapi.proto.internal.RawDeviceContactId. This id should be used to correlate to field.metadata.encoded_container_id when the field.metadata.container_type is RAW_DEVICE_CONTACT The id also correlates to person.metadata.identity_info.source_id.id. For value format, see google3/social/graph/api/proto/main_merged_person.proto?q=symbol:SourceIdentity.id | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo | Raw device contact information. | String |
| photoType | The type of photo from the device (if any). | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo | Raw device contact information. | String |
| rawContactId | The id of the raw contact on the device. | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo | Raw device contact information. | String |
| rawDeviceContactAnalyticalInfo | Only to be used by Romanesco team specifically for analytics. | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo | Raw device contact information. | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactAnalyticalInfo |
| accountEmail | The account email linked to the profile, if any exists and is visible to the requester. | AppsPeopleOzExternalMergedpeopleapiReadOnlyProfileInfo | Metadata information about a profile. This message replaces legacy profile-specific singleton fields from the PersonMetadata proto (singleton top level Person fields are not compatible with non-profile-centric person results, which may include multiple profile containers). | AppsPeopleOzExternalMergedpeopleapiAccountEmail |
| blockType | Indicates whether the profile owner has blocked this person. | AppsPeopleOzExternalMergedpeopleapiReadOnlyProfileInfo | Metadata information about a profile. This message replaces legacy profile-specific singleton fields from the PersonMetadata proto (singleton top level Person fields are not compatible with non-profile-centric person results, which may include multiple profile containers). | list(String) |
| customerInfo | CustomerInfo for dasher user. The reader has to explicitly request this in the field_mask as ‘read_only_profile_info.customer_info’ | AppsPeopleOzExternalMergedpeopleapiReadOnlyProfileInfo | Metadata information about a profile. This message replaces legacy profile-specific singleton fields from the PersonMetadata proto (singleton top level Person fields are not compatible with non-profile-centric person results, which may include multiple profile containers). | AppsPeopleOzExternalMergedpeopleapiCustomerInfo |
| domainInfo | DEPRECATED. Use the `ReadOnlyProfileInfo.customer_info` field instead (b/138120418). Only populated if in_viewer_domain is true. | AppsPeopleOzExternalMergedpeopleapiReadOnlyProfileInfo | Metadata information about a profile. This message replaces legacy profile-specific singleton fields from the PersonMetadata proto (singleton top level Person fields are not compatible with non-profile-centric person results, which may include multiple profile containers). | AppsPeopleOzExternalMergedpeopleapiReadOnlyProfileInfoDomainInfo |
| inViewerDomain | DEPRECATED. Proxying trust between users in a domain should use go/flex-orgs-platform. For more info see: http://doc/18i0-C7vWcz2UuXYBsmulnriVCK3_EuMPpRlPa2OmMHw#heading=h.dobotdwx25kg Indicates whether the profile owner is in the same domain as the viewer. | AppsPeopleOzExternalMergedpeopleapiReadOnlyProfileInfo | Metadata information about a profile. This message replaces legacy profile-specific singleton fields from the PersonMetadata proto (singleton top level Person fields are not compatible with non-profile-centric person results, which may include multiple profile containers). | boolean |
| incomingBlockType | Indicates whether this person is blocking the profile owner. | AppsPeopleOzExternalMergedpeopleapiReadOnlyProfileInfo | Metadata information about a profile. This message replaces legacy profile-specific singleton fields from the PersonMetadata proto (singleton top level Person fields are not compatible with non-profile-centric person results, which may include multiple profile containers). | list(String) |
| metadata | AppsPeopleOzExternalMergedpeopleapiReadOnlyProfileInfo | Metadata information about a profile. This message replaces legacy profile-specific singleton fields from the PersonMetadata proto (singleton top level Person fields are not compatible with non-profile-centric person results, which may include multiple profile containers). | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| objectType | DEPRECATED. | AppsPeopleOzExternalMergedpeopleapiReadOnlyProfileInfo | Metadata information about a profile. This message replaces legacy profile-specific singleton fields from the PersonMetadata proto (singleton top level Person fields are not compatible with non-profile-centric person results, which may include multiple profile containers). | String |
| ownerId | The Focus-obfuscated Gaia ID of the profile owner (go/obfuscated-ids). | AppsPeopleOzExternalMergedpeopleapiReadOnlyProfileInfo | Metadata information about a profile. This message replaces legacy profile-specific singleton fields from the PersonMetadata proto (singleton top level Person fields are not compatible with non-profile-centric person results, which may include multiple profile containers). | String |
| ownerUserType | AppsPeopleOzExternalMergedpeopleapiReadOnlyProfileInfo | Metadata information about a profile. This message replaces legacy profile-specific singleton fields from the PersonMetadata proto (singleton top level Person fields are not compatible with non-profile-centric person results, which may include multiple profile containers). | list(String) | |
| plusPageType | DEPRECATED. Please use `person.plus_page_info` instead. | AppsPeopleOzExternalMergedpeopleapiReadOnlyProfileInfo | Metadata information about a profile. This message replaces legacy profile-specific singleton fields from the PersonMetadata proto (singleton top level Person fields are not compatible with non-profile-centric person results, which may include multiple profile containers). | String |
| profileOwnerStats | Stats/counters pertaining to followers and incoming edges. | AppsPeopleOzExternalMergedpeopleapiReadOnlyProfileInfo | Metadata information about a profile. This message replaces legacy profile-specific singleton fields from the PersonMetadata proto (singleton top level Person fields are not compatible with non-profile-centric person results, which may include multiple profile containers). | AppsPeopleOzExternalMergedpeopleapiProfileOwnerStats |
| unjoinedEmailCertificates | Returned only when explicitly requested in the request mask as read_only_profile_info.unjoined_email_certificates. Equivalent to fetching the Emails & the Email Certificates with the acls ignored. | AppsPeopleOzExternalMergedpeopleapiReadOnlyProfileInfo | Metadata information about a profile. This message replaces legacy profile-specific singleton fields from the PersonMetadata proto (singleton top level Person fields are not compatible with non-profile-centric person results, which may include multiple profile containers). | list(AppsPeopleOzExternalMergedpeopleapiEmail) |
| domainBadge | DEPRECATED. Organization badge for the domain this person is a member of. The badge is the primary hosted domain. | AppsPeopleOzExternalMergedpeopleapiReadOnlyProfileInfoDomainInfo | DEPRECATED. | list(String) |
| domainName | DEPRECATED. Hosted domain this person is a member of. Formerly only available via PersonExtendedData. | AppsPeopleOzExternalMergedpeopleapiReadOnlyProfileInfoDomainInfo | DEPRECATED. | list(String) |
| canonicalValue | Canonicalized `value` of the relation from this person to the user. This is currently used for data from contact annotations. Possible canonical values are based from http://google3/googledata/quality/aliases/relationship_en.config. | AppsPeopleOzExternalMergedpeopleapiRelation | Relation stores the related person between the contact or profile and a third person. See go/relation-vs-relationship for relation vs relationship explanation. This field currently includes RelationshipToMe data in fields value and canonical_value for ContainerType CONTACT_ANNOTATION. This will be moved to RelationshipToMe in b/221081499. | String |
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiRelation | Relation stores the related person between the contact or profile and a third person. See go/relation-vs-relationship for relation vs relationship explanation. This field currently includes RelationshipToMe data in fields value and canonical_value for ContainerType CONTACT_ANNOTATION. This will be moved to RelationshipToMe in b/221081499. | String |
| metadata | AppsPeopleOzExternalMergedpeopleapiRelation | Relation stores the related person between the contact or profile and a third person. See go/relation-vs-relationship for relation vs relationship explanation. This field currently includes RelationshipToMe data in fields value and canonical_value for ContainerType CONTACT_ANNOTATION. This will be moved to RelationshipToMe in b/221081499. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| relationDetails | The person whose email matches the Relation.value field, if it is a valid email address. This field is read-only and ignored on update. | AppsPeopleOzExternalMergedpeopleapiRelation | Relation stores the related person between the contact or profile and a third person. See go/relation-vs-relationship for relation vs relationship explanation. This field currently includes RelationshipToMe data in fields value and canonical_value for ContainerType CONTACT_ANNOTATION. This will be moved to RelationshipToMe in b/221081499. | AppsPeopleOzExternalMergedpeopleapiRelationRelationDetails |
| type | The relation type. The type can be free form or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner` | AppsPeopleOzExternalMergedpeopleapiRelation | Relation stores the related person between the contact or profile and a third person. See go/relation-vs-relationship for relation vs relationship explanation. This field currently includes RelationshipToMe data in fields value and canonical_value for ContainerType CONTACT_ANNOTATION. This will be moved to RelationshipToMe in b/221081499. | String |
| value | The person this relation applies to. Custom value provided by the user. | AppsPeopleOzExternalMergedpeopleapiRelation | Relation stores the related person between the contact or profile and a third person. See go/relation-vs-relationship for relation vs relationship explanation. This field currently includes RelationshipToMe data in fields value and canonical_value for ContainerType CONTACT_ANNOTATION. This will be moved to RelationshipToMe in b/221081499. | String |
| displayName | Equivalent to Name.display_name for the person_id profile. | AppsPeopleOzExternalMergedpeopleapiRelationRelationDetails | String | |
| jobTitle | Equivalent to Organization.title for the primary organization of the person_id profile. | AppsPeopleOzExternalMergedpeopleapiRelationRelationDetails | String | |
| personId | AppsPeopleOzExternalMergedpeopleapiRelationRelationDetails | String | ||
| photoUrl | Equivalent to Photo.url for the person_id profile. | AppsPeopleOzExternalMergedpeopleapiRelationRelationDetails | String | |
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiRelationshipInterest | Deprecated in b/122464133. No data returned for this field. | String |
| metadata | AppsPeopleOzExternalMergedpeopleapiRelationshipInterest | Deprecated in b/122464133. No data returned for this field. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| type | These fields may give away the sexual orientation of the user. | AppsPeopleOzExternalMergedpeopleapiRelationshipInterest | Deprecated in b/122464133. No data returned for this field. | String |
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiRelationshipStatus | Deprecated in b/122464133. No data returned for this field. | String |
| metadata | AppsPeopleOzExternalMergedpeopleapiRelationshipStatus | Deprecated in b/122464133. No data returned for this field. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| type | AppsPeopleOzExternalMergedpeopleapiRelationshipStatus | Deprecated in b/122464133. No data returned for this field. | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiRightOfPublicityState | User preference for shared endorsements. See go/se-devguide and go/sharedendorsements for details, including guidance on which contexts are which. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| state | AppsPeopleOzExternalMergedpeopleapiRightOfPublicityState | User preference for shared endorsements. See go/se-devguide and go/sharedendorsements for details, including guidance on which contexts are which. | String | |
| abridgedRosterMemberships | Abridged / sample subset of member details of the roster. NOTE: This field is only returned if the request’s field mask includes “person.roster_details.abridged_roster_memberships”. http://cs/symbol:google.apps.cloudidentity.groups.internal.GroupSummary.abridged_memberships | AppsPeopleOzExternalMergedpeopleapiRosterDetails | Information specific to rosters like Google Groups and Chatrooms. | list(AppsPeopleOzExternalMergedpeopleapiRosterMember) |
| metadata | AppsPeopleOzExternalMergedpeopleapiRosterDetails | Information specific to rosters like Google Groups and Chatrooms. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| rosterMemberCount | Indicates the number of members and sub-rosters of the roster. Corresponds to http://cs/symbol:google.apps.cloudidentity.groups.internal.Group.direct_member_count_per_type | AppsPeopleOzExternalMergedpeopleapiRosterDetails | Information specific to rosters like Google Groups and Chatrooms. | AppsPeopleOzExternalMergedpeopleapiRosterMemberCount |
| memberType | Type of the member. | AppsPeopleOzExternalMergedpeopleapiRosterMember | Represents details of a member of a roster. Used in RosterDetails. Corresponds to http://cs/symbol:google.apps.cloudidentity.groups.internal.Membership | String |
| personId | Focus-Obfuscated Gaia Id of the member. | AppsPeopleOzExternalMergedpeopleapiRosterMember | Represents details of a member of a roster. Used in RosterDetails. Corresponds to http://cs/symbol:google.apps.cloudidentity.groups.internal.Membership | String |
| directGroupCount | Indicates the number of direct sub-rosters of the roster. This comes from http://cs/symbol:google.apps.cloudidentity.groups.internal.Group.DirectMemberCountPerType.group_count | AppsPeopleOzExternalMergedpeopleapiRosterMemberCount | Represents the summary of member counts of a roster. Used in RosterDetails. Corresponds to http://cs/symbol:google.apps.cloudidentity.groups.internal.Group.DirectMemberCountPerType | String |
| directUserCount | Indicates the number of direct, non-roster members of the roster. This comes from http://cs/symbol:google.apps.cloudidentity.groups.internal.Group.DirectMemberCountPerType.user_count | AppsPeopleOzExternalMergedpeopleapiRosterMemberCount | Represents the summary of member counts of a roster. Used in RosterDetails. Corresponds to http://cs/symbol:google.apps.cloudidentity.groups.internal.Group.DirectMemberCountPerType | String |
| metadata | AppsPeopleOzExternalMergedpeopleapiSearchProfile | Profile for Janata and Search. go/janata-profile-in-sgbe | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| searchProfileData | AppsPeopleOzExternalMergedpeopleapiSearchProfile | Profile for Janata and Search. go/janata-profile-in-sgbe | SocialGraphApiProtoSearchProfileData | |
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiSipAddress | As of 03/2018 is not supported for user Profile. | String |
| metadata | AppsPeopleOzExternalMergedpeopleapiSipAddress | As of 03/2018 is not supported for user Profile. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| type | The type of the SIP address. The type can be free form or or one of these predefined values: * `home` * `work` * `mobile` * `other` | AppsPeopleOzExternalMergedpeopleapiSipAddress | As of 03/2018 is not supported for user Profile. | String |
| value | AppsPeopleOzExternalMergedpeopleapiSipAddress | As of 03/2018 is not supported for user Profile. | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiSkills | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| value | AppsPeopleOzExternalMergedpeopleapiSkills | String | ||
| metadata | AppsPeopleOzExternalMergedpeopleapiSocialConnection | The social connection of this person to the viewer. NOTE: this is used by go/starlight, but not actually used or returned in PeopleAPI. See b/27281119 for context. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| type | AppsPeopleOzExternalMergedpeopleapiSocialConnection | The social connection of this person to the viewer. NOTE: this is used by go/starlight, but not actually used or returned in PeopleAPI. See b/27281119 for context. | list(String) | |
| affinity | AppsPeopleOzExternalMergedpeopleapiSortKeys | list(AppsPeopleOzExternalMergedpeopleapiAffinity) | ||
| interactionRank | Deprecated. This field is only populated with 0.000 for legacy reasons. Clients should not use this field. | AppsPeopleOzExternalMergedpeopleapiSortKeys | String | |
| lastName | AppsPeopleOzExternalMergedpeopleapiSortKeys | String | ||
| lastNameRaw | AppsPeopleOzExternalMergedpeopleapiSortKeys | String | ||
| name | AppsPeopleOzExternalMergedpeopleapiSortKeys | String | ||
| nameRaw | Raw name strings that were used to generate the name and last_name sort keys fields above. Contacts+ need them to generate section headers for list view (b/30642866). | AppsPeopleOzExternalMergedpeopleapiSortKeys | String | |
| container | The type of source. To be deprecated infavor of container_type | AppsPeopleOzExternalMergedpeopleapiSourceIdentity | Id of a single source from the merged person. | String |
| containerType | The type of the source. | AppsPeopleOzExternalMergedpeopleapiSourceIdentity | Id of a single source from the merged person. | String |
| deleted | In sync responses, indicates whether the identity source has been deleted. Not applicable to GOOGLE_GROUP. | AppsPeopleOzExternalMergedpeopleapiSourceIdentity | Id of a single source from the merged person. | boolean |
| id | The encoded id of the data source. This field correlates to PersonFieldMetadata.encoded_container_id. The possible values of this `id` field are as follows based on the value of the `container_type` field: CONTACT: Hex-encoded contact id. PROFILE: DOMAIN_PROFILE: GOOGLE_GROUP: NAMED_CHAT_ROOM: Focus-obfuscated Gaia ID. DOMAIN_CONTACT: Synthetic-contact id representing the domain shared contact. PLACE: Encoded PlaceId (go/javagoog/maps/api/places/util/PlaceIdEncoder.java) RAW_DEVICE_CONTACT: Pair of device_id and raw_contact_id, encoded as base64 serialized social.graph.peopleapi.proto.internal.RawDeviceContactId proto. CONTACT_ANNOTATION: Pair of annotation_id and event_timestamp, encoded as base64 serialized social.graph.peopleapi.proto.internal.ContactAnnotationId proto. — DEPRECATED container types — If the container is CIRCLE, then the id is going to be the synthetic- contact id representing the email-only circle member or gaia circle member for which the requester does not have a contact for. | AppsPeopleOzExternalMergedpeopleapiSourceIdentity | Id of a single source from the merged person. | String |
| lastUpdated | Last update timestamp of this source. NOTE: Only populated for CONTACT container type in Java PeopleAPI. Populated for CONTACT, PROFILE, DOMAIN_PROFILE in Sharpen implementation. NOTE: Not populated for GOOGLE_GROUP. | AppsPeopleOzExternalMergedpeopleapiSourceIdentity | Id of a single source from the merged person. | DateTime |
| lastUpdatedMicros | **DEPRECATED** Please use `last_updated` field instead. Last update timestamp of this source in microseconds. NOTE: Only populated for CONTACT container type. | AppsPeopleOzExternalMergedpeopleapiSourceIdentity | Id of a single source from the merged person. | String |
| sourceEtag | NOTE: Not populated for GOOGLE_GROUP. | AppsPeopleOzExternalMergedpeopleapiSourceIdentity | Id of a single source from the merged person. | String |
| expirationTime | AppsPeopleOzExternalMergedpeopleapiSshPublicKey | Custom field that represents SSH public keys associated with the user. We can treat the field as a map from a string fingerprint to the SSH public key information. | DateTime | |
| fingerprint | The value is automatically set to a SHA-256 fingerprint of an SSH public key. A fingerprint should uniquely identify an SSH public key. | AppsPeopleOzExternalMergedpeopleapiSshPublicKey | Custom field that represents SSH public keys associated with the user. We can treat the field as a map from a string fingerprint to the SSH public key information. | String |
| key | AppsPeopleOzExternalMergedpeopleapiSshPublicKey | Custom field that represents SSH public keys associated with the user. We can treat the field as a map from a string fingerprint to the SSH public key information. | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiSshPublicKey | Custom field that represents SSH public keys associated with the user. We can treat the field as a map from a string fingerprint to the SSH public key information. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| formattedType | The phone formatted type. See docs from mirrored proto: http://google3/ccc/grand_central/common/types.proto?l=128&rcl=241000760 | AppsPeopleOzExternalMergedpeopleapiStructuredPhone | This message mirrors the ContactPhoneNumber message in ccc/grand_central/common/types.proto. For various reasons, we cannot take on a direct dependency. See other proto file for most recent documentation. | String |
| phoneNumber | AppsPeopleOzExternalMergedpeopleapiStructuredPhone | This message mirrors the ContactPhoneNumber message in ccc/grand_central/common/types.proto. For various reasons, we cannot take on a direct dependency. See other proto file for most recent documentation. | AppsPeopleOzExternalMergedpeopleapiStructuredPhonePhoneNumber | |
| shortCode | AppsPeopleOzExternalMergedpeopleapiStructuredPhone | This message mirrors the ContactPhoneNumber message in ccc/grand_central/common/types.proto. For various reasons, we cannot take on a direct dependency. See other proto file for most recent documentation. | AppsPeopleOzExternalMergedpeopleapiStructuredPhoneShortCode | |
| type | The type of phone. See docs from mirrored proto: http://google3/ccc/grand_central/common/types.proto?l=125&rcl=241000760 | AppsPeopleOzExternalMergedpeopleapiStructuredPhone | This message mirrors the ContactPhoneNumber message in ccc/grand_central/common/types.proto. For various reasons, we cannot take on a direct dependency. See other proto file for most recent documentation. | String |
| e164 | AppsPeopleOzExternalMergedpeopleapiStructuredPhonePhoneNumber | String | ||
| i18nData | AppsPeopleOzExternalMergedpeopleapiStructuredPhonePhoneNumber | AppsPeopleOzExternalMergedpeopleapiStructuredPhonePhoneNumberI18nData | ||
| countryCode | AppsPeopleOzExternalMergedpeopleapiStructuredPhonePhoneNumberI18nData | integer | ||
| internationalNumber | AppsPeopleOzExternalMergedpeopleapiStructuredPhonePhoneNumberI18nData | String | ||
| isValid | AppsPeopleOzExternalMergedpeopleapiStructuredPhonePhoneNumberI18nData | boolean | ||
| nationalNumber | AppsPeopleOzExternalMergedpeopleapiStructuredPhonePhoneNumberI18nData | String | ||
| regionCode | AppsPeopleOzExternalMergedpeopleapiStructuredPhonePhoneNumberI18nData | String | ||
| validationResult | AppsPeopleOzExternalMergedpeopleapiStructuredPhonePhoneNumberI18nData | String | ||
| code | The phone code. See docs from mirrored proto: http://google3/ccc/grand_central/common/types.proto?l=70&rcl=241000760 | AppsPeopleOzExternalMergedpeopleapiStructuredPhoneShortCode | String | |
| countryCode | AppsPeopleOzExternalMergedpeopleapiStructuredPhoneShortCode | String | ||
| metadata | AppsPeopleOzExternalMergedpeopleapiTagline | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| value | AppsPeopleOzExternalMergedpeopleapiTagline | String | ||
| adminTo | AppsPeopleOzExternalMergedpeopleapiTeamsExtendedData | *UNSUPPORTED*. This message is never populated and is no longer used. | list(AppsPeopleOzExternalMergedpeopleapiPerson) | |
| admins | AppsPeopleOzExternalMergedpeopleapiTeamsExtendedData | *UNSUPPORTED*. This message is never populated and is no longer used. | list(AppsPeopleOzExternalMergedpeopleapiPerson) | |
| dottedLineManagers | AppsPeopleOzExternalMergedpeopleapiTeamsExtendedData | *UNSUPPORTED*. This message is never populated and is no longer used. | list(AppsPeopleOzExternalMergedpeopleapiPerson) | |
| dottedLineReports | AppsPeopleOzExternalMergedpeopleapiTeamsExtendedData | *UNSUPPORTED*. This message is never populated and is no longer used. | AppsPeopleOzExternalMergedpeopleapiPersonListWithTotalNumber | |
| failures | AppsPeopleOzExternalMergedpeopleapiTeamsExtendedData | *UNSUPPORTED*. This message is never populated and is no longer used. | list(String) | |
| managementChain | AppsPeopleOzExternalMergedpeopleapiTeamsExtendedData | *UNSUPPORTED*. This message is never populated and is no longer used. | list(AppsPeopleOzExternalMergedpeopleapiPerson) | |
| reports | AppsPeopleOzExternalMergedpeopleapiTeamsExtendedData | *UNSUPPORTED*. This message is never populated and is no longer used. | AppsPeopleOzExternalMergedpeopleapiPersonListWithTotalNumber | |
| key | AppsPeopleOzExternalMergedpeopleapiUserDefined | String | ||
| metadata | AppsPeopleOzExternalMergedpeopleapiUserDefined | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| value | AppsPeopleOzExternalMergedpeopleapiUserDefined | String | ||
| incomingAnyCircleCount | Replacement for deprecated follower_count. Comes from the EdgeSummary. | AppsPeopleOzExternalMergedpeopleapiUserVisibleStats | DEPRECATED in favor of ProfileStats. Stats pertaining to incoming edges and views, visible to the requester (with acls applied). Related to, but not equal to, com.google.focus.proto.Storage.UserVisibleStats. | String |
| viewCount | AppsPeopleOzExternalMergedpeopleapiUserVisibleStats | DEPRECATED in favor of ProfileStats. Stats pertaining to incoming edges and views, visible to the requester (with acls applied). Related to, but not equal to, com.google.focus.proto.Storage.UserVisibleStats. | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiVisibleToGuests | Store metadata information like annotation-id and product source for visible to guests contacts go/visible-to-guests. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| isIncomplete | Used by Contacts client-side to indicate whether a person is not completed. | AppsPeopleOzExternalMergedpeopleapiWebContactsExtendedData | boolean | |
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiWebsite | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiWebsite | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| rel | Currently in Oz: “Links”: Links with no rel. “Other profiles”: Links with rel=ME. “Contributor to”: Links with rel=CONTRIBUTOR_TO or PAST_CONTRIBUTOR_TO. | AppsPeopleOzExternalMergedpeopleapiWebsite | list(AppsPeopleOzExternalMergedpeopleapiWebsiteRelationshipInfo) | |
| type | The type of the website. The type can be free form or one of these predefined values: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Currents application. * `other` | AppsPeopleOzExternalMergedpeopleapiWebsite | String | |
| value | AppsPeopleOzExternalMergedpeopleapiWebsite | String | ||
| type | AppsPeopleOzExternalMergedpeopleapiWebsiteRelationshipInfo | String | ||
| channelData | Information about a channel created by the user. A user can create multiple Youtube channels. | AppsPeopleOzExternalMergedpeopleapiYoutubeExtendedData | Extension data for use in Youtube Product Profile. | list(AppsPeopleOzExternalMergedpeopleapiChannelData) |
| failure | Failure type if there is an error when fetching product profile data. | AppsPeopleOzExternalMergedpeopleapiYoutubeExtendedData | Extension data for use in Youtube Product Profile. | AppsPeopleOzExternalMergedpeopleapiProductProfileFailure |
| expressUrlInSettingsResponseSupported | This flag is used to work around a bug in AGSA 6.8 that got away. The bug prevents users from accessing their shopping list if the URL of the shopping list is not a keep.google.com URL. This will happen when switch the backend that stores the shopping list from Keep to a backend maintained by the Google Shopping Express team. | AssistantApiActionV2SupportedFeatures | The features supported by the ActionV2 protocol. Note that after we move on to ConversationProto for all surfaces we can remove this message. | boolean |
| reconnectClientInputSupported | Whether client supports reconnect client input in action v2 payload. This capability is needed to determine if client supports parsing client input payload from actionv2 proto for workflow purposes. See go/personal-workflow. OWNER:nyzstar,vvvemuri. | AssistantApiActionV2SupportedFeatures | The features supported by the ActionV2 protocol. Note that after we move on to ConversationProto for all surfaces we can remove this message. | boolean |
| simpleActionV2PuntSupported | Whether or not the surface supports a simple UnsupportedAction instead of a ModalState punt card for rendering. For ActionV2 punt cards, the ModalState extension on the ResourceSet is the canonical way of building punt cards. However, while most all devices support the ActionV2 protocol, not all devices handle the ModalState rendering as part of the ActionV2. For these devices, we want to build a modified ActionV2 for punt cards which omits this ModalState. At present, this is only Android Wear and should not be used for other devices if they support ModalState or Conversation protocol. | AssistantApiActionV2SupportedFeatures | The features supported by the ActionV2 protocol. Note that after we move on to ConversationProto for all surfaces we can remove this message. | boolean |
| supportedActionType | A list of all the action types supported by the client. These should be the string representation of majel.ActionTypes within “quality/majel/api/proto/action_v2.proto”. | AssistantApiActionV2SupportedFeatures | The features supported by the ActionV2 protocol. Note that after we move on to ConversationProto for all surfaces we can remove this message. | list(String) |
| takeScreenshotSupported | Checks if screenshots can be taken on the client. This field is set on the client from AGSA 7.2 onwards. | AssistantApiActionV2SupportedFeatures | The features supported by the ActionV2 protocol. Note that after we move on to ConversationProto for all surfaces we can remove this message. | boolean |
| voiceDelightImmersiveUiSupported | If IMMERSIVE_ACTIONS UiType is supported by the client. | AssistantApiActionV2SupportedFeatures | The features supported by the ActionV2 protocol. Note that after we move on to ConversationProto for all surfaces we can remove this message. | boolean |
| voiceDelightStickersSupported | If Voice Delight Stickers are supported by the client. In order to support Voice Delight stickers, the client should know how to extract sticker_url from VoiceDelightSystemInteractionSegment. | AssistantApiActionV2SupportedFeatures | The features supported by the ActionV2 protocol. Note that after we move on to ConversationProto for all surfaces we can remove this message. | boolean |
| voiceDelightSuggestionsSupported | If Voice Delight Suggestion Chips are supported by the client. In order to support Voice Delight Suggestion Chips, the client should know how to extract suggestions form VoiceDelightSystemInteraction.ResourceSet. | AssistantApiActionV2SupportedFeatures | The features supported by the ActionV2 protocol. Note that after we move on to ConversationProto for all surfaces we can remove this message. | boolean |
| androidIntentCapability | AssistantApiAndroidIntentCapabilities | Capabilities related to Android intent support. These capabilities can apply to any device on the Android platform. Provides the list of Android package names that support a given Android intent. | list(AssistantApiAndroidIntentCapabilitiesAndroidIntentCapability) | |
| intentActionName | The Action name of the Android Intent in standard notation (https://developer.android.com/reference/android/content/Intent#getAction()). | AssistantApiAndroidIntentCapabilitiesAndroidIntentCapability | String | |
| packageNames | The Android provider packages that support the intent, e.g. “com.google.android.deskclock”. | AssistantApiAndroidIntentCapabilitiesAndroidIntentCapability | list(String) | |
| allowlistedForMediaFulfillment | Indicates whether the provider is compatible for media fulfillment on this surface. For example, Amazon Music isn’t compatible with the driving mode. | AssistantApiAppCapabilities | Used to describe app capabilities of the device installed apps reported to the server. | boolean |
| appIntegrationsSettings | Currently unused. Will be used in the future when integrating with incremental app capabilities. | AssistantApiAppCapabilities | Used to describe app capabilities of the device installed apps reported to the server. | AssistantApiAppIntegrationsSettings |
| disabledSystemApp | This system app is disabled in settings. | AssistantApiAppCapabilities | Used to describe app capabilities of the device installed apps reported to the server. | boolean |
| provider | The installed app of the provider. | AssistantApiAppCapabilities | Used to describe app capabilities of the device installed apps reported to the server. | AssistantApiCoreTypesProvider |
| routableToProviderCloud | This provider has integrated its cloud backend with Google, and Google can route the user queries to the provider’s cloud. | AssistantApiAppCapabilities | Used to describe app capabilities of the device installed apps reported to the server. | boolean |
| searchableOnDevice | This provider has an app that supports on-device search through the provider’s own inventory. | AssistantApiAppCapabilities | Used to describe app capabilities of the device installed apps reported to the server. | boolean |
| searchableOnServer | This provider has integrated its content with Google, and Google has enabled to serve its content as a server-side solution. | AssistantApiAppCapabilities | Used to describe app capabilities of the device installed apps reported to the server. | boolean |
| supports3pPodcastPlayback | Indicates whether the provider supports playback of 3P(externally hosted) podcasts. | AssistantApiAppCapabilities | Used to describe app capabilities of the device installed apps reported to the server. | boolean |
| supportsScreenlessInitiation | This provider has an app that supports starting new media playback when there is no screen (e.g. by integrating with the Bisto SDK). | AssistantApiAppCapabilities | Used to describe app capabilities of the device installed apps reported to the server. | boolean |
| whitelistedForAnnotation | This provider is an app which should be used for query annotations. This is useful for apps which may not be already indexed by Google or are client specific. | AssistantApiAppCapabilities | Used to describe app capabilities of the device installed apps reported to the server. | boolean |
| appIntegrationsSettings | Currently unused. Will be used in the future when integrating with incremental app capabilities. | AssistantApiAppCapabilitiesDelta | Used to describe the incremental change of app capabilities of the device installed apps reported to the server. | AssistantApiAppIntegrationsSettings |
| providerDelta | The installed app of the provider. | AssistantApiAppCapabilitiesDelta | Used to describe the incremental change of app capabilities of the device installed apps reported to the server. | AssistantApiCoreTypesProviderDelta |
| enabled | AssistantApiAppControlSupport | String | ||
| sendMessageSuppressed | If true, disable send message AppControl/SD flow. This is needed to suppress the feature for specific device. If we decide to turn down this feature for all devices, then this field will become obsolete and should be removed. See context in b/275727627. | AssistantApiAppControlSupport | boolean | |
| handleRequestsWithPredictedApps | Whether to enable Assistant to handle request with predicted apps. | AssistantApiAppIntegrationsSettings | Contains the app privacy bits used for App Integrations implicit request. (go/app-privacy-settings-for-implicit-requests) | String |
| plateSupport | Indicates in what cases assistant continued presence can be shown as a plate. This field is white-listed as being PII-free. Please do not add PII here. | AssistantApiAssistantContinuedPresenceSupport | String | |
| environment | AssistantApiAudioInput | These capabilities represent the audio input features associated with the device. This includes what kind of audio input the device can handle, and what the privacy circumstances of that input are. | String | |
| quality | AssistantApiAudioInput | These capabilities represent the audio input features associated with the device. This includes what kind of audio input the device can handle, and what the privacy circumstances of that input are. | String | |
| alwaysOnSpeaker | AssistantApiAudioOutput | These capabilities represent the audio output features associated with the device. This includes what kind of audio output the device can handle, and what the privacy circumstances of that output are. | String | |
| environment | AssistantApiAudioOutput | These capabilities represent the audio output features associated with the device. This includes what kind of audio output the device can handle, and what the privacy circumstances of that output are. | String | |
| mediaTtsMixable | AssistantApiAudioOutput | These capabilities represent the audio output features associated with the device. This includes what kind of audio output the device can handle, and what the privacy circumstances of that output are. | String | |
| quality | AssistantApiAudioOutput | These capabilities represent the audio output features associated with the device. This includes what kind of audio output the device can handle, and what the privacy circumstances of that output are. | String | |
| volumeProperties | AssistantApiAudioOutput | These capabilities represent the audio output features associated with the device. This includes what kind of audio output the device can handle, and what the privacy circumstances of that output are. | AssistantApiVolumeProperties | |
| isBluetoothConnectedProfileRequired | If this surface needs to bluetooth pair a phone before using a feature. | AssistantApiBluetoothCapabilities | Bluetooth capabilities related to usage of a feature. | boolean |
| callFormats | The supported call formats on the surface. | AssistantApiCallCapabilities | CallCapabilities supported by a surface. See go/call-capabilities. Next ID: 7 | list(String) |
| callMediums | The supported call mediums on the surface. | AssistantApiCallCapabilities | CallCapabilities supported by a surface. See go/call-capabilities. Next ID: 7 | list(String) |
| callOptions | The call options this surface can provide. For example, SPEAKERPHONE is available on Android OPA while iOPA doesn’t support it yet. | AssistantApiCallCapabilities | CallCapabilities supported by a surface. See go/call-capabilities. Next ID: 7 | list(String) |
| fallbackToTetheredDeviceAppCapabilities | If true, APP_ID queries initiated by this device should fall back to execution on the tethered device if it’s available and if the primary device cannot perform the action (e.g. due to the app not being installed). | AssistantApiCallCapabilities | CallCapabilities supported by a surface. See go/call-capabilities. Next ID: 7 | boolean |
| supportedRecipientTypes | Should only be checked if nonempty. | AssistantApiCallCapabilities | CallCapabilities supported by a surface. See go/call-capabilities. Next ID: 7 | list(String) |
| supportsDuoEmailEndpoint | AssistantApiCallCapabilities | CallCapabilities supported by a surface. See go/call-capabilities. Next ID: 7 | boolean | |
| faceMatchCapable | Whether the device supports Face Match. | AssistantApiCameraCapabilities | These capabilities represent the camera features associated with the device. | boolean |
| hasCamera | Whether the device has a camera. | AssistantApiCameraCapabilities | These capabilities represent the camera features associated with the device. | boolean |
| hasLimitedCameraStreamCapability | Whether the device has limited camera stream capability. If true, check supported_camera_receivers for detailed supported cameras. | AssistantApiCameraReceiverCapabilities | These capabilities present the capability of the device running camera receiver apps. | boolean |
| supportedCameraReceivers | The camera receiver cast apps the device supports. Only used if has_limited_camera_stream_capability is true. | AssistantApiCameraReceiverCapabilities | These capabilities present the capability of the device running camera receiver apps. | list(AssistantApiCoreTypesCastAppInfo) |
| shouldPuntMultiAssistantMode | Indicates whether the current Assistant should provide a multi Assistant specific punt when there are multiple Auto specific Google Assistants (Android Auto Projected (AAP) and Android Auto Embedded (AAE)) in the same GAS enabled car. This will be used by both AAP and AAE. Design doc: go/doubledash++ | AssistantApiCarAssistantCapabilities | Capabilities that are associated with Assistants on auto surfaces. This is different from other capabilities such as CarSettingsCapabilities, CloudCarCapabilities since they are specific to settings and 3P cloud information. All the auto/car Assistant specific capabilities should live here. | boolean |
| playWarmerWelcome | If true, it indicates that the auto surface client should receive a warmer welcome TTS for signed-out users. For signed-in user, we will rely on server side metadata. go/aaae:preview-lang | AssistantApiCarSettingsCapabilities | Capabilities that are associated with Assistant Settings on auto surfaces. | boolean |
| supportsAddingCars | If true, it indicates that the client can be used to add cars after account linking with the OEM. | AssistantApiCarSettingsCapabilities | Capabilities that are associated with Assistant Settings on auto surfaces. | boolean |
| castLinkingStatus | Cast linking status for ATV surfaces. This is derived from error messages returned from Cast Orchestration Server and will be used for data profiling only(go/katniss-settings-dashboard). | AssistantApiCastAssistantSettingLinkingResult | String | |
| truncatedErrorMsg | The error msg returned from COS, truncated in case it’s too large. | AssistantApiCastAssistantSettingLinkingResult | String | |
| cameraReceiverCapabilities | Whether the device has limited camera stream capability and if yes, which receivers are supported. | AssistantApiCastCapabilities | These capabilities represent capabilities that have to do with casting that pertain to this device. Next ID: 9 | AssistantApiCameraReceiverCapabilities |
| cameraStreamSupportedProtocols | The supported protocols for camera streaming. The value is used as string in go/smarthome-internal-api#camera-stream, so using a string for this field instead of an enum. Supported protocols: (align the definition in go/smarthome-camerastream-trait) – “hls”: HTTP Live Streaming – “dash”: Dynamic Adaptive Streaming over HTTP – “smooth_stream”: Smooth Streaming – “progressive_mp4”: Progressive MP4 (will likely only be used for Clips) – “webrtc”: WebRTC (currently, only H.264 is supported) – “nexustalk”: Internal-only protocol used for Nest | AssistantApiCastCapabilities | These capabilities represent capabilities that have to do with casting that pertain to this device. Next ID: 9 | list(String) |
| canReceiveCast | True if we can cast things to this device. | AssistantApiCastCapabilities | These capabilities represent capabilities that have to do with casting that pertain to this device. Next ID: 9 | boolean |
| deviceId | Optional for primarily cast devices (e.g., Chirp, Chromecast). For devices that are NOT primarily cast devices, but having a cast receiver as secondary functionality, this field SHOULD store the cast-device-id to be used to send remote casting commands to the device. Example: Android TV, which supports both Android-native actions as well as remote casting using its built-in cast receiver. Android TV device id contains a DUSI id, which is not a cast-device-id. When executing a cast command on the Android TV, this field is used to route the cast command (through CloudCastService) to the cast receiver on the device. | AssistantApiCastCapabilities | These capabilities represent capabilities that have to do with casting that pertain to this device. Next ID: 9 | AssistantApiCoreTypesDeviceId |
| dynamicGroupsSupported | Whether this device supports dynamic groups or not. It implies if a Stream Control operation (transfer, expansion, and contraction) could be applied on this device since Stream Control is implemented as part of dynamic groups (ie, adding/removing devices from playback) | AssistantApiCastCapabilities | These capabilities represent capabilities that have to do with casting that pertain to this device. Next ID: 9 | boolean |
| groupType | AssistantApiCastCapabilities | These capabilities represent capabilities that have to do with casting that pertain to this device. Next ID: 9 | String | |
| overlayApplicationsSupported | Whether UI overlay applications are supported on this device. It’s used by Chromecast only. | AssistantApiCastCapabilities | These capabilities represent capabilities that have to do with casting that pertain to this device. Next ID: 9 | boolean |
| yetiGamingSupported | Whether the device supports playing games through Yeti. This is set by the cast device when the device is updated: Chromecast updates -> Chromecast registers its capabilities with CCS -> CCS passes the capabilities to the AssistantSettingsService -> AssistantSettingsService stores the device’s capabilities. go/yeti-gaming-supported-cast-capability | AssistantApiCastCapabilities | These capabilities represent capabilities that have to do with casting that pertain to this device. Next ID: 9 | boolean |
| skipAndroidAndGsaVersionCheck | Additional specific setting capabilities. This boolean is used to indicate whether we want to skip the Android and GSA version check in CheckSettingSchemaAndMaybeGetUris() from assistant/vertical/device/fulfillment/utils/setting_utils.h. Consider setting this field to true if your device is neither Android or GSA (especially when the UserAgent string of your device’s TaskRequest will not contain a valid/up-to-date Android/GSA version). | AssistantApiClientOpPropertiesDeviceModifySettingClientOpProperty | The properties of the client op device.MODIFY_SETTING. This proto is stored in the SupportedClientOp proto. | boolean |
| supportedSettings | Uses DeviceSetting enum which corresponds to setting_id. This indicates which specific settings are supported by client. An empty list implies all settings are supported. | AssistantApiClientOpPropertiesDeviceModifySettingClientOpProperty | The properties of the client op device.MODIFY_SETTING. This proto is stored in the SupportedClientOp proto. | list(String) |
| supportsDoNotDisturbWithDuration | Additional specific setting capabilities. This boolean is used to indicate if do not disturb with duration is supported through device.MODIFY_SETTING clientop on a client or not. | AssistantApiClientOpPropertiesDeviceModifySettingClientOpProperty | The properties of the client op device.MODIFY_SETTING. This proto is stored in the SupportedClientOp proto. | boolean |
| supportsMuteUnmute | Additional specific setting capabilities. This boolean is used to indicate if new unmute logic is enabled on a client or not. | AssistantApiClientOpPropertiesDeviceModifySettingClientOpProperty | The properties of the client op device.MODIFY_SETTING. This proto is stored in the SupportedClientOp proto. | boolean |
| keepsConversationAliveAfterOpeningApp | Whether conversation is kept alive after opening the app. See go/keep-opa-conversation-alive for details. | AssistantApiClientOpPropertiesProviderOpenClientOpProperty | The properties of the provider.OPEN ClientOp. This proto is stored in the SupportedClientOp proto with the key provider.OPEN. | boolean |
| maxSupportedAlarms | Maximum number of alarms that can be created on the client. | AssistantApiClockCapabilities | Used to describe clock capabilities of the device (for example, capabilities related to maximum number of supported alarms and timers that can be created on the device). Fields may be populated by clients or be backfilled by SAL (in case of Timon, for example). | integer |
| maxSupportedExtendedTimerDuration | Maximum extended timer duration supported by the client. The extended timer duration is the total start-to-finish duration after an AddTimeToTimer operation. E.g. if a user sets a timer for 30 minutes, and later adds 10 minutes, the extended duration is 40 minutes. | AssistantApiClockCapabilities | Used to describe clock capabilities of the device (for example, capabilities related to maximum number of supported alarms and timers that can be created on the device). Fields may be populated by clients or be backfilled by SAL (in case of Timon, for example). | AssistantApiDuration |
| maxSupportedTimerDuration | Maximum duration of timers that can be created on the client. | AssistantApiClockCapabilities | Used to describe clock capabilities of the device (for example, capabilities related to maximum number of supported alarms and timers that can be created on the device). Fields may be populated by clients or be backfilled by SAL (in case of Timon, for example). | AssistantApiDuration |
| maxSupportedTimers | Maximum number of timers that can be created on the client. | AssistantApiClockCapabilities | Used to describe clock capabilities of the device (for example, capabilities related to maximum number of supported alarms and timers that can be created on the device). Fields may be populated by clients or be backfilled by SAL (in case of Timon, for example). | integer |
| preferredStopwatchProvider | The preferred provider to use for stopwatch related functionality. | AssistantApiClockCapabilities | Used to describe clock capabilities of the device (for example, capabilities related to maximum number of supported alarms and timers that can be created on the device). Fields may be populated by clients or be backfilled by SAL (in case of Timon, for example). | AssistantApiCoreTypesProvider |
| restrictAlarmsToNext24h | Whether the client restricts alarms to ring within the next 24 hours. | AssistantApiClockCapabilities | Used to describe clock capabilities of the device (for example, capabilities related to maximum number of supported alarms and timers that can be created on the device). Fields may be populated by clients or be backfilled by SAL (in case of Timon, for example). | boolean |
| fluidActionsUiType | AssistantApiCommunicationUiCapabilities | UI capabilities for the surfaces rendering Comms features. See go/rohan-comms-fluid-actions-customization. | String | |
| fallbackToTetheredDevice | If true, contact.LOOKUP should be routed to the tethered device (if present) if the tethered device supports contact.LOOKUP and the primary device does not. | AssistantApiContactLookupCapabilities | boolean | |
| accountType | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | String | |
| activityInfo | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | AssistantApiCoreTypesAndroidAppInfoActivityInfo | |
| androidIntent | Intent associated with the app. We include intents here as different versions of the same app may support different intents. In those cases, the package_name is not enough to identify the app and we should use the combination of package_name and android_intent. This field might contain sensitive data, if represents ClientOp with encapsulated PII such as user query. | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | String |
| appUniqueId | Store the app unique id endpoint. This will be passed over to app to fulfill the action. | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | String |
| appVersion | The android app version. Deprecated because https://developer.android.com/reference/android/content/pm/PackageInfo.html#getLongVersionCode | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | integer |
| dataMimetype | data_mimetype and account_type are the what AGSA uses to filter which contacts support this Android app in ContactProvider. | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | String |
| isBroadcastIntent | If true, client should broadcast the intent instead of open the intent. | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | boolean |
| isDefault | App is the default app for it’s core functionality. For example, it will be true for Android messages if it is the default app to send and receive SMS on the phone. | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | boolean |
| localizedAppName | The localized app name. | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | String |
| longVersionCode | The long android app version. | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | String |
| mimetype | Store mimetype of this endpoint. We will use this as the differentiator for Assistant to know whether to use the RawContact for messaging, call or video call. For example, send message mimetype for whatsapp: “vnd.android.cursor.item/vnd.com.whatsapp.profile” voice call mimetype for whatsapp: “vnd.android.cursor.item/vnd.com.whatsapp.voip.call” | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | String |
| packageName | The android app package of the provider, like “com.spotify.music”. | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | String |
| providerType | The OemProviderType is specific for OEM system Android apps. For example, in Auto Embedded, the OEM will have a system Radio/Media app. The system app’s capabilities/core functionalities are captured here. For physical media sources, the OEM may decide to implement one media app (thus, one package name) that handles multiple physical media sources. For these cases, each physical media source will be sent as different providers even though the package name is the same. | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | String |
| shortcutId | Id of the app’s Android shortcut to be launched by Assistant. The client is expected to use the Android LauncherApps API to execute this shortcut which in turn will open the app. For example, Whatsapp may create an Android shortcut for a frequently messaged contact with an id “contact_123”. This field will contain that id and the client can execute it to open up the chat with that particular contact. If this field is set, the package_name field must also be set since both will be used by the LauncherApps API for execution. If this field is set, the intent related fields will be ignored and not used as a fallback. Design: go/shortcut-id-in-provider-open-clientop This field should only be set for devices with Android API level >= 25 (since that is the version from which the LauncherApps startShortcut API is available) | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | String |
| targetClass | The fully qualified target class name of the provider, like “com.example.myapp.GetOrderService”. | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | String |
| versionName | The android app version name, like “4.1.091.05.40d”, “11.2.7.21.alpha”. Android Docs: https://developer.android.com/reference/android/content/pm/PackageInfo#versionName | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | String |
| activeLaunchableActivities | Activities that are currently active and tagged as ACTION_MAIN and CATEGORY_LAUNCHER. Includes the activity corresponding to android_intent if it falls under CATEGORY_LAUNCHER. | AssistantApiCoreTypesAndroidAppInfoActivityInfo | General information about activities in the app. | list(AssistantApiCoreTypesAndroidAppInfoActivityInfoActivity) |
| localizedActivityName | The localized user visible activity name. | AssistantApiCoreTypesAndroidAppInfoActivityInfoActivity | Information about an individual activity. | String |
| shortClassName | Short class name for activity, following https://developer.android.com/reference/android/content/ComponentName#getShortClassName() | AssistantApiCoreTypesAndroidAppInfoActivityInfoActivity | Information about an individual activity. | String |
| androidAppInfo | The android app information of the provider. Like, Spotify. | AssistantApiCoreTypesAndroidAppInfoDelta | The change of AndroidAppInfo, e.g. app installation or deletion for incremental delta app info upload. | AssistantApiCoreTypesAndroidAppInfo |
| lastUpdateTimestamp | The client-side timestamp in millis when the app is last updated, installed or deleted. | AssistantApiCoreTypesAndroidAppInfoDelta | The change of AndroidAppInfo, e.g. app installation or deletion for incremental delta app info upload. | DateTime |
| updateType | App is installed or deleted. | AssistantApiCoreTypesAndroidAppInfoDelta | The change of AndroidAppInfo, e.g. app installation or deletion for incremental delta app info upload. | String |
| attendees | Attendees invited to the event, usually includes also the organizer. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | list(AssistantApiCoreTypesCalendarEventAttendee) |
| backgroundColor | The background color of the event, in RGB format. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | integer |
| calendarId | Optional calendar containing the event. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | String |
| creator | The person who created this event. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | AssistantApiCoreTypesCalendarEventAttendee |
| description | Optional description of the event (plain text). | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | String |
| end | The end time of the event. Start and end time must either both be date or both be datetime. End is exclusive, ie. the first day / first second when the event is over. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | AssistantApiDateTime |
| eventId | Optional event id provided by assistant server. Needs to be unique, at least on a per-user and calendar level, ideally globally unique. If none is given, the server will assign an id. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | String |
| flairName | The flair name, calculated according to the event title (go/as-cal-flair). With the flair name, background images can be got from gstatic (go/scs): https://ssl.gstatic.com/tmly/f8944938hffheth4ew890ht4i8/flairs/ | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | String |
| foregroundColor | The foreground color of the event, in RGB format. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | integer |
| guestsCanInviteOthers | Whether the guests can invite other guests. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | boolean |
| guestsCanModify | Whether the guests can modify the event. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | boolean |
| guestsCanSeeGuests | Whether the guests of the event can be seen. If false, the user is reported as the only attendee to the event, even though there may be more attendees. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | boolean |
| habitId | Optional id of the Habit (Calendar Goal) this event is linked to | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | String |
| habitStatus | Optional status for this habit event instance. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | String |
| htmlLink | Absolute link to this event in the Calendar web UI. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | String |
| location | Optional location of the event (plain text). | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | String |
| meetingContacts | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | list(AssistantApiCoreTypesCalendarEventMeetingContact) | |
| organizer | The organizer of this event. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | AssistantApiCoreTypesCalendarEventAttendee |
| otherAttendeesExcluded | Whether not all attendees are included in the attendee list. This is set when the attendees list has been truncated (e.g., when the number of attendees is beyond the maxAttendees limitation). | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | boolean |
| participationResponse | The user’s response (the owner of this copy of the event) to this event. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | String |
| recurringEventId | If this is an instance of a recurring event, recurring_event_id identifies the recurring series as a whole. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | String |
| rooms | Meeting rooms associated to this event. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | list(AssistantApiCoreTypesCalendarEventRoom) |
| start | The start time of the event. This event is an all-day event if start has no time_of_day. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | AssistantApiDateTime |
| summary | The title of the event. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | String |
| visibility | Optional visibility of the event. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | String |
| displayName | Display name, present only if available. | AssistantApiCoreTypesCalendarEventAttendee | Next id: 8 | String |
| Email address of the attendee (calendar), for regular events. For +Events, this field is not populated, instead “id” is used. | AssistantApiCoreTypesCalendarEventAttendee | Next id: 8 | String | |
| givenName | Given (first) name, present only if available. This is used for generating meeting titles as given name is preferred over display (full) name (ie: “Jeff : Sundar” is better than “Jeff Dean : Sundar Pichai”). | AssistantApiCoreTypesCalendarEventAttendee | Next id: 8 | String |
| id | Profile ID of the principal, for +Events. For regular events, this field is not populated, instead “email” is used. | AssistantApiCoreTypesCalendarEventAttendee | Next id: 8 | String |
| organizer | Is this the organizer? | AssistantApiCoreTypesCalendarEventAttendee | Next id: 8 | boolean |
| responseStatus | Attendees response status. | AssistantApiCoreTypesCalendarEventAttendee | Next id: 8 | String |
| self | Is this the owner of this copy of the event? | AssistantApiCoreTypesCalendarEventAttendee | Next id: 8 | boolean |
| conferenceId | ID that corresponds to in ConferenceData.conference_id in calendar.common.ConferenceData proto. For Meet, this is the identifier used to join a meeting via URL. | AssistantApiCoreTypesCalendarEventMeetingContact | Next id: 10 | String |
| dialInNumberClasses | AssistantApiCoreTypesCalendarEventMeetingContact | Next id: 10 | list(String) | |
| phoneNumberUri | Default meeting phone number, for example: “tel:+1-475-777-1840” | AssistantApiCoreTypesCalendarEventMeetingContact | Next id: 10 | String |
| pinNumber | A PIN that the participant will need to input after dialing in the conference. | AssistantApiCoreTypesCalendarEventMeetingContact | Next id: 10 | String |
| provider | Provider info for the meeting. | AssistantApiCoreTypesCalendarEventMeetingContact | Next id: 10 | AssistantApiCoreTypesProvider |
| regionCode | The region code for the default meeting phone number | AssistantApiCoreTypesCalendarEventMeetingContact | Next id: 10 | String |
| source | AssistantApiCoreTypesCalendarEventMeetingContact | Next id: 10 | String | |
| universalPinNumber | The universal meeting PIN number for phone numbers in all available countries | AssistantApiCoreTypesCalendarEventMeetingContact | Next id: 10 | String |
| url | URL that can be used to join the meeting. | AssistantApiCoreTypesCalendarEventMeetingContact | Next id: 10 | String |
| Room email that identifies the room and is used to book it. | AssistantApiCoreTypesCalendarEventRoom | A room that is available for a potential meeting or has been booked for a scheduled meeting. Next id: 4 | String | |
| locationDetails | Additional room details. Read-only, populated on request. | AssistantApiCoreTypesCalendarEventRoom | A room that is available for a potential meeting or has been booked for a scheduled meeting. Next id: 4 | AssistantApiCoreTypesCalendarEventRoomRoomLocationDetails |
| name | Room name (ex: “MTV-PR55-5-A-Shadow 5K0 (13) GVC (No external guests)”). | AssistantApiCoreTypesCalendarEventRoom | A room that is available for a potential meeting or has been booked for a scheduled meeting. Next id: 4 | String |
| building | Building where the room is (ex: “PR55”). | AssistantApiCoreTypesCalendarEventRoomRoomLocationDetails | Room location details. Read-only, populated on request. Next id: 8 | String |
| city | City where the room is (ex: “MTV”). | AssistantApiCoreTypesCalendarEventRoomRoomLocationDetails | Room location details. Read-only, populated on request. Next id: 8 | String |
| floor | Floor where the room is (ex: “5”). | AssistantApiCoreTypesCalendarEventRoomRoomLocationDetails | Room location details. Read-only, populated on request. Next id: 8 | String |
| latitude | The latitude in degrees. | AssistantApiCoreTypesCalendarEventRoomRoomLocationDetails | Room location details. Read-only, populated on request. Next id: 8 | float |
| longitude | The longitude in degrees. | AssistantApiCoreTypesCalendarEventRoomRoomLocationDetails | Room location details. Read-only, populated on request. Next id: 8 | float |
| section | Section in the floor (ex: “A”). | AssistantApiCoreTypesCalendarEventRoomRoomLocationDetails | Room location details. Read-only, populated on request. Next id: 8 | String |
| simpleName | Room name (ex: “Shadow 5K0”). | AssistantApiCoreTypesCalendarEventRoomRoomLocationDetails | Room location details. Read-only, populated on request. Next id: 8 | String |
| castAppId | The cast app id. |cast_app_id| is the ID of the cast app used on the current device and |content_app_id| is the ID of the app that provides the actual content. For example, in a group playback, on a follower device, the |cast_app_id| is the follower cast app ID and the |content_app_id| is the leader cast app ID. | AssistantApiCoreTypesCastAppInfo | The cast app information of the provider. | String |
| contentAppId | The id of the cast app that provides the content in a group. The field will always be filled. In the case of a group playback and the current device is a follower, the |cast_app_id| has the ID of the follower app, and |content_app_id| has ID of the actual content app. In all other cases, |content_app_id| and |cast_app_id| will be the same. | AssistantApiCoreTypesCastAppInfo | The cast app information of the provider. | String |
| localizedAppName | The localized app name. | AssistantApiCoreTypesChromeOsAppInfo | The ChromeOS app information of the provider. Next ID: 3 | String |
| packageName | Unique package name that identifies a ChromeOS app of the provider. | AssistantApiCoreTypesChromeOsAppInfo | The ChromeOS app information of the provider. Next ID: 3 | String |
| agentStyle | AssistantApiCoreTypesCloudProviderInfo | The third party provider information. | AssistantApiCoreTypesCloudProviderInfoAgentStyle | |
| directoryUrl | URL to a directory page about the third party agent in Assistant HQ. This is a universal (https) URL that may be handled natively by clients to show HQ or launch to the HQ directory web page. | AssistantApiCoreTypesCloudProviderInfo | The third party provider information. | String |
| logoUrl | The logo url for the third party provider. | AssistantApiCoreTypesCloudProviderInfo | The third party provider information. | String |
| name | The user visible name of the cloud provider, which may be used for example in the chat header during a conversation with the third party. | AssistantApiCoreTypesCloudProviderInfo | The third party provider information. | String |
| backgroundColor | The background color of the agent. Used if no background image is specified for the given display orientation, or if the provided background image does not fit. | AssistantApiCoreTypesCloudProviderInfoAgentStyle | The style customizations for the 3p agent. | AssistantApiCoreTypesColor |
| headerTheme | AssistantApiCoreTypesCloudProviderInfoAgentStyle | The style customizations for the 3p agent. | String | |
| landscapeBackgroundImageUrl | URL for the background image of the agent on landscape display. | AssistantApiCoreTypesCloudProviderInfoAgentStyle | The style customizations for the 3p agent. | String |
| logoUrl | URL for the image containing the 3p logo. This can include logomark and logotype, or logotype only. If present, this can be used in place of the square logo contained in the top level logo_url field in CloudProviderInfo. See go/cards-logo-customization for details on applying this logo. | AssistantApiCoreTypesCloudProviderInfoAgentStyle | The style customizations for the 3p agent. | String |
| maskColor | The color of the mask to apply to the background. See go/aog-cards-background-mask for details on applying this mask. | AssistantApiCoreTypesCloudProviderInfoAgentStyle | The style customizations for the 3p agent. | AssistantApiCoreTypesColor |
| portraitBackgroundImageUrl | URL for the background image of the agent on portrait display. | AssistantApiCoreTypesCloudProviderInfoAgentStyle | The style customizations for the 3p agent. | String |
| primaryColor | The primary color of the agent. Used by the client to style the header and suggestion chips. | AssistantApiCoreTypesCloudProviderInfoAgentStyle | The style customizations for the 3p agent. | AssistantApiCoreTypesColor |
| alpha | The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 – alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. If omitted, this color object is to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0). | AssistantApiCoreTypesColor | Represents a color in the RGBA color space. This message mirrors google.type.Color. | number |
| blue | The amount of blue in the color as a value in the interval [0, 1]. | AssistantApiCoreTypesColor | Represents a color in the RGBA color space. This message mirrors google.type.Color. | number |
| green | The amount of green in the color as a value in the interval [0, 1]. | AssistantApiCoreTypesColor | Represents a color in the RGBA color space. This message mirrors google.type.Color. | number |
| red | The amount of red in the color as a value in the interval [0, 1]. | AssistantApiCoreTypesColor | Represents a color in the RGBA color space. This message mirrors google.type.Color. | number |
| agentId | Pantheon Project ID that uniquely identifies the consumer project ID. Required | AssistantApiCoreTypesDeviceConfig | The identification information for third party devices that integrates with the assistant. All of these fields will be populated by the third party when the query is sent from the third party device. Next Id: 5 | String |
| deviceId | Unique identifier for the device. Example: DBCDW098234. Required | AssistantApiCoreTypesDeviceConfig | The identification information for third party devices that integrates with the assistant. All of these fields will be populated by the third party when the query is sent from the third party device. Next Id: 5 | String |
| agsaClientInstanceId | The client_instance_id on devices with GSA. See ‘client_instance_field’ in go/androidids. | AssistantApiCoreTypesDeviceId | LINT.IfChange(DeviceId) Specifies identifier of a device AKA surface. Note there may be multiple device ids for the same physical device E.g. Allo app and Assistant app on Nexus. Note: DeviceId usage is complicated. Please do not depend on it for surface specific logic. Please use google3/assistant/api/capabilities.proto instead. IMPORTANT: When checking for equality between two `DeviceId`s, you should always use an `isSameDevice{As}` function to check for equality, as deep equality between `DeviceId`’s is not guaranteed. * C++: http://google3/assistant/assistant_server/util/device_id_util.cc;l=23;rcl=421295740 * Dart: http://google3/assistant/context/util/lib/device_id.dart;l=26;rcl=442126145 * Java: http://google3/java/com/google/assistant/assistantserver/utils/DeviceIdHelper.java;l=9;rcl=390378522 See http://go/deviceid-equality for more details. Next ID: 14 | String |
| alloDeviceId | Allo Id. Corresponds to the GBotRequest.Sender.sender. NOTE(dychen): This may change to standard android/ios physical device ids in order to enable shared data (e.g. installed app on physical device shared between Allo and Opa apps on Nexus). | AssistantApiCoreTypesDeviceId | LINT.IfChange(DeviceId) Specifies identifier of a device AKA surface. Note there may be multiple device ids for the same physical device E.g. Allo app and Assistant app on Nexus. Note: DeviceId usage is complicated. Please do not depend on it for surface specific logic. Please use google3/assistant/api/capabilities.proto instead. IMPORTANT: When checking for equality between two `DeviceId`s, you should always use an `isSameDevice{As}` function to check for equality, as deep equality between `DeviceId`’s is not guaranteed. * C++: http://google3/assistant/assistant_server/util/device_id_util.cc;l=23;rcl=421295740 * Dart: http://google3/assistant/context/util/lib/device_id.dart;l=26;rcl=442126145 * Java: http://google3/java/com/google/assistant/assistantserver/utils/DeviceIdHelper.java;l=9;rcl=390378522 See http://go/deviceid-equality for more details. Next ID: 14 | String |
| canonicalDeviceId | A unique device ID for Assistant devices as proposed by go/ocelot-team to solve the device id fragmentation problem. The value of this id is the HomeGraph id of the device. See go/ocelot-track-0-registry-design. New surfaces should use the canonical_device_id instead of using other ids, and the registration should utilize the DeviceDataLayer (go/ddl-v0). Please contact the assistant-state-management@ team for guidance. Note: We didn’t reuse |home_graph_device_id| because in Assistant code base |home_graph_device_id| is common to associate it with 3P devices. See go/project-yellowstone for more context. | AssistantApiCoreTypesDeviceId | LINT.IfChange(DeviceId) Specifies identifier of a device AKA surface. Note there may be multiple device ids for the same physical device E.g. Allo app and Assistant app on Nexus. Note: DeviceId usage is complicated. Please do not depend on it for surface specific logic. Please use google3/assistant/api/capabilities.proto instead. IMPORTANT: When checking for equality between two `DeviceId`s, you should always use an `isSameDevice{As}` function to check for equality, as deep equality between `DeviceId`’s is not guaranteed. * C++: http://google3/assistant/assistant_server/util/device_id_util.cc;l=23;rcl=421295740 * Dart: http://google3/assistant/context/util/lib/device_id.dart;l=26;rcl=442126145 * Java: http://google3/java/com/google/assistant/assistantserver/utils/DeviceIdHelper.java;l=9;rcl=390378522 See http://go/deviceid-equality for more details. Next ID: 14 | String |
| castDeviceId | If set, indicates that the device is a cast device, and contains the UUID of the cast device. Corresponds to the device_id field of the CastDevice proto. | AssistantApiCoreTypesDeviceId | LINT.IfChange(DeviceId) Specifies identifier of a device AKA surface. Note there may be multiple device ids for the same physical device E.g. Allo app and Assistant app on Nexus. Note: DeviceId usage is complicated. Please do not depend on it for surface specific logic. Please use google3/assistant/api/capabilities.proto instead. IMPORTANT: When checking for equality between two `DeviceId`s, you should always use an `isSameDevice{As}` function to check for equality, as deep equality between `DeviceId`’s is not guaranteed. * C++: http://google3/assistant/assistant_server/util/device_id_util.cc;l=23;rcl=421295740 * Dart: http://google3/assistant/context/util/lib/device_id.dart;l=26;rcl=442126145 * Java: http://google3/java/com/google/assistant/assistantserver/utils/DeviceIdHelper.java;l=9;rcl=390378522 See http://go/deviceid-equality for more details. Next ID: 14 | String |
| clientInstanceId | DUSI (go/dusi) is used as the identifier here. This identifier is unique to the user and device. This will help identify which device or application the user’s request originated from. This is not to be confused with the client_instance_id that android devices provide. This is currently used by surfaces that use the assistant-legacy-nexus and assistant-legacy-clockwork pipelines. DUSI is created and set in S3. This field is only filled for GAIA requests. | AssistantApiCoreTypesDeviceId | LINT.IfChange(DeviceId) Specifies identifier of a device AKA surface. Note there may be multiple device ids for the same physical device E.g. Allo app and Assistant app on Nexus. Note: DeviceId usage is complicated. Please do not depend on it for surface specific logic. Please use google3/assistant/api/capabilities.proto instead. IMPORTANT: When checking for equality between two `DeviceId`s, you should always use an `isSameDevice{As}` function to check for equality, as deep equality between `DeviceId`’s is not guaranteed. * C++: http://google3/assistant/assistant_server/util/device_id_util.cc;l=23;rcl=421295740 * Dart: http://google3/assistant/context/util/lib/device_id.dart;l=26;rcl=442126145 * Java: http://google3/java/com/google/assistant/assistantserver/utils/DeviceIdHelper.java;l=9;rcl=390378522 See http://go/deviceid-equality for more details. Next ID: 14 | String |
| connectedDockId | A device ID produced by a connected dock, which is registered in HomeGraph. | AssistantApiCoreTypesDeviceId | LINT.IfChange(DeviceId) Specifies identifier of a device AKA surface. Note there may be multiple device ids for the same physical device E.g. Allo app and Assistant app on Nexus. Note: DeviceId usage is complicated. Please do not depend on it for surface specific logic. Please use google3/assistant/api/capabilities.proto instead. IMPORTANT: When checking for equality between two `DeviceId`s, you should always use an `isSameDevice{As}` function to check for equality, as deep equality between `DeviceId`’s is not guaranteed. * C++: http://google3/assistant/assistant_server/util/device_id_util.cc;l=23;rcl=421295740 * Dart: http://google3/assistant/context/util/lib/device_id.dart;l=26;rcl=442126145 * Java: http://google3/java/com/google/assistant/assistantserver/utils/DeviceIdHelper.java;l=9;rcl=390378522 See http://go/deviceid-equality for more details. Next ID: 14 | String |
| deviceConfig | The unique DeviceConfig to the specific third party device. It is also used by Android Auto Embedded first party device. See go/opa-ids. | AssistantApiCoreTypesDeviceId | LINT.IfChange(DeviceId) Specifies identifier of a device AKA surface. Note there may be multiple device ids for the same physical device E.g. Allo app and Assistant app on Nexus. Note: DeviceId usage is complicated. Please do not depend on it for surface specific logic. Please use google3/assistant/api/capabilities.proto instead. IMPORTANT: When checking for equality between two `DeviceId`s, you should always use an `isSameDevice{As}` function to check for equality, as deep equality between `DeviceId`’s is not guaranteed. * C++: http://google3/assistant/assistant_server/util/device_id_util.cc;l=23;rcl=421295740 * Dart: http://google3/assistant/context/util/lib/device_id.dart;l=26;rcl=442126145 * Java: http://google3/java/com/google/assistant/assistantserver/utils/DeviceIdHelper.java;l=9;rcl=390378522 See http://go/deviceid-equality for more details. Next ID: 14 | AssistantApiCoreTypesDeviceConfig |
| deviceType | DEPRECATED. assistant.api.core_types.governed.SurfaceIdentity.surface_type field should be used instead. The device’s surface type. This is the string version of surface_type. The server should use the SurfaceType value derived from this string. If the device_type isn’t supported within the SurfaceType enum, it will be set as UNKNOWN. Developers should use the enum in ServerParams instead of this string. WARNING: Clients are not actually setting this field. This field will be removed once references to it within the code base have been removed. | AssistantApiCoreTypesDeviceId | LINT.IfChange(DeviceId) Specifies identifier of a device AKA surface. Note there may be multiple device ids for the same physical device E.g. Allo app and Assistant app on Nexus. Note: DeviceId usage is complicated. Please do not depend on it for surface specific logic. Please use google3/assistant/api/capabilities.proto instead. IMPORTANT: When checking for equality between two `DeviceId`s, you should always use an `isSameDevice{As}` function to check for equality, as deep equality between `DeviceId`’s is not guaranteed. * C++: http://google3/assistant/assistant_server/util/device_id_util.cc;l=23;rcl=421295740 * Dart: http://google3/assistant/context/util/lib/device_id.dart;l=26;rcl=442126145 * Java: http://google3/java/com/google/assistant/assistantserver/utils/DeviceIdHelper.java;l=9;rcl=390378522 See http://go/deviceid-equality for more details. Next ID: 14 | String |
| homeGraphDeviceId | The unique device ID for HomeGraph devices. This is the HomeGraph ID, created when the device is registered into HomeGraph. It is immutable for the same device unless it is completely deleted and recreated. See go/home-graph for details. | AssistantApiCoreTypesDeviceId | LINT.IfChange(DeviceId) Specifies identifier of a device AKA surface. Note there may be multiple device ids for the same physical device E.g. Allo app and Assistant app on Nexus. Note: DeviceId usage is complicated. Please do not depend on it for surface specific logic. Please use google3/assistant/api/capabilities.proto instead. IMPORTANT: When checking for equality between two `DeviceId`s, you should always use an `isSameDevice{As}` function to check for equality, as deep equality between `DeviceId`’s is not guaranteed. * C++: http://google3/assistant/assistant_server/util/device_id_util.cc;l=23;rcl=421295740 * Dart: http://google3/assistant/context/util/lib/device_id.dart;l=26;rcl=442126145 * Java: http://google3/java/com/google/assistant/assistantserver/utils/DeviceIdHelper.java;l=9;rcl=390378522 See http://go/deviceid-equality for more details. Next ID: 14 | String |
| libassistantDeviceId | The unique ID for libassistant based devices. See go/libassistant-id for details. | AssistantApiCoreTypesDeviceId | LINT.IfChange(DeviceId) Specifies identifier of a device AKA surface. Note there may be multiple device ids for the same physical device E.g. Allo app and Assistant app on Nexus. Note: DeviceId usage is complicated. Please do not depend on it for surface specific logic. Please use google3/assistant/api/capabilities.proto instead. IMPORTANT: When checking for equality between two `DeviceId`s, you should always use an `isSameDevice{As}` function to check for equality, as deep equality between `DeviceId`’s is not guaranteed. * C++: http://google3/assistant/assistant_server/util/device_id_util.cc;l=23;rcl=421295740 * Dart: http://google3/assistant/context/util/lib/device_id.dart;l=26;rcl=442126145 * Java: http://google3/java/com/google/assistant/assistantserver/utils/DeviceIdHelper.java;l=9;rcl=390378522 See http://go/deviceid-equality for more details. Next ID: 14 | String |
| multiHotwordArbitrationDeviceId | If set, indicates that the device is participating the multi-hotword arbitration and the id is an UUID to distinguish it from other devices. It should also be consistent between requests from a single device within a session (or short duration). | AssistantApiCoreTypesDeviceId | LINT.IfChange(DeviceId) Specifies identifier of a device AKA surface. Note there may be multiple device ids for the same physical device E.g. Allo app and Assistant app on Nexus. Note: DeviceId usage is complicated. Please do not depend on it for surface specific logic. Please use google3/assistant/api/capabilities.proto instead. IMPORTANT: When checking for equality between two `DeviceId`s, you should always use an `isSameDevice{As}` function to check for equality, as deep equality between `DeviceId`’s is not guaranteed. * C++: http://google3/assistant/assistant_server/util/device_id_util.cc;l=23;rcl=421295740 * Dart: http://google3/assistant/context/util/lib/device_id.dart;l=26;rcl=442126145 * Java: http://google3/java/com/google/assistant/assistantserver/utils/DeviceIdHelper.java;l=9;rcl=390378522 See http://go/deviceid-equality for more details. Next ID: 14 | String |
| opaIosDeviceId | The unique device ID for the Assistant App on iOS. See go/opa-ios-design for details. | AssistantApiCoreTypesDeviceId | LINT.IfChange(DeviceId) Specifies identifier of a device AKA surface. Note there may be multiple device ids for the same physical device E.g. Allo app and Assistant app on Nexus. Note: DeviceId usage is complicated. Please do not depend on it for surface specific logic. Please use google3/assistant/api/capabilities.proto instead. IMPORTANT: When checking for equality between two `DeviceId`s, you should always use an `isSameDevice{As}` function to check for equality, as deep equality between `DeviceId`’s is not guaranteed. * C++: http://google3/assistant/assistant_server/util/device_id_util.cc;l=23;rcl=421295740 * Dart: http://google3/assistant/context/util/lib/device_id.dart;l=26;rcl=442126145 * Java: http://google3/java/com/google/assistant/assistantserver/utils/DeviceIdHelper.java;l=9;rcl=390378522 See http://go/deviceid-equality for more details. Next ID: 14 | String |
| quartzDeviceId | The unique ID of a Quartz device. See go/quartz-design-doc for more details. Quartz ID is a hash of (android_id + gaia). | AssistantApiCoreTypesDeviceId | LINT.IfChange(DeviceId) Specifies identifier of a device AKA surface. Note there may be multiple device ids for the same physical device E.g. Allo app and Assistant app on Nexus. Note: DeviceId usage is complicated. Please do not depend on it for surface specific logic. Please use google3/assistant/api/capabilities.proto instead. IMPORTANT: When checking for equality between two `DeviceId`s, you should always use an `isSameDevice{As}` function to check for equality, as deep equality between `DeviceId`’s is not guaranteed. * C++: http://google3/assistant/assistant_server/util/device_id_util.cc;l=23;rcl=421295740 * Dart: http://google3/assistant/context/util/lib/device_id.dart;l=26;rcl=442126145 * Java: http://google3/java/com/google/assistant/assistantserver/utils/DeviceIdHelper.java;l=9;rcl=390378522 See http://go/deviceid-equality for more details. Next ID: 14 | String |
| deviceId | The identifier of the device. | AssistantApiCoreTypesDeviceUserIdentity | The set of information that helps Assistant identify a device-user pair. An example use of this proto is in broadcast reply, when after receiving a broadcast, we store a device-user pair in an attentional entity in order to later infer who initated the broadcast on which device. | AssistantApiCoreTypesDeviceId |
| gaiaId | The identifier of the user. | AssistantApiCoreTypesDeviceUserIdentity | The set of information that helps Assistant identify a device-user pair. An example use of this proto is in broadcast reply, when after receiving a broadcast, we store a device-user pair in an attentional entity in order to later infer who initated the broadcast on which device. | String |
| localizedAppName | The localized app name. | AssistantApiCoreTypesHomeAppInfo | The Home app information of the provider. Next ID: 3 | String |
| packageName | Unique package name that identifies a Home app of the provider. | AssistantApiCoreTypesHomeAppInfo | The Home app information of the provider. Next ID: 3 | String |
| accessibilityText | A text description of the image to be used for accessibility, e.g. screen readers. | AssistantApiCoreTypesImage | An image represents the data about an image or a photo. NextId: 13 | String |
| appIconIdentifier | App identifier. This field is specific to mobile surfaces and stands for app package name for Android surface, and app bundle identifier for iOS. In case identifier is specified but invalid, some default icon will be used, e.g. PackageManager.getDefaultActivityIcon() for Android. If you want to show image for AGSA versions which don’t support this field, you can specify source_url as backup. | AssistantApiCoreTypesImage | An image represents the data about an image or a photo. NextId: 13 | String |
| badgeImage | This is the image that is displayed as the badge on the main image. | AssistantApiCoreTypesImage | An image represents the data about an image or a photo. NextId: 13 | AssistantApiCoreTypesImage |
| content | Content of the image in bytes. | AssistantApiCoreTypesImage | An image represents the data about an image or a photo. NextId: 13 | String |
| height | AssistantApiCoreTypesImage | An image represents the data about an image or a photo. NextId: 13 | integer | |
| imageSource | Indicate the data source where the image is fetched. | AssistantApiCoreTypesImage | An image represents the data about an image or a photo. NextId: 13 | String |
| jsonContent | Content of image in form of JSON representation. | AssistantApiCoreTypesImage | An image represents the data about an image or a photo. NextId: 13 | String |
| letterDrawableText | Text used to generate a letter drawable (a letter icon with color). It will be the default icon if the source_url is empty or cannot be rendered. | AssistantApiCoreTypesImage | An image represents the data about an image or a photo. NextId: 13 | String |
| providerUrl | Url of the image provider, which is the website containing the image. For example, https://www.agentx.com. | AssistantApiCoreTypesImage | An image represents the data about an image or a photo. NextId: 13 | String |
| sourceUrl | The source url of the image. For example, https://www.agentx.com/logo.png | AssistantApiCoreTypesImage | An image represents the data about an image or a photo. NextId: 13 | String |
| sourceUrlType | Type of the source url. | AssistantApiCoreTypesImage | An image represents the data about an image or a photo. NextId: 13 | String |
| width | The width and height of the image in pixels. | AssistantApiCoreTypesImage | An image represents the data about an image or a photo. NextId: 13 | integer |
| type | Specifying which type of internal provider. | AssistantApiCoreTypesInternalProviderInfo | Info for targeting a feature provided directly by the Assistant surface itself. i.e Could be pointing to AGSA audio player for AUDIO_PLAYER on AGSA. | String |
| bundleIdentifier | Bundle identifier that identifies an iOS app of the provider. | AssistantApiCoreTypesIosAppInfo | The iOS app information of the provider. Next ID: 4 | String |
| localizedAppName | The localized app name. | AssistantApiCoreTypesIosAppInfo | The iOS app information of the provider. Next ID: 4 | String |
| openAppUrl | A URL to open the provider’s app. | AssistantApiCoreTypesIosAppInfo | The iOS app information of the provider. Next ID: 4 | String |
| localizedAppName | The localized app name. | AssistantApiCoreTypesKaiOsAppInfo | The KaiOS app information of the provider. Next ID: 4 | String |
| openAppUrl | A URL to open the provider’s app. | AssistantApiCoreTypesKaiOsAppInfo | The KaiOS app information of the provider. Next ID: 4 | String |
| packageName | Unique package name that identifies a KaiOS app of the provider. | AssistantApiCoreTypesKaiOsAppInfo | The KaiOS app information of the provider. Next ID: 4 | String |
| accuracyMeters | The accuracy of the coordinates in meters. | AssistantApiCoreTypesLocationCoordinates | Geographic coordinate information for location. | float |
| latDegrees | Latitude degrees. | AssistantApiCoreTypesLocationCoordinates | Geographic coordinate information for location. | float |
| lngDegrees | Longitude degrees. | AssistantApiCoreTypesLocationCoordinates | Geographic coordinate information for location. | float |
| appName | App name of the message notification, e.g. Hangouts. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | String |
| bundleId | The key used to group this notification into a cluster. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | String |
| dataUri | Uri for the attachment (image, audio, video etc.). | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | String |
| groupName | Name of the group associated with the message notification. This field is set iff this is a group message. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | String |
| groupingKey | The group key of a proactive notification. Details in assistant.api.client_op.NotificationArgs.grouping_key. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | String |
| index | Index of the message notification. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | integer |
| markAsReadActionAvailable | Boolean indicating if the mark_as_read action is available for this message. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | boolean |
| messageLength | Length of the message/notification content in characters. Note: We can’t send the full content because of privacy restriction, preventing sending client content to our backends. Concatenated message_length of all notification_entries. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | integer |
| messageRecipientType | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | String | |
| messageWordCount | Word count of the message | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | integer |
| mimeType | Mime type of the data_uri. e.g. ‘audio/wav’, ‘video/mp4’, ‘image/png’. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | String |
| notificationEntries | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | list(AssistantApiCoreTypesMessageNotificationNotificationEntry) | |
| notificationIconKey | On-device cache key for notification icon. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | String |
| notificationKey | String key of the notification. It is the key from original StatusBarNotification received from Android OS. It is used to identify the original notification to send a reply. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | String |
| opaqueToken | The opaque_token of a proactive notification. Details in assistant.api.client_op.NotificationArgs.opaque_token. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | String |
| packageName | App pkg of the message notification, e.g. “com.google.android.talk”. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | String |
| postTime | Timestamp of the last notification’s post time. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | String |
| replyActionAvailable | Boolean indicating if the reply action is available for this message. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | boolean |
| sender | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | AssistantApiCoreTypesMessageNotificationPerson | |
| senderName | Sender’s name of the message notification, e.g. Elsa. Last sender name in case of a group conversation. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | String |
| audioDuration | Duration of audio message. | AssistantApiCoreTypesMessageNotificationNotificationEntry | Structure of each notification in the MessageNotification Bundle. Attribute sender_name could be different in case of group messages. Next Id: 9 | String |
| charCount | Count of characters in the message body in the notification. | AssistantApiCoreTypesMessageNotificationNotificationEntry | Structure of each notification in the MessageNotification Bundle. Attribute sender_name could be different in case of group messages. Next Id: 9 | integer |
| dataUri | Uri for the attachment (image, audio, video etc.). | AssistantApiCoreTypesMessageNotificationNotificationEntry | Structure of each notification in the MessageNotification Bundle. Attribute sender_name could be different in case of group messages. Next Id: 9 | String |
| messageBody | Note that this is not present in production traffic. Content of the message body in the notification. | AssistantApiCoreTypesMessageNotificationNotificationEntry | Structure of each notification in the MessageNotification Bundle. Attribute sender_name could be different in case of group messages. Next Id: 9 | String |
| mimeType | Mime type of the data_uri. e.g. ‘audio/wav’, ‘video/mp4’, ‘image/png’. | AssistantApiCoreTypesMessageNotificationNotificationEntry | Structure of each notification in the MessageNotification Bundle. Attribute sender_name could be different in case of group messages. Next Id: 9 | String |
| postTime | Timestamp of the notification’s post time. | AssistantApiCoreTypesMessageNotificationNotificationEntry | Structure of each notification in the MessageNotification Bundle. Attribute sender_name could be different in case of group messages. Next Id: 9 | DateTime |
| sender | Sender of the message notification. | AssistantApiCoreTypesMessageNotificationNotificationEntry | Structure of each notification in the MessageNotification Bundle. Attribute sender_name could be different in case of group messages. Next Id: 9 | AssistantApiCoreTypesMessageNotificationPerson |
| wordCount | Count of words in the message body in the notification. | AssistantApiCoreTypesMessageNotificationNotificationEntry | Structure of each notification in the MessageNotification Bundle. Attribute sender_name could be different in case of group messages. Next Id: 9 | integer |
| isImportant | AssistantApiCoreTypesMessageNotificationPerson | Mirrors part of https://developer.android.com/reference/android/app/Person Next Id: 4 | boolean | |
| key | AssistantApiCoreTypesMessageNotificationPerson | Mirrors part of https://developer.android.com/reference/android/app/Person Next Id: 4 | String | |
| name | AssistantApiCoreTypesMessageNotificationPerson | Mirrors part of https://developer.android.com/reference/android/app/Person Next Id: 4 | String | |
| androidAppInfo | The android app information of the provider. | AssistantApiCoreTypesProvider | Provider. Like, Spotify or iHeartRadio. Next ID: 13 | AssistantApiCoreTypesAndroidAppInfo |
| castAppInfo | The cast app information of the provider. | AssistantApiCoreTypesProvider | Provider. Like, Spotify or iHeartRadio. Next ID: 13 | AssistantApiCoreTypesCastAppInfo |
| chromeosAppInfo | The ChromeOS app information of the provider. | AssistantApiCoreTypesProvider | Provider. Like, Spotify or iHeartRadio. Next ID: 13 | AssistantApiCoreTypesChromeOsAppInfo |
| cloudProviderInfo | The third party provider information. | AssistantApiCoreTypesProvider | Provider. Like, Spotify or iHeartRadio. Next ID: 13 | AssistantApiCoreTypesCloudProviderInfo |
| fallbackUrl | A URL to fallback to if app can not be opened. | AssistantApiCoreTypesProvider | Provider. Like, Spotify or iHeartRadio. Next ID: 13 | String |
| homeAppInfo | AssistantApiCoreTypesProvider | Provider. Like, Spotify or iHeartRadio. Next ID: 13 | AssistantApiCoreTypesHomeAppInfo | |
| iconImageUrl | Public URL pointing to an icon image for the provider. e.g. https://lh3.googleusercontent.com/UrY7BAZ-XfXGpfkeWg0zCCeo-7ras4DCoRalC_WXXWTK9q5b0Iw7B0YQMsVxZaNB7DM | AssistantApiCoreTypesProvider | Provider. Like, Spotify or iHeartRadio. Next ID: 13 | String |
| internalProviderInfo | The internal assistant provider information. | AssistantApiCoreTypesProvider | Provider. Like, Spotify or iHeartRadio. Next ID: 13 | AssistantApiCoreTypesInternalProviderInfo |
| iosAppInfo | The iOS app information of the provider. | AssistantApiCoreTypesProvider | Provider. Like, Spotify or iHeartRadio. Next ID: 13 | AssistantApiCoreTypesIosAppInfo |
| kaiosAppInfo | The KaiOS app information of the provider. | AssistantApiCoreTypesProvider | Provider. Like, Spotify or iHeartRadio. Next ID: 13 | AssistantApiCoreTypesKaiOsAppInfo |
| sipProviderInfo | The sip information of the provider. | AssistantApiCoreTypesProvider | Provider. Like, Spotify or iHeartRadio. Next ID: 13 | AssistantApiCoreTypesSipProviderInfo |
| webProviderInfo | The web provider information. | AssistantApiCoreTypesProvider | Provider. Like, Spotify or iHeartRadio. Next ID: 13 | AssistantApiCoreTypesWebProviderInfo |
| androidAppInfoDelta | The android app information of the provider. | AssistantApiCoreTypesProviderDelta | ProviderDelta. The incremental change, e.g. installation or deletion for Spotify or iHeartRadio. Currently it is for Android only. A few considerations for edge cases: – If the app being deleted is not found from Footprints, it is ignored. – For Footprint upload through Geller, the gPRC response is available for client to retry in the next upload if the upload fails. – For Assistant Request, there is no upload status similar to the current AppCapabilities. Next ID: 4 | AssistantApiCoreTypesAndroidAppInfoDelta |
| fallbackUrl | A URL to fallback to if app can not be opened. | AssistantApiCoreTypesProviderDelta | ProviderDelta. The incremental change, e.g. installation or deletion for Spotify or iHeartRadio. Currently it is for Android only. A few considerations for edge cases: – If the app being deleted is not found from Footprints, it is ignored. – For Footprint upload through Geller, the gPRC response is available for client to retry in the next upload if the upload fails. – For Assistant Request, there is no upload status similar to the current AppCapabilities. Next ID: 4 | String |
| iconImageUrl | Public URL pointing to an icon image for the provider. e.g. https://lh3.googleusercontent.com/UrY7BAZ-XfXGpfkeWg0zCCeo-7ras4DCoRalC_WXXWTK9q5b0Iw7B0YQMsVxZaNB7DM | AssistantApiCoreTypesProviderDelta | ProviderDelta. The incremental change, e.g. installation or deletion for Spotify or iHeartRadio. Currently it is for Android only. A few considerations for edge cases: – If the app being deleted is not found from Footprints, it is ignored. – For Footprint upload through Geller, the gPRC response is available for client to retry in the next upload if the upload fails. – For Assistant Request, there is no upload status similar to the current AppCapabilities. Next ID: 4 | String |
| category | The category related with the ringtone. It’s used to generate ringtone related with the category if the entity_mid is not be populated. E.g. for instrument, the ringtone may be piano sound. | AssistantApiCoreTypesRingtoneTaskMetadata | Task metadata information describing the ringtone. Next id: 11 | String |
| characterAlarmMetadata | AssistantApiCoreTypesRingtoneTaskMetadata | Task metadata information describing the ringtone. Next id: 11 | AssistantApiCoreTypesRingtoneTaskMetadataCharacterAlarmMetadata | |
| characterTag | AssistantApiCoreTypesRingtoneTaskMetadata | Task metadata information describing the ringtone. Next id: 11 | String | |
| entityMid | The freebase mid of the entity related to the ringtone. It will be used to generate the ringtone for the alarm or timer (with support for i18n). For instance, for the “cat” mid, the related ringtone will be a cat sound in some language, and for the “Beyonce” mid, the ringtone will be, e.g., a playlist of Beyonce’s best hits. | AssistantApiCoreTypesRingtoneTaskMetadata | Task metadata information describing the ringtone. Next id: 11 | String |
| funtimeMetadata | AssistantApiCoreTypesRingtoneTaskMetadata | Task metadata information describing the ringtone. Next id: 11 | AssistantApiCoreTypesRingtoneTaskMetadataFuntimeMetadata | |
| genMlAlarmMetadata | AssistantApiCoreTypesRingtoneTaskMetadata | Task metadata information describing the ringtone. Next id: 11 | AssistantApiCoreTypesRingtoneTaskMetadataGenMlAlarmMetadata | |
| gentleWakeInfo | Gentle wake information for this alarm. | AssistantApiCoreTypesRingtoneTaskMetadata | Task metadata information describing the ringtone. Next id: 11 | AssistantApiCoreTypesRingtoneTaskMetadataGentleWakeInfo |
| onDeviceAlarmMetadata | AssistantApiCoreTypesRingtoneTaskMetadata | Task metadata information describing the ringtone. Next id: 11 | AssistantApiCoreTypesRingtoneTaskMetadataOnDeviceAlarmMetadata | |
| onDeviceAlarmSound | Will be deprecated. Use OnDeviceAlarmMetadata. | AssistantApiCoreTypesRingtoneTaskMetadata | Task metadata information describing the ringtone. Next id: 11 | String |
| routineAlarmMetadata | AssistantApiCoreTypesRingtoneTaskMetadata | Task metadata information describing the ringtone. Next id: 11 | AssistantApiCoreTypesRingtoneTaskMetadataRoutineAlarmMetadata | |
| agentIds | For character alarm, the media resources are provided through AOG apps. During alarm trigger phase, aog apps with the specified agent_ids are used to get the media resources. Multiple “AoG agents” can satisfy a character_tag. So the user will select the agents they want at alarm creation time. The chosen agents will be recorded so that the resources only from those agents will be used at trigger time. The number of selected agent_ids will not exceed 3. See go/character-alarm-aog. | AssistantApiCoreTypesRingtoneTaskMetadataCharacterAlarmMetadata | list(String) | |
| characterTags | The Character Alarm tag. Tags are needed to identify the theme of the alarm. For example, if the tag is ‘astronaut’, astronaut based audio is played during alarm ring. Note : We have made it repeated so that the user can choose multiple character alarm themes at one go. At present, the user is allowed to choose only one theme during alarm creation. | AssistantApiCoreTypesRingtoneTaskMetadataCharacterAlarmMetadata | list(String) | |
| iconUrls | Icons urls corresponding to a character. Note : We have made it repeated so that we can show different images when the alarm rings. At present, we only support only one image. | AssistantApiCoreTypesRingtoneTaskMetadataCharacterAlarmMetadata | list(String) | |
| agentIds | For FunTime alarms and timers, the media resources are provided through AOG apps during their ringtone. Multiple AoG agents can satisfy a label. So a random agent will be chosen from those that are supplied. See go/funtime-engdesign. | AssistantApiCoreTypesRingtoneTaskMetadataFuntimeMetadata | Used to make timers and alarms more delightful. See go/funtime-engdesign for more details. | list(String) |
| animationBlob | These bytes may represent the blob of the Rive animation that we pass to the Opal App. We will deprecate this field if we figure out a solution to load the animation from the web. | AssistantApiCoreTypesRingtoneTaskMetadataFuntimeMetadata | Used to make timers and alarms more delightful. See go/funtime-engdesign for more details. | String |
| animationUrl | Url for Rive animation that is brought up on ring. Rive is a lightweight animation library that is compatible with Flutter on Opal. See https://rive.app/. | AssistantApiCoreTypesRingtoneTaskMetadataFuntimeMetadata | Used to make timers and alarms more delightful. See go/funtime-engdesign for more details. | String |
| timerHeroUrl | The url used to load the image that is at the center of the timer during timer countdown visuals. | AssistantApiCoreTypesRingtoneTaskMetadataFuntimeMetadata | Used to make timers and alarms more delightful. See go/funtime-engdesign for more details. | String |
| ttsServiceRequestBytes | This is used to call S3 to realize the TTS. Is in the form of bytes because of a circular dependency issue in libassistant protos. It is a serialized proto of type speech.s3.TtsServiceRequest. | AssistantApiCoreTypesRingtoneTaskMetadataFuntimeMetadata | Used to make timers and alarms more delightful. See go/funtime-engdesign for more details. | String |
| isEnabled | AssistantApiCoreTypesRingtoneTaskMetadataGenMlAlarmMetadata | Metadata for machine learning generated audio samples. This will be similar to character alarms, Category will be set MEDIA but this metadata field will be used to identify the ringtone type on surface. (go/magenta-alarm-ringtones). | boolean | |
| ringtoneLabel | Label for the generated ringtone. | AssistantApiCoreTypesRingtoneTaskMetadataGenMlAlarmMetadata | Metadata for machine learning generated audio samples. This will be similar to character alarms, Category will be set MEDIA but this metadata field will be used to identify the ringtone type on surface. (go/magenta-alarm-ringtones). | String |
| effectDurationMs | Specifies how long the effect lasts. Allowed for effect to last after the alarm has started ringing. If unset or negative or 0, effect is assumed to last until alarm trigger time. | AssistantApiCoreTypesRingtoneTaskMetadataGentleWakeInfo | Gentle wake actions like slowly brightening the room/device screen leading up to the alarm firing (go/cube-gentle-wake-up). | String |
| isEnabled | Indicates if gentle wake action is to be performed before this alarm fires. This is enabled only if the device supports sunrise alarm capability. http://cs/symbol:assistant.api.SunriseFeaturesSupport | AssistantApiCoreTypesRingtoneTaskMetadataGentleWakeInfo | Gentle wake actions like slowly brightening the room/device screen leading up to the alarm firing (go/cube-gentle-wake-up). | boolean |
| startTimedeltaMs | Specifies how long before the alarm fire time, the wakeup effect will start. ALWAYS POSITIVE. | AssistantApiCoreTypesRingtoneTaskMetadataGentleWakeInfo | Gentle wake actions like slowly brightening the room/device screen leading up to the alarm firing (go/cube-gentle-wake-up). | String |
| onDeviceAlarmSound | Opal/UI layer will set this bit based on the user selection. | AssistantApiCoreTypesRingtoneTaskMetadataOnDeviceAlarmMetadata | This describes the alarm sound resource enum and the alarm sound label for the on device alarm sound. On-device ringtones are product specific, hence Opal/UI layer will be responsible for populating this metadata at creation/edit. The enum map will be used to convert to an internal resource id used by libassistant for accessing the asset which are not exposed to UI. | String |
| onDeviceAlarmSoundLabel | A string label to identify the alarm sound name. Opal/UI layer will set this as per product definition. This will be used to display the name of the selected ringtone. | AssistantApiCoreTypesRingtoneTaskMetadataOnDeviceAlarmMetadata | This describes the alarm sound resource enum and the alarm sound label for the on device alarm sound. On-device ringtones are product specific, hence Opal/UI layer will be responsible for populating this metadata at creation/edit. The enum map will be used to convert to an internal resource id used by libassistant for accessing the asset which are not exposed to UI. | String |
| ttsServiceRequestBytes | This is used to call S3 to realize the TTS. Is in the form of bytes because of a circular dependency issue in libassistant protos. It is a serialized proto of type speech.s3.TtsServiceRequest. This request will contain an ssml with the url to the ringtone files hosted on gstatic. | AssistantApiCoreTypesRingtoneTaskMetadataOnDeviceAlarmMetadata | This describes the alarm sound resource enum and the alarm sound label for the on device alarm sound. On-device ringtones are product specific, hence Opal/UI layer will be responsible for populating this metadata at creation/edit. The enum map will be used to convert to an internal resource id used by libassistant for accessing the asset which are not exposed to UI. | String |
| routineId | The unique id for each routine. When the alrm is dismissed, it will trigger the routine of the routine alarm’s creator if feasible. | AssistantApiCoreTypesRingtoneTaskMetadataRoutineAlarmMetadata | String | |
| providerId | The providers id (MID) which is the primary identifier for a call provider within the Assistant. A MID, or machine identifier, is a unique identifier issued by Knowledge Graph for all entities contained in it’s graph. | AssistantApiCoreTypesSipProviderInfo | Session Initiation Protocol (SIP) information for providers that use SIP to initiate multimedia communication sessions, like Google Voice and Fi. https://en.wikipedia.org/wiki/Session_Initiation_Protocol | String |
| realm | Calling realm to be use for each call. i.e. For anonymous, this would be set to anonymous.chirp.google.com | AssistantApiCoreTypesSipProviderInfo | Session Initiation Protocol (SIP) information for providers that use SIP to initiate multimedia communication sessions, like Google Voice and Fi. https://en.wikipedia.org/wiki/Session_Initiation_Protocol | String |
| useBirdsongTacl | If true, client should use the Birdsong TaCL API for this call. Uses the VoiceCallManager API by default. For more details: go/birdsong-migration-google-home | AssistantApiCoreTypesSipProviderInfo | Session Initiation Protocol (SIP) information for providers that use SIP to initiate multimedia communication sessions, like Google Voice and Fi. https://en.wikipedia.org/wiki/Session_Initiation_Protocol | boolean |
| deviceId | The identifier of the device. | AssistantApiCoreTypesSurfaceIdentity | The set of information that helps the server identify the surface. This replaces the User-Agent string within the Assistant Server. Note: The SurfaceIdentity proto should only be used to derive the capabilities of a surface. It should not be accessed outside of the CapabilityBuilder or CapabilityChecker. NEXT ID: 6 | AssistantApiCoreTypesDeviceId |
| legacySurfaceType | DEPRECATED: The legacy device’s surface type enum. NOTE: Prefer using the ontological `surface_type` field above. If you need to access the legacy surface type, please file a bug and add it in your code to migrate to ontological surface type. | AssistantApiCoreTypesSurfaceIdentity | The set of information that helps the server identify the surface. This replaces the User-Agent string within the Assistant Server. Note: The SurfaceIdentity proto should only be used to derive the capabilities of a surface. It should not be accessed outside of the CapabilityBuilder or CapabilityChecker. NEXT ID: 6 | String |
| surfaceType | The device’s surface type. The types are defined at google3/assistant/api/core_types/surfaces.gcl. For more details, refer to go/ontologicalize-surface-type. | AssistantApiCoreTypesSurfaceIdentity | The set of information that helps the server identify the surface. This replaces the User-Agent string within the Assistant Server. Note: The SurfaceIdentity proto should only be used to derive the capabilities of a surface. It should not be accessed outside of the CapabilityBuilder or CapabilityChecker. NEXT ID: 6 | String |
| surfaceTypeString | DEPRECATED. The legacy device’s surface type string. NOTE: Prefer using the ontological `surface_type` field. The device’s surface type. This is the string version of the assistant.api.core_types.SurfaceType enum. The server should not use this field, rather it should use the SurfaceType value derived from this string. | AssistantApiCoreTypesSurfaceIdentity | The set of information that helps the server identify the surface. This replaces the User-Agent string within the Assistant Server. Note: The SurfaceIdentity proto should only be used to derive the capabilities of a surface. It should not be accessed outside of the CapabilityBuilder or CapabilityChecker. NEXT ID: 6 | String |
| surfaceVersion | The version of the surface/client. This is different from the Conversation protocol version. | AssistantApiCoreTypesSurfaceIdentity | The set of information that helps the server identify the surface. This replaces the User-Agent string within the Assistant Server. Note: The SurfaceIdentity proto should only be used to derive the capabilities of a surface. It should not be accessed outside of the CapabilityBuilder or CapabilityChecker. NEXT ID: 6 | AssistantApiCoreTypesSurfaceVersion |
| type | AssistantApiCoreTypesSurfaceType | Specifies the types of device surfaces. LINT.IfChange When adding new surface types make sure that My Activity (https://myactivity.google.com/product/assistant) will correctly render by adding your enum to http://cs/symbol:GetAssistSurfaceName%20f:%5C.cc$ If your type doesn’t fit in to any of the existing surfaces messages, add a new message in http://google3/personalization/footprints/boq/uservisible/events/intl/smh_frontend_messages.h. | String | |
| major | AssistantApiCoreTypesSurfaceVersion | The version of the surface/client. New surfaces are encouraged to only use the “major” field to keep track of version number. The “minor” field may be used for surfaces that rely on both the “major” and “minor” fields to define their version. | integer | |
| minor | AssistantApiCoreTypesSurfaceVersion | The version of the surface/client. New surfaces are encouraged to only use the “major” field to keep track of version number. The “minor” field may be used for surfaces that rely on both the “major” and “minor” fields to define their version. | integer | |
| homeStorage | Serialized storage (context) persisted and retrieved for the app and home. | AssistantApiCoreTypesWebProviderInfo | The web information of the provider. Next ID: 5 | String |
| localizedAppName | The localized app name. | AssistantApiCoreTypesWebProviderInfo | The web information of the provider. Next ID: 5 | String |
| openAppUrl | A URL to open the provider’s app. | AssistantApiCoreTypesWebProviderInfo | The web information of the provider. Next ID: 5 | String |
| thirdPartyCustomNluInfo | Info about 3P Custom NLU used in this web provider. TODO(b/321644453) remove when QRewrite is able to call SERoot. | AssistantApiCoreTypesWebProviderInfo | The web information of the provider. Next ID: 5 | AssistantApiCoreTypesWebProviderInfoThirdPartyCustomNluInfo |
| locale | The locale of this agent version, represented by BCP-47 language strings, such as “en”, “en-US”, “fr”, “fr-CA”, “sr-Latn”, “zh-Hans-CN”, etc. | AssistantApiCoreTypesWebProviderInfoThirdPartyCustomNluInfo | String | |
| nluAgentId | Unique internal identifier of 3P Custom NLU agent. UUID. | AssistantApiCoreTypesWebProviderInfoThirdPartyCustomNluInfo | String | |
| nluAgentVersion | Identifies the 3P Custom NLU agent version. | AssistantApiCoreTypesWebProviderInfoThirdPartyCustomNluInfo | String | |
| localConnectivityEnabled | Whether the device has torus/usonia capabililities enabled or not. | AssistantApiCrossDeviceExecutionCapability | boolean | |
| remoteCastMediaEnabled | Whether the device supports cast media originated from a remote device to be executed through local execution and can upload results asynchronously. Needs to be checked before sending remote media initiation through local channel since it needs an async result upload path. | AssistantApiCrossDeviceExecutionCapability | boolean | |
| fallbackToTetheredDevice | If true, data.VALIDATE should be routed to the tethered device (if present) if the tethered device supports data.VALIDATE and the primary device does not. | AssistantApiDataValidateCapabilities | boolean | |
| day | The day, in 1…31. | AssistantApiDate | A Gregorian calendar date. | integer |
| month | The month, in 1…12. | AssistantApiDate | A Gregorian calendar date. | integer |
| year | The year, e.g. 2016. | AssistantApiDate | A Gregorian calendar date. | integer |
| date | A Gregorian calendar date. | AssistantApiDateTime | A date-time specification, combining a date and civil time (relative to a given timezone). | AssistantApiDate |
| timeOfDay | A civil time relative to a timezone. | AssistantApiDateTime | A date-time specification, combining a date and civil time (relative to a given timezone). | AssistantApiTimeOfDay |
| timeZone | A time zone in IANA format. | AssistantApiDateTime | A date-time specification, combining a date and civil time (relative to a given timezone). | AssistantApiTimeZone |
| endDate | End date of the range. | AssistantApiDateTimeRange | A representation of a range of time with start and end datetime specified. | AssistantApiDateTime |
| startDate | Start date of the range. | AssistantApiDateTimeRange | A representation of a range of time with start and end datetime specified. | AssistantApiDateTime |
| movement | These capabilities are scoped to abilities of the device to move around. | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | AssistantApiMovementCapabilities |
| surfaceIdentity | The set of information that helps the server identify the surface. | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | AssistantApiCoreTypesSurfaceIdentity |
| screen | These capabilities are scoped to the ability to see and interact with the Assistant through a screen. If the device has no screen it should send an empty ScreenCapabilities. Sending no ScreenCapabilities will cause this to be overridden with the surface default. | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | AssistantApiScreenCapabilities |
| callCapabilities | The call capabilities of this device. go/call-capabilities | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | AssistantApiCallCapabilities |
| systemNotificationRestrictions | Restrictions related to system-level notifications. This field is superficially similar to ProactiveNotificationOutput, but unlike that field which tracks a per-user preference on the OPA side, this field captures system level notifications restrictions. This field is not stored and is merged to capabilities from conversation params. It exists mostly for logging purposes of android channel state and global app-level notification opt out. | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | AssistantApiSystemNotificationRestrictions |
| sodaCapabilities | Capabilities related to SODA (Speech On-Device API). | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | AssistantApiSodaCapabilities |
| hasVoiceTelephony | Indicates that the device has connection to cellular network that allows it to make voice calls. This is distinct from device just being capable of voice telephony, because the device can be capable yet miss the suitable SIM card (for example, it could miss SIM card altogether, or have data-only SIM card). | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | boolean |
| lensPerceptionCapabilities | Capabilities related to Lens Perception, i.e. image understanding. See go/lens-perception-sdk. | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | AssistantApiLensPerceptionCapabilities |
| cast | These capabilities are scoped to the cast abilities of this device. | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | AssistantApiCastCapabilities |
| deviceId | This is the same device id that is specified in the conversation protocol and should be unique to each device/user/model combination. For example, if a request is coming from a watch through AGSA the watch and AGSA should have different device_ids. Note: this field should only be used to determine which device the capabilities belong to and not to access the id of the device. Instead DeviceProperties should be used and accessed through ParamsAccessor. | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | AssistantApiCoreTypesDeviceId |
| thirdPartyCapabilities | Capabilities related to third party integration. | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | AssistantApiThirdPartyCapabilities |
| androidIntentCapabilities | Capabilites related to Android intent support. | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | AssistantApiAndroidIntentCapabilities |
| camera | These capabilities are scoped to the camera abilities of this device. | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | AssistantApiCameraCapabilities |
| deviceUxMode | Capabilities related to Android tablet UX experience. | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | String |
| assistantCapability | Capabilities if surface supports Google Assistant. | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | String |
| bluetoothCapabilities | Bluetooth capabilities related to usage of a feature. | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | AssistantApiBluetoothCapabilities |
| location | These capabilities are scoped to the location abilities of this device. | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | AssistantApiLocationCapabilities |
| notificationOutputRestrictions | Settings, that reflect whether a specific notification type is allowed for current device, e.g. if the user opted out from notification category or category group. This settings are server-side stored and evaluated unlike SystemNotificationRestrictions field. | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | AssistantApiNotificationOutputRestrictions |
| loggingOnlyData | Data which is produced for logging and debugging. Servers MUST NOT use this for any other purposes, such as branching on it. | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | AssistantApiLoggingOnlyData |
| notificationCapabilities | DEPRECATED: Use SystemNotificationRestrictions instead. Specifies whether the surface is able to display notifications. This field is superficially similar to ProactiveNotificationOutput, but unlike that field which tracks a per-user preference on the OPA side, this field captures whether the surface is capable of displaying notifications. | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | String |
| messageCapabilities | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | AssistantApiMessageCapabilities | |
| audioInput | These capabilities are scoped to the ability to gather audio. It includes information like the type of audio that can be gathered (e.g. public, private). | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | AssistantApiAudioInput |
| contactLookupCapabilities | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | AssistantApiContactLookupCapabilities | |
| outputRestrictions | These are user configured restrictions indicating what the device is allowed to output from the privacy point of view. | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | AssistantApiOutputRestrictions |
| software | These capabilities are scoped to the software available on the device as well as the set of supported Assistant features. | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | AssistantApiSoftwareCapabilities |
| communicationUiCapabilities | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | AssistantApiCommunicationUiCapabilities | |
| carUxRestrictions | UX restrictions for Auto. | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | list(String) |
| audioOutput | These capabilities are scoped to the ability to play audio. It includes information like the type of audio that can be played (e.g. public, private). | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | AssistantApiAudioOutput |
| popOnLockscreenCapability | Capability to support Pop on lockscreen. | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | String |
| dataValidateCapabilities | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | AssistantApiDataValidateCapabilities | |
| surfaceTypeString | DEPRECATED. surface_identity field below already contains this information. The device’s surface type. This is the string version of the assistant.api.core_types.SurfaceType enum. The server should not use this field, rather it should use the SurfaceType value derived from this string. | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | String |
| jwnCapabilities | Indicates if the client supports Javascript Whatsnext (go/jwn). Also contains the Jwn libraries present on the client along with their versions. | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | AssistantApiJwnCapabilities |
| safetyRestrictions | Indicates if the client has safety related restriction. | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | String |
| supportedLocale | Locales supported by assistant settings for speaking and display. This is independent from device language that is defined in device setting. New locales are added based on rollout, whitelist and app version releases because older versions does not have model support. Currently supported locale list differs by surface type. | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | list(String) |
| speechCapabilities | DEPRECATED Capabilities related to speech detection on devices. | AssistantApiDeviceCapabilities | This message describes roughly what a surface is capable of doing and metadata around those capabilities. These capabilities are determined based on: – device hardware – software – status (e.g. volume level, battery percentage) These capabilities refer to the surface and not the physical device. The list of supported surfaces can be found in the assistant.api.core_types.SurfaceType enum. A surface’s capabilities can differ from the device’s. An example would be ANDROID_ALLO running on Pixel. Allo does not support AudioInput while the Pixel does. In this case, audio_input will be set to false for Assistant Allo requests while it might be set to true for OPA_NEXUS requests. Next ID: 37 | AssistantApiSpeechCapabilities |
| nanos | Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive. | AssistantApiDuration | A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like “day” or “month”. It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. | integer |
| seconds | Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. | AssistantApiDuration | A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like “day” or “month”. It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. | String |
| clarificationDataSupported | Whether client supports clarification suggestion chip to be displayed see |assistant.suggestions.ClarificationData| | AssistantApiFeatureSpecificActionSupport | boolean | |
| supportedActivities | A list of fitness activity types supported by this client. | AssistantApiFitnessFeatureSupport | list(String) | |
| stateSyncMethod | Specifies the params proto that Fluid Actions uses to sync state with server. | AssistantApiFluidActionsSupport | String | |
| deviceId | DeviceId of the accessory device (eg. watch) Commonly the go/dusi (eg. client_instance_id) is provided. | AssistantApiGacsCapabilities | Capabilities of Google assistant conversation service(GACS) devices. These capabilites including supported GACS actions and response size limitations. | AssistantApiCoreTypesDeviceId |
| responseConfig | Configuration sent by device. | AssistantApiGacsCapabilities | Capabilities of Google assistant conversation service(GACS) devices. These capabilites including supported GACS actions and response size limitations. | GoogleAssistantAccessoryV1ResponseConfig |
| ttsEncoding | DEPRECATED: Format of TTS audio requested by the device. | AssistantApiGacsCapabilities | Capabilities of Google assistant conversation service(GACS) devices. These capabilites including supported GACS actions and response size limitations. | String |
| gcmRegistrationId | GCM registration id for the device. Used to pass messages to the device. | AssistantApiGcmCapabilities | Capabilities related to GCM. | String |
| supportsAssistantGcm | Assistant supports GCM on the device. ClientOps can be sent to it over GCM and will be executed. | AssistantApiGcmCapabilities | Capabilities related to GCM. | boolean |
| supportsClientInputOverGcm | If it is set to true, then it indicates to server that device is capable of receiving a GCM payload with serialized client input. The client input will be sent back to Assistant Server over conversation protocol. | AssistantApiGcmCapabilities | Capabilities related to GCM. | boolean |
| gestureSensing | Whether Gesture is supported. When false, override the value for tap and omniswipe. | AssistantApiGestureCapabilities | The gesture capabilities related to Selina. Next ID: 4 | boolean |
| omniswipeGestureCapable | Whether omniswipe is supported | AssistantApiGestureCapabilities | The gesture capabilities related to Selina. Next ID: 4 | boolean |
| tapGestureCapable | Whether tap is supported | AssistantApiGestureCapabilities | The gesture capabilities related to Selina. Next ID: 4 | boolean |
| guestAccessOnYoutube | AssistantApiGuestAccessOutput | Access settings for guests. | String | |
| confirmationMessageSupported | Whether the client supports confirmation messages in Immersive Canvas actions. | AssistantApiImmersiveCanvasSupport | boolean | |
| pauseSignalSupported | Whether the client support canvas pause signal. If true, the Assistant Server will send a signal when canvas transitioning to pause mode. | AssistantApiImmersiveCanvasSupport | boolean | |
| librariesVersionMap | The name and version of the jwn libraries currently stored on the client. These are the same that the server communicated when the library was first sent down. | AssistantApiJwnCapabilities | These capabilities are used to determine the jwn libraries and their versions that are present on the client. | map |
| supportedCompressionMode | Compression algorithms supported on the client. Server can choose one of these to compress WhatsNext Javascript programs and libraries. | AssistantApiJwnCapabilities | These capabilities are used to determine the jwn libraries and their versions that are present on the client. | list(String) |
| supportsJwn | Whether the client supports running jwn code. | AssistantApiJwnCapabilities | These capabilities are used to determine the jwn libraries and their versions that are present on the client. | boolean |
| hasLensPerception | Whether the device supports Lens Perception. | AssistantApiLensPerceptionCapabilities | Capabilities related to Lens Perception, i.e. image understanding. See go/loa-lens-device-capabilities. Next ID: 6 | boolean |
| isLensDirectIntentAvailable | Indicates whether Lens supports Lens Direct Intent (go/lensdirectintent). | AssistantApiLensPerceptionCapabilities | Capabilities related to Lens Perception, i.e. image understanding. See go/loa-lens-device-capabilities. Next ID: 6 | boolean |
| isLensLiveViewfinderAvailable | Indicates whether Lens supports Live view-finder experience. | AssistantApiLensPerceptionCapabilities | Capabilities related to Lens Perception, i.e. image understanding. See go/loa-lens-device-capabilities. Next ID: 6 | boolean |
| isLensPostCaptureAvailable | Indicates whether Lens supports Post-capture experience with an image payload. | AssistantApiLensPerceptionCapabilities | Capabilities related to Lens Perception, i.e. image understanding. See go/loa-lens-device-capabilities. Next ID: 6 | boolean |
| lensCapabilities | Contains the capabilities that Lens can support. | AssistantApiLensPerceptionCapabilities | Capabilities related to Lens Perception, i.e. image understanding. See go/loa-lens-device-capabilities. Next ID: 6 | AssistantApiLensPerceptionCapabilitiesLensCapabilities |
| dining | The presence of this message means that Dining is supported. | AssistantApiLensPerceptionCapabilitiesLensCapabilities | The set of capabilities that Lens can support. This is the Assistant proto representation of Lens capabilities defined at j/c/g/android/apps/gsa/search/shared/service/proto/lens_service_event.proto Next ID: 7 | AssistantApiLensPerceptionCapabilitiesLensCapabilitiesDining |
| education | The presence of this message means that Education is supported. | AssistantApiLensPerceptionCapabilitiesLensCapabilities | The set of capabilities that Lens can support. This is the Assistant proto representation of Lens capabilities defined at j/c/g/android/apps/gsa/search/shared/service/proto/lens_service_event.proto Next ID: 7 | AssistantApiLensPerceptionCapabilitiesLensCapabilitiesEducation |
| outdoor | The presence of this message means that Outdoor is supported. | AssistantApiLensPerceptionCapabilitiesLensCapabilities | The set of capabilities that Lens can support. This is the Assistant proto representation of Lens capabilities defined at j/c/g/android/apps/gsa/search/shared/service/proto/lens_service_event.proto Next ID: 7 | AssistantApiLensPerceptionCapabilitiesLensCapabilitiesOutdoor |
| shopping | The presence of this message means that Shopping is supported. | AssistantApiLensPerceptionCapabilitiesLensCapabilities | The set of capabilities that Lens can support. This is the Assistant proto representation of Lens capabilities defined at j/c/g/android/apps/gsa/search/shared/service/proto/lens_service_event.proto Next ID: 7 | AssistantApiLensPerceptionCapabilitiesLensCapabilitiesShopping |
| text | The presence of this message means that intenting directly into the text filter is supported. | AssistantApiLensPerceptionCapabilitiesLensCapabilities | The set of capabilities that Lens can support. This is the Assistant proto representation of Lens capabilities defined at j/c/g/android/apps/gsa/search/shared/service/proto/lens_service_event.proto Next ID: 7 | AssistantApiLensPerceptionCapabilitiesLensCapabilitiesText |
| translate | The presence of this message means that Translation is supported. | AssistantApiLensPerceptionCapabilitiesLensCapabilities | The set of capabilities that Lens can support. This is the Assistant proto representation of Lens capabilities defined at j/c/g/android/apps/gsa/search/shared/service/proto/lens_service_event.proto Next ID: 7 | AssistantApiLensPerceptionCapabilitiesLensCapabilitiesTranslate |
| isTextToSpeechSupported | Indicates whether text-to-speech is supported. | AssistantApiLensPerceptionCapabilitiesLensCapabilitiesText | Text recognition capability. | boolean |
| supportedLanguageTags | The list of language IETF BCP 47 tags that are supported. See the full details in the comment on the equivalent field in: http://google3/java/com/google/android/apps/gsa/search/shared/service/proto/lens_service_event.proto;l=55;rcl=355512559 | AssistantApiLensPerceptionCapabilitiesLensCapabilitiesTranslate | Translation capability. | list(String) |
| channelsByProvider | A list of channel providers each of which provides a list of its channels. | AssistantApiLiveTvChannelCapabilities | list(AssistantApiLiveTvChannelCapabilitiesChannelsByProvider) | |
| channels | A list of channels provided by this input. Keep the performance impact in mind when the number/size of the channels is large. When there are too many channels, consider stripping out some data. | AssistantApiLiveTvChannelCapabilitiesChannelsByProvider | list(AssistantApiLiveTvChannelCapabilitiesLiveTvChannel) | |
| inputId | An identifier to identify the input source. For example for TIF based channels, this will be the TIF input ID to differentiate different tuner apps. See https://source.android.com/devices/tv | AssistantApiLiveTvChannelCapabilitiesChannelsByProvider | String | |
| providerType | Type of provider who provides this channel input. | AssistantApiLiveTvChannelCapabilitiesChannelsByProvider | String | |
| channelId | Unique channel identifier. | AssistantApiLiveTvChannelCapabilitiesLiveTvChannel | String | |
| channelName | A list of channel names and synonyms. | AssistantApiLiveTvChannelCapabilitiesLiveTvChannel | list(String) | |
| channelNumber | Channel number displayed to user. Optional. | AssistantApiLiveTvChannelCapabilitiesLiveTvChannel | String | |
| deeplink | A deep link into the Live player app that tunes to this channel. | AssistantApiLiveTvChannelCapabilitiesLiveTvChannel | String | |
| mid | KG mid of the channel if it exists in KG. | AssistantApiLiveTvChannelCapabilitiesLiveTvChannel | String | |
| networkMid | Network KG mid of the channel if it exists in KG | AssistantApiLiveTvChannelCapabilitiesLiveTvChannel | String | |
| providerInfo | Contains detailed provider information such as android app package name. | AssistantApiLiveTvProvider | AssistantApiCoreTypesProvider | |
| providerKey | A provider enum string for OTT providers. The available key can be found in go/ump-provider-enum For Tuner provider, the provider key would be an ID the tuner app uploaded from TIF. See https://source.android.com/devices/tv | AssistantApiLiveTvProvider | String | |
| providerType | AssistantApiLiveTvProvider | String | ||
| gpsAvailable | AssistantApiLocationCapabilities | boolean | ||
| acpVersion | A user-readable string describing the ACP version (go/acp-version) of the client app used by the user to originate the conversation. | AssistantApiLoggingOnlyData | Data which is produced for logging and debugging. Servers MUST NOT use this for any other purposes, such as branching on it. Next ID: 16 | String |
| androidId | Random identifier assigned to Android mobile devices. Older logs may have previously stored other kinds of android IDs in this field, but all current logs should use the GServices Id. See go/androidids. | AssistantApiLoggingOnlyData | Data which is produced for logging and debugging. Servers MUST NOT use this for any other purposes, such as branching on it. Next ID: 16 | String |
| appVersion | A user-readable string describing the version of the client app used by the user to originate the conversation. | AssistantApiLoggingOnlyData | Data which is produced for logging and debugging. Servers MUST NOT use this for any other purposes, such as branching on it. Next ID: 16 | String |
| assistantSettingsSource | An enum specifying when was this ATV AssistantSettings entry initially created. | AssistantApiLoggingOnlyData | Data which is produced for logging and debugging. Servers MUST NOT use this for any other purposes, such as branching on it. Next ID: 16 | String |
| boardName | The type of board used by manufacturer for this device | AssistantApiLoggingOnlyData | Data which is produced for logging and debugging. Servers MUST NOT use this for any other purposes, such as branching on it. Next ID: 16 | String |
| boardRevision | The revision of board used | AssistantApiLoggingOnlyData | Data which is produced for logging and debugging. Servers MUST NOT use this for any other purposes, such as branching on it. Next ID: 16 | String |
| castAssistantSettingLinkingResult | This field records the linking status between Assistant setting entry and Cast setting entry. Currently only ATV surface populates this field for profiling purpose. | AssistantApiLoggingOnlyData | Data which is produced for logging and debugging. Servers MUST NOT use this for any other purposes, such as branching on it. Next ID: 16 | AssistantApiCastAssistantSettingLinkingResult |
| deviceModel | A user-readable string describing the device’s hardware platform. | AssistantApiLoggingOnlyData | Data which is produced for logging and debugging. Servers MUST NOT use this for any other purposes, such as branching on it. Next ID: 16 | String |
| embedderBuildInfo | Any relevant info concerning the build options of the embedder (that is the software which runs as the ‘driver’ of an Assistant library, such as libassistant. the embedder is typically built by a third party) | AssistantApiLoggingOnlyData | Data which is produced for logging and debugging. Servers MUST NOT use this for any other purposes, such as branching on it. Next ID: 16 | String |
| initialAppVersion | A string recording the app version that is initially used to created this settings entry. | AssistantApiLoggingOnlyData | Data which is produced for logging and debugging. Servers MUST NOT use this for any other purposes, such as branching on it. Next ID: 16 | String |
| isPrimaryUser | Boolean field to indicate whether a certain user is the primary user of a device or not. This is useful for distinguishing the user0 from other users given user0 might have certain privileges (Eg: Hubmode on Tangor) | AssistantApiLoggingOnlyData | Data which is produced for logging and debugging. Servers MUST NOT use this for any other purposes, such as branching on it. Next ID: 16 | boolean |
| mdnsDisplayName | default display name of device over mdns. This is specified at the factory, not specified by the user. | AssistantApiLoggingOnlyData | Data which is produced for logging and debugging. Servers MUST NOT use this for any other purposes, such as branching on it. Next ID: 16 | String |
| platformBuild | A user-readable string describing the device’s software platform. | AssistantApiLoggingOnlyData | Data which is produced for logging and debugging. Servers MUST NOT use this for any other purposes, such as branching on it. Next ID: 16 | String |
| virtualReleaseChannel | A string describing device’s release channel. For cast devices, the string will look like “qa-beta-channel”, “eng-no-update”, etc. | AssistantApiLoggingOnlyData | Data which is produced for logging and debugging. Servers MUST NOT use this for any other purposes, such as branching on it. Next ID: 16 | String |
| skipConfirmationsWhilePlaying | Whether to prevent confirmations (text, tts) for media control actions while media is playing so that the media session is not interrupted. | AssistantApiMediaControlSupport | boolean | |
| fallbackToTetheredDeviceAppCapabilities | If true, APP_ID queries initiated by this device should fall back to execution on the tethered device if it’s available and if the primary device cannot perform the action (e.g. due to the app not being installed). | AssistantApiMessageCapabilities | boolean | |
| preferTargetingPrimaryDevice | For chat_message.SEND targeting, when either the primary or secondary (tethered) device is capable of handling the chat_message.SEND action, prefer targeting it to the primary device. | AssistantApiMessageCapabilities | boolean | |
| supportedRecipientTypes | Should only be checked if nonempty. | AssistantApiMessageCapabilities | list(String) | |
| deviceSettingStatus | The current setting status of message summary on current device. | AssistantApiMessageSummarySupport | LINT.IfChange(messageSummarySupport) | String |
| lastVoiceOptInFlowTimestamp | Last time that voice opt-in flow has been triggered. | AssistantApiMessageSummarySupport | LINT.IfChange(messageSummarySupport) | DateTime |
| readNotificationSummarizationSupported | Whether the client supports message summarization. | AssistantApiMessageSummarySupport | LINT.IfChange(messageSummarySupport) | boolean |
| voiceOptInFlowCounter | The voice consent flow counter on current device. | AssistantApiMessageSummarySupport | LINT.IfChange(messageSummarySupport) | integer |
| mobility | Indicates how much the device moves around. E.g., TV has a low mobility level, while Auto has a very high level. | AssistantApiMovementCapabilities | String | |
| optOutState | AssistantApiNotificationOutputRestrictions | AssistantApiNotificationOutputRestrictionsOptOutState | ||
| categoryGroupState | AssistantApiNotificationOutputRestrictionsOptOutState | Per category/category group notification opt out settings. | list(AssistantApiNotificationOutputRestrictionsOptOutStateCategoryGroupState) | |
| categoryState | AssistantApiNotificationOutputRestrictionsOptOutState | Per category/category group notification opt out settings. | list(AssistantApiNotificationOutputRestrictionsOptOutStateCategoryState) | |
| categoryGroup | AssistantApiNotificationOutputRestrictionsOptOutStateCategoryGroupState | String | ||
| state | AssistantApiNotificationOutputRestrictionsOptOutStateCategoryGroupState | String | ||
| category | AssistantApiNotificationOutputRestrictionsOptOutStateCategoryState | String | ||
| state | AssistantApiNotificationOutputRestrictionsOptOutStateCategoryState | String | ||
| cloudCapability | The OEM Cloud execution capability of this device, containing routing details for cloud fulfillment. | AssistantApiOemCapabilities | Encapsulates the action capabilities of the OEM device. This data is merged from Device Model lookup, per-device registration, and per-request context. This data is sent to NLU layer for query understanding. | AssistantDevicesPlatformProtoCloudCapability |
| cloudDeviceCapabilities | If fulfillment is done via 3P cloud and 3P supports device capabilities, this field will be set. | AssistantApiOemCapabilities | Encapsulates the action capabilities of the OEM device. This data is merged from Device Model lookup, per-device registration, and per-request context. This data is sent to NLU layer for query understanding. | map |
| deviceModelId | Device Model Id from DeviceModelPackage. | AssistantApiOemCapabilities | Encapsulates the action capabilities of the OEM device. This data is merged from Device Model lookup, per-device registration, and per-request context. This data is sent to NLU layer for query understanding. | String |
| deviceModelRevisionId | Device Model Revision Id from DeviceModelPackage. | AssistantApiOemCapabilities | Encapsulates the action capabilities of the OEM device. This data is merged from Device Model lookup, per-device registration, and per-request context. This data is sent to NLU layer for query understanding. | String |
| deviceSpecificData | Opaque supported action data related to a specific domain of devices, for example for car. go/car-talk-registration-model | AssistantApiOemCapabilities | Encapsulates the action capabilities of the OEM device. This data is merged from Device Model lookup, per-device registration, and per-request context. This data is sent to NLU layer for query understanding. | String |
| internalCapability | Internal-only config containing metadata about the Device Model, for example to control the ranking behavior. | AssistantApiOemCapabilities | Encapsulates the action capabilities of the OEM device. This data is merged from Device Model lookup, per-device registration, and per-request context. This data is sent to NLU layer for query understanding. | AssistantDevicesPlatformProtoInternalCapability |
| thirdPartyActionConfig | 3P Action Metadata, populated from the Device Model lookup and the client request parameters. For example, an Assistant SDK request would have the billed project id of the Assistant request added here in order to enable any Device Actions developed using the same Google Cloud project. This data is sent to Service Engine to mask triggering for Device Actions. | AssistantApiOemCapabilities | Encapsulates the action capabilities of the OEM device. This data is merged from Device Model lookup, per-device registration, and per-request context. This data is sent to NLU layer for query understanding. | AssistantApiThirdPartyActionConfig |
| isLocalNetworkArbitrationSupported | Capabilities related to local network arbitration (go/local-network-arbitration). Indicates if the device is capable of being a host device in the LAN whiling doing local network arbitration. | AssistantApiOnDeviceAssistantCapabilities | Definitions of on-device assistant capabilities. | boolean |
| isOnDeviceArbitrationSupported | Capabilities related to on-device arbitration(go/arbitration-on-device). | AssistantApiOnDeviceAssistantCapabilities | Definitions of on-device assistant capabilities. | boolean |
| isOnDeviceAssistantSupported | Indicates if on-device assistant is enabled on this device. Example usecases: NGA (go/nga) or Marble (go/marble). | AssistantApiOnDeviceAssistantCapabilities | Definitions of on-device assistant capabilities. | boolean |
| isOnDeviceUnderstandingSupported | This may be used by NGA. E.g. if understanding happens on device, we can have more aggressive logic when fulfilling some features on the server side, like teleport. | AssistantApiOnDeviceAssistantCapabilities | Definitions of on-device assistant capabilities. | boolean |
| isOnDeviceSmartHomeSupported | Master bit for on-device Smart Home features. | AssistantApiOnDeviceSmartHomeCapabilities | Definitions of on-device Smart Home capabilities. Next ID: 2 | boolean |
| isSupported | Determines if an on-device storage is supported. | AssistantApiOnDeviceStorageCapabilities | The on-device storage capabilities found on the device. | boolean |
| googlePhotoContent | The type of Google Photo content which the device can output. | AssistantApiOutputRestrictions | These are user configurable permissions representing what the device is allowed to output. Next ID: 11 | String |
| guestAccessOutput | Access settings for guests. | AssistantApiOutputRestrictions | These are user configurable permissions representing what the device is allowed to output. Next ID: 11 | AssistantApiGuestAccessOutput |
| personalData | The level of personal data which the device can output. See go/personal-readout for detail. | AssistantApiOutputRestrictions | These are user configurable permissions representing what the device is allowed to output. Next ID: 11 | String |
| proactiveNotificationOutput | This controls if the server can proactively send notification to users, and it does not affect scenarios that users ask for information. The notification may include TTS and lights. It could be only lights for chirp. | AssistantApiOutputRestrictions | These are user configurable permissions representing what the device is allowed to output. Next ID: 11 | String |
| proactiveOutput | Restrictions on displaying and interacting with content on proactive surfaces (e.g. Dragonglass home screen). Note: NEVER access this field of OutputRestrictions directly, use the code in assistant/assistant_server/settings/device/device_settings_util.h instead. | AssistantApiOutputRestrictions | These are user configurable permissions representing what the device is allowed to output. Next ID: 11 | AssistantApiProactiveOutput |
| youtubeAutoplayRestriction | Whether YouTube autoplay is allowed for queries from the user to this device. See go/assistant-youtube-settings for details. | AssistantApiOutputRestrictions | These are user configurable permissions representing what the device is allowed to output. Next ID: 11 | String |
| youtubeContent | The type of YouTube content which the device can output. | AssistantApiOutputRestrictions | These are user configurable permissions representing what the device is allowed to output. Next ID: 11 | String |
| youtubeTvContent | The type of YouTube TV content which the device can output. | AssistantApiOutputRestrictions | These are user configurable permissions representing what the device is allowed to output. Next ID: 11 | String |
| allowAllPersonalData | Allows displaying all personal data on proactive surfaces with no face match capability. | AssistantApiProactiveOutput | Next ID: 7 | boolean |
| androidTvAssistantSettingsSource | For ANDROID_TV devices, the location that this setting was last changed from. Note: this structure allows to extend to more per-vertical bits in the future. | AssistantApiProactiveOutput | Next ID: 7 | String |
| healthAndFitnessProactive | Allows displaying Health and Fitness content on proactive surfaces. This is a sub bit of the device-wide PR bit – the device-wide PR bit must be enabled AND this vertical sub bit must be enabled for H&F content to be shown. This bit will be available on all surfaces that have the proactive-bit enabled. If the proactive-bit is not enabled, then we do not show health and fitness content at all (or even allow access to this setting). | AssistantApiProactiveOutput | Next ID: 7 | String |
| photosProactive | Allows displaying photos content on Dragonglass proactive surfaces. This is a sub bit of the device-wide PR bit – the device-wide PR bit must be enabled AND this vertical sub bit must be enabled for photos content to be shown on Dragonglass surfaces. This bit will be available on all Dragonglass surfaces that have the proactive-bit enabled. If the proactive-bit is not enabled or it’s not a Dragonglass surface, then we do not show proactive photos content at all, nor allow access to this setting. See go/opa-photos-sg-settings for more details. | AssistantApiProactiveOutput | Next ID: 7 | String |
| userMatchProactive | Settings for displaying personal data on proactive surfaces with face match capability. | AssistantApiProactiveOutput | Next ID: 7 | String |
| protobufData | The serialized protocol buffer. | AssistantApiProtobuf | Also known as “Extensions Without Extensions” or “The Poor Man’s Any”, this simple proto is used to transmit arbitrary protocol buffers over the wire. Unlike extensions: – It does not require the proto type to be compiled into the binary. (Useful so that the proto declaration can be inside the conversation package) – It is compatible with all versions of proto, including proto3 and the wack-tastic version used on ChromecastOS. Server libraries for dealing with it live in google3/assistant/protocol/protobuf_lib.h. | String |
| protobufType | The type of the protocol buffer to use. This must be a resolvable name (Namespace.ProtoName) and refer to a proto which is either compiled in to both client and server (e.g. a base proto type) or to one which is part of the conversation package. | AssistantApiProtobuf | Also known as “Extensions Without Extensions” or “The Poor Man’s Any”, this simple proto is used to transmit arbitrary protocol buffers over the wire. Unlike extensions: – It does not require the proto type to be compiled into the binary. (Useful so that the proto declaration can be inside the conversation package) – It is compatible with all versions of proto, including proto3 and the wack-tastic version used on ChromecastOS. Server libraries for dealing with it live in google3/assistant/protocol/protobuf_lib.h. | String |
| begin | The first day of the recurrence. If begin is not set, then the reminder will start infinitely in the past. | AssistantApiRecurrence | Date-based recurrences specify repeating events. Conceptually, a recurrence is a (possibly unbounded) sequence of dates on which an event falls, described by a list of constraints. A date is in a recurrence if and only if it satisfies all of the constraints. Note that devices may support some constraints, but not all. | AssistantApiDate |
| blacklistedRanges | A list of blacklisted dates to skip the alarm on. | AssistantApiRecurrence | Date-based recurrences specify repeating events. Conceptually, a recurrence is a (possibly unbounded) sequence of dates on which an event falls, described by a list of constraints. A date is in a recurrence if and only if it satisfies all of the constraints. Note that devices may support some constraints, but not all. | list(AssistantApiDateTimeRange) |
| dayOfMonth | Specifies the date in a month. For example, if day_of_month is 15, then it represent the 15th day of the specified month. | AssistantApiRecurrence | Date-based recurrences specify repeating events. Conceptually, a recurrence is a (possibly unbounded) sequence of dates on which an event falls, described by a list of constraints. A date is in a recurrence if and only if it satisfies all of the constraints. Note that devices may support some constraints, but not all. | list(integer) |
| dayOfWeek | Specifies a weekly or daily recurrence. Constraint: The date falls on one of these days of the week, in 0…6 (Sunday…Saturday). | AssistantApiRecurrence | Date-based recurrences specify repeating events. Conceptually, a recurrence is a (possibly unbounded) sequence of dates on which an event falls, described by a list of constraints. A date is in a recurrence if and only if it satisfies all of the constraints. Note that devices may support some constraints, but not all. | list(integer) |
| end | The last day of the recurrence. | AssistantApiRecurrence | Date-based recurrences specify repeating events. Conceptually, a recurrence is a (possibly unbounded) sequence of dates on which an event falls, described by a list of constraints. A date is in a recurrence if and only if it satisfies all of the constraints. Note that devices may support some constraints, but not all. | AssistantApiDate |
| every | Multiplier on the frequency of the recurrence. Use this to specify patterns that recur every X days, months, years, etc. Example: [remind me to call mom every 2nd week]. Default is 1 (every day, every month, every year). | AssistantApiRecurrence | Date-based recurrences specify repeating events. Conceptually, a recurrence is a (possibly unbounded) sequence of dates on which an event falls, described by a list of constraints. A date is in a recurrence if and only if it satisfies all of the constraints. Note that devices may support some constraints, but not all. | integer |
| monthOfYear | Specifies the month in a year. Constrain: the month falls on one of these months, in 1, 2, … 12 (January…December). | AssistantApiRecurrence | Date-based recurrences specify repeating events. Conceptually, a recurrence is a (possibly unbounded) sequence of dates on which an event falls, described by a list of constraints. A date is in a recurrence if and only if it satisfies all of the constraints. Note that devices may support some constraints, but not all. | list(integer) |
| numOccurrences | The number of occurrences after which the recurrence should end. | AssistantApiRecurrence | Date-based recurrences specify repeating events. Conceptually, a recurrence is a (possibly unbounded) sequence of dates on which an event falls, described by a list of constraints. A date is in a recurrence if and only if it satisfies all of the constraints. Note that devices may support some constraints, but not all. | integer |
| weekOfMonth | Specifies the index of week in a month. For example, the second Tuesday every month, in this case, week_of_month should be 2. | AssistantApiRecurrence | Date-based recurrences specify repeating events. Conceptually, a recurrence is a (possibly unbounded) sequence of dates on which an event falls, described by a list of constraints. A date is in a recurrence if and only if it satisfies all of the constraints. Note that devices may support some constraints, but not all. | list(integer) |
| enabledExtensions | List of enabled Robin extensions. | AssistantApiRobinCapabilities | Used to describe the capabilities and params of Robin Client. Field will be populated from Client or backfilled in SAL only for Robin client. | list(String) |
| robinStatus | AssistantApiRobinCapabilities | Used to describe the capabilities and params of Robin Client. Field will be populated from Client or backfilled in SAL only for Robin client. | AssistantApiRobinCapabilitiesRobinStatus | |
| supportedRobinOps | List of supported RobinOps. | AssistantApiRobinCapabilities | Used to describe the capabilities and params of Robin Client. Field will be populated from Client or backfilled in SAL only for Robin client. | list(String) |
| available | AssistantApiRobinCapabilitiesRobinStatus | Current Robin status of the client. | AssistantApiRobinCapabilitiesRobinStatusRobinStatusAvailable | |
| notAvailable | AssistantApiRobinCapabilitiesRobinStatus | Current Robin status of the client. | AssistantApiRobinCapabilitiesRobinStatusRobinStatusNotAvailable | |
| optedIn | AssistantApiRobinCapabilitiesRobinStatus | Current Robin status of the client. | AssistantApiRobinCapabilitiesRobinStatusRobinStatusOptedIn | |
| optedOut | AssistantApiRobinCapabilitiesRobinStatus | Current Robin status of the client. | AssistantApiRobinCapabilitiesRobinStatusRobinStatusOptedOut | |
| reasons | AssistantApiRobinCapabilitiesRobinStatusRobinStatusNotAvailable | Robin is not available and can not be enabled by the user. | list(integer) | |
| fontScaleFactor | The scale factor used to convert Scalable Pixel (SP) units to Density-independent Pixel (DP) units (DP = SP * scale factor). Fonts are measured in units of SP, and on some platforms such as Android the SP to DP scale factor can be affected by the font size a user selects in accessibility settings. | AssistantApiScreenCapabilities | These capabilities represent the tactile features associated with the device. This includes, for example, whether the device has a screen, how big the screen is, and privacy of the screen. Next ID: 11 | number |
| inputType | The types of input that this screen supports. Note that this can be empty in which case the screen’s input type is unknown. | AssistantApiScreenCapabilities | These capabilities represent the tactile features associated with the device. This includes, for example, whether the device has a screen, how big the screen is, and privacy of the screen. Next ID: 11 | list(String) |
| mask | Mask defined for this device, if any. | AssistantApiScreenCapabilities | These capabilities represent the tactile features associated with the device. This includes, for example, whether the device has a screen, how big the screen is, and privacy of the screen. Next ID: 11 | AssistantApiScreenCapabilitiesMask |
| protoLayoutTargetedSchema | The targeted schema version for ProtoLayout requests. | AssistantApiScreenCapabilities | These capabilities represent the tactile features associated with the device. This includes, for example, whether the device has a screen, how big the screen is, and privacy of the screen. Next ID: 11 | AssistantApiScreenCapabilitiesProtoLayoutVersion |
| resolution | If this field is absent, the resolution of the screen is unknown. | AssistantApiScreenCapabilities | These capabilities represent the tactile features associated with the device. This includes, for example, whether the device has a screen, how big the screen is, and privacy of the screen. Next ID: 11 | AssistantApiScreenCapabilitiesResolution |
| screenOff | If screen is turned off. | AssistantApiScreenCapabilities | These capabilities represent the tactile features associated with the device. This includes, for example, whether the device has a screen, how big the screen is, and privacy of the screen. Next ID: 11 | boolean |
| screenStateDetection | The ability of the client to correctly report screen state. | AssistantApiScreenCapabilities | These capabilities represent the tactile features associated with the device. This includes, for example, whether the device has a screen, how big the screen is, and privacy of the screen. Next ID: 11 | String |
| supportedRenderingFormat | The primary supported rendering format for display on the device’s screen. This may be used to determine what format of card to be returned when rendering cards. | AssistantApiScreenCapabilities | These capabilities represent the tactile features associated with the device. This includes, for example, whether the device has a screen, how big the screen is, and privacy of the screen. Next ID: 11 | String |
| supportedScreenStates | The screen states that the client supports. The current screen state is specified in DeviceProperties.screen. | AssistantApiScreenCapabilities | These capabilities represent the tactile features associated with the device. This includes, for example, whether the device has a screen, how big the screen is, and privacy of the screen. Next ID: 11 | list(String) |
| visionHelpEnabled | Whether the device enabled vision help features in accessibility settings. The settings is config in Assistant App and on-device settings, and stored in footprints. When enabled, font, color and TTS will be adjusted. | AssistantApiScreenCapabilities | These capabilities represent the tactile features associated with the device. This includes, for example, whether the device has a screen, how big the screen is, and privacy of the screen. Next ID: 11 | boolean |
| type | AssistantApiScreenCapabilitiesMask | A mask applied to the screen’s pixel space to determine regions not visible on the physical device. | String | |
| major | AssistantApiScreenCapabilitiesProtoLayoutVersion | Version info for ProtoLayout requests. | integer | |
| minor | AssistantApiScreenCapabilitiesProtoLayoutVersion | Version info for ProtoLayout requests. | integer | |
| dpi | Dots (pixels) per inch of the screen. | AssistantApiScreenCapabilitiesResolution | A Resolution proto indicates the size of the application window. All fields are required. | integer |
| heightPx | AssistantApiScreenCapabilitiesResolution | A Resolution proto indicates the size of the application window. All fields are required. | integer | |
| mSize | m_size is the smallest square box size to display a capital letter M so that the user can still easily understand it. | AssistantApiScreenCapabilitiesResolution | A Resolution proto indicates the size of the application window. All fields are required. | integer |
| nengSize | neng_size is the smallest square box size to display a letter 螚 (Neng, U+879A) so that the user can easily understand it. (Neng is a visually dense Chinese letter, and so may require a larger box than an M.) | AssistantApiScreenCapabilitiesResolution | A Resolution proto indicates the size of the application window. All fields are required. | integer |
| widthPx | The dimensions of the application window, in pixels. | AssistantApiScreenCapabilitiesResolution | A Resolution proto indicates the size of the application window. All fields are required. | integer |
| gestureCapabilities | A list of gestures that selina supports | AssistantApiSelinaCapabilites | The Soli capabilities on Elaine, including gestures and sleep sensing. go/dingo-dc-software Next ID: 4 | AssistantApiGestureCapabilities |
| selinaSupported | Whether the client supports selina. | AssistantApiSelinaCapabilites | The Soli capabilities on Elaine, including gestures and sleep sensing. go/dingo-dc-software Next ID: 4 | boolean |
| sleepSensingSupported | Whether the client can monitor sleep. This allows us to show sleep CUJ related information: go/TwilightDesign | AssistantApiSelinaCapabilites | The Soli capabilities on Elaine, including gestures and sleep sensing. go/dingo-dc-software Next ID: 4 | boolean |
| anyUserHasSetPersonalPhotos | Whether any user sets personal photos on this device. See go/ambient-setting-in-assistant-design. | AssistantApiSettingsAmbientSettings | boolean | |
| recentHighlightsEnabled | Whether or not the user’s current selection for their ambient photo frame includes the auto-generated “Recent Highlights” album. This is used to determine which users to display the go/opa-photos-memories-tile. See go/opa-photo-memories-imax-optin for more discussion on why this bit was created. | AssistantApiSettingsAmbientSettings | boolean | |
| showPersonalPhotoData | Whether to enable the personal photo data in the ambient settings: https://screenshot.googleplex.com/Wd4OFkQfOyF See go/opa-photos-ambient-location-date-dd#heading=h.5x4iaouuiett for explanation. | AssistantApiSettingsAmbientSettings | boolean | |
| showPersonalPhotos | Whether current user sets personal photos on this device. See go/ambient-setting-in-assistant-design. | AssistantApiSettingsAmbientSettings | boolean | |
| carSettingsCapabilities | Capabilities that are associated with Assistant Settings on auto surfaces. | AssistantApiSettingsAppCapabilities | These capabilities are associated with Assistant Settings on devices. | AssistantApiCarSettingsCapabilities |
| reissueQueryAfterMusicSetup | Whether the client supports reissuing query after setting up in Music Settings. | AssistantApiSettingsAppCapabilities | These capabilities are associated with Assistant Settings on devices. | boolean |
| supportsPaymentsSettingsUpdate | Whether the client supports updating payments setting. | AssistantApiSettingsAppCapabilities | These capabilities are associated with Assistant Settings on devices. | boolean |
| isAutoFramingEnabled | AssistantApiSettingsAutoFramingSettings | Settings pertaining to auto framing. See go/auto-framing-presentation. | boolean | |
| allowIncomingCalls | Whether this device is allowed to receive incoming PSTN calls. | AssistantApiSettingsCarrierCallDeviceSettings | Carrier related call settings on the device. | boolean |
| state | AssistantApiSettingsCommunicationsFilter | Specification of which communication features can be used. | String | |
| schedules | AssistantApiSettingsDeviceDowntimeSettings | Specification of times when most features on a device are disabled for certain users. During these periods, the device will respond to most interactions with something like “sorry, I’m sleeping right now”. Design: go/home-ft-settings-storage PRD: go/home-family-tools-prd | list(AssistantApiSettingsLabeledDowntimeSchedule) | |
| targets | The set of users of this device that will have these downtime settings applied. Must have at least one element. | AssistantApiSettingsDeviceDowntimeSettings | Specification of times when most features on a device are disabled for certain users. During these periods, the device will respond to most interactions with something like “sorry, I’m sleeping right now”. Design: go/home-ft-settings-storage PRD: go/home-family-tools-prd | list(String) |
| enabled | Enables/disables all the filters at the same time. For new devices or non-Cast devices this is always false. | AssistantApiSettingsDeviceFeatureFilters | Defines a set of restrictions on particular device features for a certain set of users. Design: go/home-ft-settings-storage PRD: go/home-family-tools-prd | boolean |
| featureFilters | The filters (feature restrictions) to apply when `enabled` is true. | AssistantApiSettingsDeviceFeatureFilters | Defines a set of restrictions on particular device features for a certain set of users. Design: go/home-ft-settings-storage PRD: go/home-family-tools-prd | AssistantApiSettingsFeatureFilters |
| targets | The set of users of this device that will have these settings applied. Must have at least one element. | AssistantApiSettingsDeviceFeatureFilters | Defines a set of restrictions on particular device features for a certain set of users. Design: go/home-ft-settings-storage PRD: go/home-family-tools-prd | list(String) |
| optInEnabled | Indicates whether the crash logs can be uploaded and the device logs can be enabled | AssistantApiSettingsDeviceLogsOptIn | boolean | |
| voiceEnrollmentStatus | Indicates whether the user’s voice has been successfully enrolled on this device. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| paymentsEnabled | DEPRECATED: Use DeviceCapabilities.OutputRestrictions.personal_data instead. Whether the user has enabled payments for this device. | AssistantApiSettingsDeviceSettings | Next ID: 73 | boolean |
| linkedUsers | Please do NOT use this field without prior approval from PWG. Users who have signed in onto this device, go/linked-users-in-pkg. | AssistantApiSettingsDeviceSettings | Next ID: 73 | list(AssistantApiSettingsLinkedUser) |
| ancillaryDeviceId | The additional device ids. Currently used only for ATV. go/project-yellowstone Note: This field is for internal (Within settings) use only. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsInternalAncillaryDeviceId |
| speakerIdEnabled | Indicates whether the user has enabled speaker-id for this device. See go/google-assistant-multi-user for more info on this project. | AssistantApiSettingsDeviceSettings | Next ID: 73 | boolean |
| faceEnrollmentStatus | Indicates whether the user’s face has been successfully enrolled on this device. See go/face-match-server-design for more info. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| speechSettings | Speech/hotword detection related settings. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsSpeechSettings |
| colocationStatus | Status of colocation. go/co-location-work-v2 Note: this is a cache at the Assistant level. The source of truth is inside CastAuthenticationServer, which is only used for Home devices. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| lastUsedCoarseTimestamp | Coarsened hourly timestamp of when the device was last used. | AssistantApiSettingsDeviceSettings | Next ID: 73 | DateTime |
| supervisionSettings | Restrictions on how and when certain users can use a device. See go/home-ft-prd. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsDeviceSupervisionSettings |
| postalCode | AssistantApiSettingsDeviceSettings | Next ID: 73 | String | |
| humanFriendlyName | The human-friendly name of the cast device, e.g., my living room tv. This field is set by the user and already localized. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| homeGraphData | Holds the data that should be written to HomeGraph. Note: this field is not persisted in Assistant Settings storage. It is simply used for transporting data when client calls UpdateSettings. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsHomeGraphData |
| blueSteelEnabled | Indicates whether the user has enabled Blue Steel. See go/blue-steel for more info on this project. | AssistantApiSettingsDeviceSettings | Next ID: 73 | boolean |
| locationFeature | The feature proto of the location of the device. Note: client does not need to populate this. It will be auto-populated based on “address” field on server side. Currently, only “bound” and “type” are persisted, since the entire FeatureProto is too big. | AssistantApiSettingsDeviceSettings | Next ID: 73 | GeostoreFeatureProto |
| defaultAudioDeviceId | The identification of the default device which user want to output audio. See go/default-media-output-design for more info. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiCoreTypesDeviceId |
| speechOutputSettings | Settings related to TTS output. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsSpeechOutputSettings |
| oauthClientId | OAuth client id for the device. This field is available for Assistant SDK devices. It is written when the device is registered to the user (AssistantSettingsUiService.LinkAssistantDeviceUi). When user revokes grant on the Assistant device, Assistant Devices Platform Service will receive Pubsub notification with OAuth client id for the revoked device, and we will compare that with this stored id to identity device to remove. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| marketplaceDisclosure | See go/marketplace-disclosure for more info. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsMarketplaceDisclosure |
| locale | The locale for the device: language + region, i.e., en-US, ja-JP. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| linkedDeviceId | Stores pairing between different devices. See go/quartz-design-doc for more info. | AssistantApiSettingsDeviceSettings | Next ID: 73 | list(AssistantApiCoreTypesDeviceId) |
| deviceModelId | The model ID of the device. This should be globally unique across manufactures/OEMs. Examples: “nest_cam_iq_2017”, “comcast_voice_box_2017”. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| verboseTtsForChromecastEnabled | Indicates whether to play verbose tts for Elementary on chirp. See: go/opa-cast-a11y-impl-design fore more info on this project. Note: this should probably be in SpeechOutputSetting below. | AssistantApiSettingsDeviceSettings | Next ID: 73 | boolean |
| shortenedAddress | A human-readable shortened address. This is usually the street address. Note: client does not need to populate this. It will be auto-populated based on “address” field on server side. Developers can use this field to avoid reading out the full address everytime. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| deviceBrand | The brand of the device, populated from DeviceOemParams. Examples: “google”, “samsung”. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| creationTimestampMs | The timestamp that the device is linked with the user in milliseconds. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| deviceId | The identification of the device. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiCoreTypesDeviceId |
| faceEnrollmentErrors | List of errors that happened during the face enrollment process if it failed. See go/face-match-enrollment-error for more info. | AssistantApiSettingsDeviceSettings | Next ID: 73 | list(String) |
| faceMatchEnabled | Indicates whether the user has enabled Face Match for this device. See go/face-match-server-design for more info on this project. | AssistantApiSettingsDeviceSettings | Next ID: 73 | boolean |
| locationCoordinates | Coordinate information of the device location. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiCoreTypesLocationCoordinates |
| allowIncomingCalls | Whether this device is allowed to receive incoming calls. | AssistantApiSettingsDeviceSettings | Next ID: 73 | boolean |
| isCloudSyncDevice | Indicates whether the device is also managed through HA cloud sync. go/ha-dev-guide | AssistantApiSettingsDeviceSettings | Next ID: 73 | boolean |
| politeMode | Specify whether polite mode is enabled for this device. See go/pretty-please-dd. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsPoliteMode |
| hotwordThresholdAdjustmentFactor | HotwordThresholdAdjustmentFactor contains threshold_adjustment_factor, and it’s validity. TAF is a measure of adjustment applied to the hotword threshold as a result of go/autotune. Currently, this is updated from query_settings_frame, but if we move to updating it from the client, this could also contain TAFs as a result of Hotword Sensitivity, in addition to Autotune. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsHotwordThresholdAdjustmentFactor |
| autoFramingSettings | Auto framing settings associated with a device. See go/auto-framing-presentation. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsAutoFramingSettings |
| onDeviceAppSettings | Device specific app related settings. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsOnDeviceAppSettings |
| kidsMode | Specifies if kids-mode is enabled for the device. See go/aff-parentalsupervision-dd. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsKidsMode |
| gcmSettings | Stores GCM info associated with a device. See go/quartz-design-doc for more info. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsGcmSettings |
| tetheredInfo | Presence indicates a tethered wearable. go/wearable-device-ids. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsTetheredInfo |
| hotwordSensitivity | The level of hotword sensitivity. go/hotword-sensitivity-prd | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| reauthTrustedDeviceSettings | Trusted device preferences Assistant reauth. go/assistant-reauth-verify-skip. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsReauthTrustedDeviceSettings |
| ambientSettings | Ambient settings contains the configuration of Photo Frame on DG device. This field relies on IMAX service to do the update, sync happenes after user updates IMAX device settings or a device registers in CloudCastDevice. So it’s more like a cached version instead of definitive source-of-truth. More details at go/ambient-setting-in-assistant-design. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsAmbientSettings |
| hospitalityModeStatus | Indicates whether the device is currently in Hospitality mode. go/hospitality-mode-design. This is moved to a per user setting in assistant settings. ref. go/hospitality-settings-v2 | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsHospitalityMode |
| masqueradeMode | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsMasqueradeMode | |
| personalizationMetadata | Metadata about how personalization settings were configured. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsPersonalizationMetadata |
| defaultVideoDeviceId | The identification of the default device which user want to output video. Note that, we don’t fallback to this for audio playback when default_audio_device_id is not set. See go/default-media-output-design for more info. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiCoreTypesDeviceId |
| optInStatus | Specifies if device logs and crashes can be captured during SendFeedback | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsDeviceLogsOptIn |
| surfaceType | The type of assistant surface. Only use this field when device type is ASSISTANT. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiCoreTypesSurfaceType |
| truncatedLocalNetworkId | Local network ID of the device (truncated to obfuscate devices and households globally). This is a temporary signal to determine proximity of Assistant devices in a house (HGS place). | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| vmLastUsedCoarseTimestamp | Coarsened hourly timestamp of when the user was last verified by VoiceMatch on this device. This is used for enforcing VoiceMatch model TTL. go/voicematch-pdd-ttl | AssistantApiSettingsDeviceSettings | Next ID: 73 | DateTime |
| ackStatus | LINT.ThenChange(//depot/google3/assistant/ui/assistant_device_settings_ui.proto) | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| deviceModelRevision | The Device Platform Service lookup revision. (go/device-model-revision) For 1p devices, and most 3p devices with no custom feature, this should be always 0, which means no lookup needed. For 3p devices with custom assistant feature, this is provided directly by OEM as incremental (e.g. 1, 2, 3, …) | AssistantApiSettingsDeviceSettings | Next ID: 73 | integer |
| notificationProfile | Information about how to send the user a notification. This won’t be populated for fb-conv users (allo group chat users). | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsNotificationProfile |
| voiceInputEnabled | A boolean indicates whether voice input (mic-button, hotword, etc) is enabled. | AssistantApiSettingsDeviceSettings | Next ID: 73 | boolean |
| city | city and postal_code are sent to third party AoG Apps as location when permission is granted for precise or coarse location. https://developers.google.com/actions/reference/rest/Shared.Types/Permission city and postal_code have the same description as in Proto Postal Address: https://cs.corp.google.com/piper///depot/google3/location/country/postaladdress.proto city corresponds to locality_name, postal_code corresponds to postal_code_number. These two fields are set in assistant_settings_service by AddressConverter. https://cs.corp.google.com/piper///depot/google3/location/addressformatter/public/addressconverter.h See go/aog-i18n-address-parse for more information | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| dusi | Only valid for ATV. Stores the android DUSI for the corresponding user. More details: go/auto-logout-on-unlink. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| timeZone | Device time zone. It’s mainly used for a one-time notification for new users when they just bought and activated their devices. They may not have used Search or Assistant before, so their timezone info may not available elsewhere when we want to send a notification. This should be used as a fallback only when other timezone sources such as assistant_settings:user_attribute#inferred_user_timezone are not available. Also, when both |time_zone| and |location| are set, the |location| should be preferred to derive the most up to date timezone. This info directly comes from the device through early device setting recording mechanism. See more details at go/early-device-setting-recording. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiTimeZone |
| lastCastRegistrationTimestamp | Device’s latest registration timestamp provided by Cast side. This field is not necessarily up to date. The update frequency is defined in last_registration_update_frequency_in_days field of AssistantConfig in java/com/google/chrome/dongle/common/proto/home_assistant_config.proto. go/cast-last-registration-time | AssistantApiSettingsDeviceSettings | Next ID: 73 | DateTime |
| crossSurfaceAvailability | Availability of this device for Assistant Cross-surface handoffs. (go/assistant-cross-surface) | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsDeviceSettingsCrossSurfaceAvailability |
| type | The type of the device. Note: this should only be used for grouping devices for UI presentation purpose. Use |capabilities| to decide what the device can do. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| aliasName | The alias names of the device, e.g. my living room tv, tv, living room and etc., which user will usually use to refer to the device in addition to human_friendly_name. It can help speech biasing and query understanding. This field is set by the user and already localized. | AssistantApiSettingsDeviceSettings | Next ID: 73 | list(String) |
| homeGraphId | The home graph ID that can be used to lookup the corresponding entry in HomeGraph. go/home-graph. Note: when this field is empty, it doesn’t necessarily mean that the device is not in home graph. It just means that Assistant doesn’t know about the mapping. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| address | A human-readable address string for the location; generally a one-line address such as “34 Masonic Ave, San Francisco CA 94117, United States”. Set this field to empty string for deletion, in which case the rest of the location related fields below will be cleared as well. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| internalVersion | Internal version of the DeviceSettings for measurement of the DeviceSettings mutation race conditions. See go/consistent-assistant-settings-update. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsInternalVersion |
| isDeviceActivationCacheEnabled | When true, the user has explicitly allowed audio and visual data collection on this device | AssistantApiSettingsDeviceSettings | Next ID: 73 | boolean |
| capabilities | Describes roughly what a device is capable of doing and metadata around those capabilities. Note: this includes device limitations as well as user configurable settings. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiDeviceCapabilities |
| lastKnownClientLocale | Last known locale of the client. | AssistantApiSettingsDeviceSettingsCrossSurfaceAvailability | String | |
| lastParamsWriteTimestamp | This is the timestamp when the AssistantRequestParams (in ASSISTANT_SNAPSHOT corpus) were last written for this device. | AssistantApiSettingsDeviceSettingsCrossSurfaceAvailability | DateTime | |
| downtimeSettings | Specification of times that a device shouldn’t respond to certain users. See go/home-ft-prd. | AssistantApiSettingsDeviceSupervisionSettings | AssistantApiSettingsDeviceDowntimeSettings | |
| featureFilters | Restrictions on features that certain users can access on a device. See go/home-ft-prd. | AssistantApiSettingsDeviceSupervisionSettings | AssistantApiSettingsDeviceFeatureFilters | |
| enabled | True if downtime should be enabled during this period. | AssistantApiSettingsDowntimePeriod | Specifies a period of up to 24 hours when downtime should be enabled, starting at certain time on a certain day of the week, and ending at a later time on either that day or the following day. | boolean |
| endTime | Time of day that this downtime period should end. Required. If end_time > start_time, end_time is relative to start_day. Otherwise, end_time is relative to the day after start_day. For example, start_day: MONDAY, start_time: 9 p.m., end_time: 6 a.m. means that the downtime period starts at 9 p.m. on Monday and ends at 6 a.m. on Tuesday. | AssistantApiSettingsDowntimePeriod | Specifies a period of up to 24 hours when downtime should be enabled, starting at certain time on a certain day of the week, and ending at a later time on either that day or the following day. | GoogleTypeTimeOfDay |
| startDay | The day of the week when this downtime period starts. Required. | AssistantApiSettingsDowntimePeriod | Specifies a period of up to 24 hours when downtime should be enabled, starting at certain time on a certain day of the week, and ending at a later time on either that day or the following day. | String |
| startTime | Time of day that this downtime period should start. Required. | AssistantApiSettingsDowntimePeriod | Specifies a period of up to 24 hours when downtime should be enabled, starting at certain time on a certain day of the week, and ending at a later time on either that day or the following day. | GoogleTypeTimeOfDay |
| enabled | True if this downtime schedule should be enabled. | AssistantApiSettingsDowntimeSchedule | Specification of when downtime is enabled on different days of the week. Contains up to 7 DowntimePeriod messages, up to one per day of the week. | boolean |
| periods | Downtime entries for the days of the week, in no particular order. There can be at most one period defined for each day of the week. Days of the week with no explicit period defined are treated as disabled, so the device is available all day (modulo an end time that may spill over from the previous day). | AssistantApiSettingsDowntimeSchedule | Specification of when downtime is enabled on different days of the week. Contains up to 7 DowntimePeriod messages, up to one per day of the week. | list(AssistantApiSettingsDowntimePeriod) |
| allowKnockKnock | True if Duo Knock Kncok feature is enabled on the device. | AssistantApiSettingsDuoCallDeviceSettings | Duo related call settings on the device. Next ID: 5 | boolean |
| shouldBeLinked | Boolean indicating if user has explicitly marked this device to be linked or not. This bit is used in case where unexpected errors occur and we have to check for account/device status and mark the device linked after verification. | AssistantApiSettingsDuoCallDeviceSettings | Duo related call settings on the device. Next ID: 5 | boolean |
| state | The call state of the device (i.e. whether a Duo call account has been setup on the device). | AssistantApiSettingsDuoCallDeviceSettings | Duo related call settings on the device. Next ID: 5 | String |
| talkbackEnabled | Client device settings: settings which are populated by client to give to duocore. TalkBack is an accessibility service that helps blind and vision-impaired users interact with their devices. Indicates whether talkback is enabled for the device. Note: this is per device settings currently filled by client for all users. | AssistantApiSettingsDuoCallDeviceSettings | Duo related call settings on the device. Next ID: 5 | boolean |
| communicationsFilter | AssistantApiSettingsFeatureFilters | Specification of which assistant features are allowed for a particular device or user account. | AssistantApiSettingsCommunicationsFilter | |
| musicFilter | AssistantApiSettingsFeatureFilters | Specification of which assistant features are allowed for a particular device or user account. | AssistantApiSettingsMusicFilter | |
| newsFilter | AssistantApiSettingsFeatureFilters | Specification of which assistant features are allowed for a particular device or user account. | AssistantApiSettingsNewsFilter | |
| podcastFilter | AssistantApiSettingsFeatureFilters | Specification of which assistant features are allowed for a particular device or user account. | AssistantApiSettingsPodcastFilter | |
| searchFilter | AssistantApiSettingsFeatureFilters | Specification of which assistant features are allowed for a particular device or user account. | AssistantApiSettingsSearchFilter | |
| thirdPartyAppsFilter | AssistantApiSettingsFeatureFilters | Specification of which assistant features are allowed for a particular device or user account. | AssistantApiSettingsThirdPartyAppsFilter | |
| videoFilter | AssistantApiSettingsFeatureFilters | Specification of which assistant features are allowed for a particular device or user account. | AssistantApiSettingsVideoFilter | |
| webviewFilter | AssistantApiSettingsFeatureFilters | Specification of which assistant features are allowed for a particular device or user account. | AssistantApiSettingsWebviewFilter | |
| gcmId | AssistantApiSettingsGcmSettings | String | ||
| gcmPackage | AssistantApiSettingsGcmSettings | String | ||
| agentId | Agent ID, aka project ID. Used as the AgentDeviceId.agent_id of device when calling Home Graph Service. | AssistantApiSettingsHomeGraphData | Next ID: 8 | String |
| attributes | See go/ha-dev-guide and HomeGraphItem.attribute in //assistant/verticals/homeautomation/proto/home_graph.proto | AssistantApiSettingsHomeGraphData | Next ID: 8 | map |
| deviceId | Device ID, used as AgentDeviceId.device_id of device when calling Home Graph Service. | AssistantApiSettingsHomeGraphData | Next ID: 8 | String |
| deviceType | HGS device type. See java/com/google/home/graph/service/config/protoconf.pi for the exhaustive list of type strings. | AssistantApiSettingsHomeGraphData | Next ID: 8 | String |
| shouldWriteToHomeGraph | Whether device data should be written to Home Graph via Assistant device_settings. Assistant SDK and Google Home write their devices into Home Graph through AssistantSettingsService, while Home Automation Partner devices (e.g. SmartThings, Philips Hue, Nest, TP-Link, etc.) don’t need to be written to Home Graph through AssistantSettingsService. This field decides whether AssistantSettingsService writes devices to Home Graph or not. | AssistantApiSettingsHomeGraphData | Next ID: 8 | boolean |
| supportedTraits | Supported traits of the device. See java/com/google/home/graph/service/config/protoconf.pi for the exhaustive list of trait-strings. | AssistantApiSettingsHomeGraphData | Next ID: 8 | list(String) |
| supportsDirectResponse | Whether the device supports direct response. See HomeGraphItem.supports_direct_response in //assistant/verticals/homeautomation/proto/home_graph.proto | AssistantApiSettingsHomeGraphData | Next ID: 8 | boolean |
| cardConfig | Config for Hospitality UI modules. | AssistantApiSettingsHospitalityCardSettings | list(AssistantApiSettingsHospitalityCardSettingsCardConfig) | |
| showMediaTapGestureTutorial | Toggle media tap gesture tutorial card. | AssistantApiSettingsHospitalityCardSettings | boolean | |
| showPhotoSwipeGestureTutorial | Toggle photo swipe gesture tutorial card. | AssistantApiSettingsHospitalityCardSettings | boolean | |
| youtubeCardConfig | Config for YouTube video cards. | AssistantApiSettingsHospitalityCardSettings | list(AssistantApiSettingsHospitalityCardSettingsYouTubeCardConfig) | |
| activeActionRequired | Whether the UI module requires user action. If true, the UI module can peek on to the top of Ambient. See SmartDisplayModuleState::ACTIVE_ACTION_REQUIRED. | AssistantApiSettingsHospitalityCardSettingsCardConfig | Configuration for hospitality card. | boolean |
| dismissable | Whether the UI module is dismissable. | AssistantApiSettingsHospitalityCardSettingsCardConfig | Configuration for hospitality card. | boolean |
| effectiveTime | The time that the module is effective and visible to the user. If not set, the module is effective immediately. | AssistantApiSettingsHospitalityCardSettingsCardConfig | Configuration for hospitality card. | AssistantApiTimestamp |
| expiryTime | The time that the module is expired and invisible to the user. If not set, the module never expires. | AssistantApiSettingsHospitalityCardSettingsCardConfig | Configuration for hospitality card. | AssistantApiTimestamp |
| imageUrl | The image URL for the UI module. | AssistantApiSettingsHospitalityCardSettingsCardConfig | Configuration for hospitality card. | String |
| moduleId | Module ID. | AssistantApiSettingsHospitalityCardSettingsCardConfig | Configuration for hospitality card. | String |
| payloadQuery | Payload query to the partner AoG action when user responds to UI Module, e.g. “Tell the hotel how my stay is going”. | AssistantApiSettingsHospitalityCardSettingsCardConfig | Configuration for hospitality card. | String |
| title | Title of the message to be shown to user at the top of the UI Module. | AssistantApiSettingsHospitalityCardSettingsCardConfig | Configuration for hospitality card. | String |
| imageUrl | URL of image to go on card. The URL must be a public link accessible from ZeroState. | AssistantApiSettingsHospitalityCardSettingsYouTubeCardConfig | Configuration for YouTube video card (Stargazer tile). | String |
| playlistId | ID of YouTube playlist to play on card tap. A playlist is used instead of a single video id to avoid autoplaying related videos. The playlist and the videos it contains must be public or unlisted to be accessible from ZeroState. | AssistantApiSettingsHospitalityCardSettingsYouTubeCardConfig | Configuration for YouTube video card (Stargazer tile). | String |
| text | Text on card (i.e., video title). | AssistantApiSettingsHospitalityCardSettingsYouTubeCardConfig | Configuration for YouTube video card (Stargazer tile). | String |
| aogContextId | List of AOG app context ids that are linked to this device. These apps will have access to the structure information for the device. | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | list(String) |
| aogInvocationPhrase | Invocation phrase for hotel’s AoG action. Used for ZS promotion card and “talk to my hotel” rewrites. Setting this to an empty value will mark it unset. | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | String |
| branding | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | AssistantApiSettingsHospitalityModeBranding | |
| cardSettings | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | AssistantApiSettingsHospitalityCardSettings | |
| deviceClearRequest | The time when we received a request to reset the device. | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | AssistantApiTimestamp |
| dialogTtlOverrideMicros | Should the dialog have a shorter ttl. See go/ipp-consumer-prd#heading=h.ibu9b1ysdl4t and go/interpreter-device-clear#bookmark=id.hw8ey1bzjadn for context. | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | String |
| enterpriseId | Identifier for the enterprise which owns the device. Setting this to an empty value will mark it unset. | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | String |
| hospitalityModeEnabled | Indicates whether this device is in the hospitality mode. | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | boolean |
| lastDeviceClear | Last time the device was cleared and placed in hospitality mode. Will be set when the switch is toggled on and reset when a guest checks out. On the device this triggers removing alarms, timers, etc. | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | AssistantApiTimestamp |
| lastModifiedTimestamp | Indicates when hospitality settings were last updated. | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | AssistantApiTimestamp |
| lastWelcomed | Last time the welcome message was played for the guest. If last_welcomed < welcome_request, the message should be replayed and this time set. | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | AssistantApiTimestamp |
| manualResetRequired | Indicates whether or not the device must be reset manually (by voice or touch), as opposed to being automatically reset. go/hospitality-manual-reset | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | boolean |
| promotedLanguages | In order promoted languages for interpreter devices. This represents languages by BCP-47 language strings, such as “en”, “en-US”, “fr”, “fr-CA”, “sr-Latn”, “zh-Hans-CN”, “zh-Hant-HK”,etc. | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | list(String) |
| type | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | String | |
| verbalResetSupported | Whether we allow users to initiate clearing the device verbally. We generally allow this for private devices and not for public ones. | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | boolean |
| welcomeRequest | The time when we received a request to welcome the user. | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | AssistantApiTimestamp |
| displayName | Brand display in the UI | AssistantApiSettingsHospitalityModeBranding | TODO(b/169423976) Consider moving Branding out of user level settings into enterprise level settings. Partner branding fields used to customize the ui. Next ID: 7 | String |
| displayNameForLanguage | Brand display in the UI for languages that the enterprise has a localized name that is different from its global branding name. For example, Hilton is ‘ヒルトン’ in Japanese and ‘希爾頓’ in Chinese. The keys are hospitality supported display locales, e.g. en, ja-JP, etc, defined in experiment parameter Hospitality__hospitality_display_supported_locales. | AssistantApiSettingsHospitalityModeBranding | TODO(b/169423976) Consider moving Branding out of user level settings into enterprise level settings. Partner branding fields used to customize the ui. Next ID: 7 | map |
| largeLogoUrl | AssistantApiSettingsHospitalityModeBranding | TODO(b/169423976) Consider moving Branding out of user level settings into enterprise level settings. Partner branding fields used to customize the ui. Next ID: 7 | String | |
| smallLogoUrl | AssistantApiSettingsHospitalityModeBranding | TODO(b/169423976) Consider moving Branding out of user level settings into enterprise level settings. Partner branding fields used to customize the ui. Next ID: 7 | String | |
| isValid | Currently, is_valid is set to false whenever the TAF is not an Autotune aware value. This includes hotword sensitivity users, or devices not eligible for autotune. | AssistantApiSettingsHotwordThresholdAdjustmentFactor | HotwordThresholdAdjustmentFactor contains threshold_adjustment_factor, and it’s validity. value should only be considered when is_valid = true. | boolean |
| value | AssistantApiSettingsHotwordThresholdAdjustmentFactor | HotwordThresholdAdjustmentFactor contains threshold_adjustment_factor, and it’s validity. value should only be considered when is_valid = true. | integer | |
| deviceId | Contains device ids known to devices. eg. For ATV, it contains client_instance_id and cast_id. | AssistantApiSettingsInternalAncillaryDeviceId | Represents supporting device ids. | AssistantApiCoreTypesDeviceId |
| generationTime | Contains the timestamp when this version was generated. | AssistantApiSettingsInternalVersion | Represents a version of a specifit setting, e.g. DeviceSettings. | DateTime |
| id | Integer value of the version, it is a monotonically increasing number and starts at 0. On every update it is incremented by 1. | AssistantApiSettingsInternalVersion | Represents a version of a specifit setting, e.g. DeviceSettings. | String |
| kidsModeEnabled | AssistantApiSettingsKidsMode | Kids mode config for the current device. go/aff-parentalsupervision-dd | boolean | |
| obfuscatedGaiaId | Identifier of the account currently specified to be used with kids mode. | AssistantApiSettingsKidsMode | Kids mode config for the current device. go/aff-parentalsupervision-dd | String |
| displayName | User-provided name for this schedule. | AssistantApiSettingsLabeledDowntimeSchedule | String | |
| schedule | AssistantApiSettingsLabeledDowntimeSchedule | AssistantApiSettingsDowntimeSchedule | ||
| castLinkingTime | Time of linking of the device with the user provided by Cast. | AssistantApiSettingsLinkedUser | Represents the profile of the user who has signed in onto this device. Next id: 5 | DateTime |
| Primary email address of the user. | AssistantApiSettingsLinkedUser | Represents the profile of the user who has signed in onto this device. Next id: 5 | String | |
| gaiaId | AssistantApiSettingsLinkedUser | Represents the profile of the user who has signed in onto this device. Next id: 5 | String | |
| names | Supports features which depend on profile name, when no matching contact is found. | AssistantApiSettingsLinkedUser | Represents the profile of the user who has signed in onto this device. Next id: 5 | list(AppsPeopleOzExternalMergedpeopleapiName) |
| confirmed | True if the user has confirmed the marketplace disclosure. | AssistantApiSettingsMarketplaceDisclosure | boolean | |
| timestampMs | The time user confirmed the marketplace disclosure. | AssistantApiSettingsMarketplaceDisclosure | String | |
| lastEnterGuestModeTimestamp | AssistantApiSettingsMasqueradeMode | Guest mode for the current device. go/assistant-guest-mode-summary | AssistantApiTimestamp | |
| lastExitGuestModeTimestamp | AssistantApiSettingsMasqueradeMode | Guest mode for the current device. go/assistant-guest-mode-summary | AssistantApiTimestamp | |
| masqueradeModeEnabled | AssistantApiSettingsMasqueradeMode | Guest mode for the current device. go/assistant-guest-mode-summary | boolean | |
| availableProviders | Providers available at the time user updated settings. | AssistantApiSettingsMusicFilter | Specification of which music features can be used. | list(String) |
| providerFilterState | Represents the state for the music provider filter. | AssistantApiSettingsMusicFilter | Specification of which music features can be used. | String |
| state | AssistantApiSettingsMusicFilter | Specification of which music features can be used. | String | |
| whitelistedProviders | Contains the list of whitelisted music providers. | AssistantApiSettingsMusicFilter | Specification of which music features can be used. | list(String) |
| state | AssistantApiSettingsNewsFilter | Specification of which news features can be used. | String | |
| alloNotificationProfile | Each device can have only one type of notification profile. | AssistantApiSettingsNotificationProfile | AssistantApiSettingsNotificationProfileAlloNotificationProfile | |
| botSendToken | The send token of the conversation with the user. | AssistantApiSettingsNotificationProfileAlloNotificationProfile | ChatBotPlatformBotSendToken | |
| id | The fireball id of this user. | AssistantApiSettingsNotificationProfileAlloNotificationProfile | ChatBotPlatformFireballId | |
| carrierCallDeviceSettings | On device carrier call related settings. | AssistantApiSettingsOnDeviceAppSettings | AssistantApiSettingsCarrierCallDeviceSettings | |
| duoCallDeviceSettings | On device duo call related settings. | AssistantApiSettingsOnDeviceAppSettings | AssistantApiSettingsDuoCallDeviceSettings | |
| faceMatch | AssistantApiSettingsPersonalizationMetadata | String | ||
| personalResults | AssistantApiSettingsPersonalizationMetadata | String | ||
| voiceMatch | AssistantApiSettingsPersonalizationMetadata | String | ||
| state | AssistantApiSettingsPodcastFilter | Specification of which podcast features can be used. | String | |
| politeModeEnabled | AssistantApiSettingsPoliteMode | Polite mode config for the current device. go/polite-mode-dd | boolean | |
| neverAskAgain | If true, don’t ask user to trust this device again. | AssistantApiSettingsReauthTrustedDeviceSettingsTrustSettings | Next id: 6 | boolean |
| neverAskExpirationTimestamp | DEPRECATED: Use never_ask_again instead. Expiration timestamp of “never ask again” status. If this field is set and is later than current timestamp, we should NOT ask the user whether they’d like to trust this device. | AssistantApiSettingsReauthTrustedDeviceSettingsTrustSettings | Next id: 6 | DateTime |
| trustDeviceExpirationTimestamp | Expiration timestamp of “trusted” status. If this field is set and is later than current timestamp, we can consider this device to be trusted. | AssistantApiSettingsReauthTrustedDeviceSettingsTrustSettings | Next id: 6 | DateTime |
| state | AssistantApiSettingsSearchFilter | Specification of which search features can be used. | String | |
| speechOutput | AssistantApiSettingsSpeechOutputSettings | Settings related to TTS output. | String | |
| continuedConversationEnabled | Indicates whether Continued Conversation is enabled for this device. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | boolean |
| deviceModelType | Stores the device model type e.g Pixel. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | String |
| dspAvailable | Whether the device has DSP chip to enable always on hotword detection. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | boolean |
| hotwordInNavigationEnabled | Whether hotword has been enabled by the user during navigation. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | String |
| hotwordSetting | Stores hotword setting status for the locales which don’t support voice match. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | String |
| lockscreenEnabled | Whether pin/pattern lockscreen has been enabled by the user. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | boolean |
| opaEligibilityState | Stores if Assistant is available for the user’s device/locale, where Enabled means it is available and disabled means it is not. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | String |
| opaEligible | Stores if Assistant is available for the user’s device/locale. Deprecated as bools do not give accurate true/false ratios due to old clients reporting the default value. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | boolean |
| sdkVersion | Stores the Android SDK version. This comes from android.os.Build.VERSION.SDK_INT. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | integer |
| speakerIdModelPresent | Whether speaker ID model is present for the user. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | boolean |
| speakerIdRecognitionEnabled | Indicates whether the user has enabled speaker-id (fromAnyScreen/alwaysOn) for this device. Deprecated – use voice_match_setting instead | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | boolean |
| trustedVoiceEnabled | Indicates whether the user has enabled trusted voice for this device. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | boolean |
| unlockWithHotwordAvailable | A bool indicating whether device supports unlocking device with hotword. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | boolean |
| userMigratedToDeclined | Stores if user was migrated from undecided to declined as apart of Mariko project. Used for potential growth targeting. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | boolean |
| voiceMatchSetting | Stores the hotword/voice match setting status for the locales which support voice match. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | String |
| primaryHostDeviceId | The host this wearable is tethered to (e.g. phone). When host is AGSA then this is agsa_client_instance_id. When host is IOPA then this is opa_ios_device_id. | AssistantApiSettingsTetheredInfo | String | |
| state | AssistantApiSettingsThirdPartyAppsFilter | Specification of which third party apps can be used. | String | |
| autoplayToggleState | State that indicates whether autoplay is enabled for youtube videos. | AssistantApiSettingsVideoFilter | Specification of which video features can be used. | String |
| availableProviders | Providers available at the time user updated settings. | AssistantApiSettingsVideoFilter | Specification of which video features can be used. | list(String) |
| providerFilterState | Represents the state for the video provider filter. | AssistantApiSettingsVideoFilter | Specification of which video features can be used. | String |
| state | AssistantApiSettingsVideoFilter | Specification of which video features can be used. | String | |
| whitelistedProviders | Contains the list of whitelisted video providers. | AssistantApiSettingsVideoFilter | Specification of which video features can be used. | list(String) |
| jasperWebviewConsent | Indicates if user has consented Jasper warning message. | AssistantApiSettingsWebviewFilter | Specification of which webview features can be used. | boolean |
| state | AssistantApiSettingsWebviewFilter | Specification of which webview features can be used. | String | |
| method | AssistantApiSignInMethod | The method of sign in which the client supports. | String | |
| signInRequired | Make Google sign-in mandatory for using Google Assistant on the device. | AssistantApiSignInMethod | The method of sign in which the client supports. | boolean |
| supportsHotwordSensitivity | Whether the device supports different levels of hotword sensitivity. go/hotword-sensitivity-prd | AssistantApiSodaCapabilities | Capabilities related to SODA (Speech On-Device API). Next ID: 5 | boolean |
| supportsSimpleStop | Whether Simple Stop (go/simple-stop) is enabled on the device. Simple stop allows users to stop firing alarms and timers by just saying “stop” without first saying the hotword. | AssistantApiSodaCapabilities | Capabilities related to SODA (Speech On-Device API). Next ID: 5 | boolean |
| supportsSpeakerId | Whether the device supports speaker-id (speaker identification based on hotword and/or spoken query – go/speaker-id). Note: there are existing devices that support speaker-id but does not have this capability set. Not having this field populated doesn’t necessarily mean the device doesn’t support speaker-id. | AssistantApiSodaCapabilities | Capabilities related to SODA (Speech On-Device API). Next ID: 5 | boolean |
| supportsWarmWords | Whether the device supports WarmWords (go/warm-words-framework). | AssistantApiSodaCapabilities | Capabilities related to SODA (Speech On-Device API). Next ID: 5 | boolean |
| appCapabilities | IMPORTANT: Only one of AppCapabilities and AppCapabilitiesDelta should be in the SoftwareCapabilities. In the edge case if the client sends up both AppCapabilities and AppCapabilitiesDelta, AppCapabilitiesDelta is ignored. Complete list of app capabilities. | AssistantApiSoftwareCapabilities | These capabilities represent what software features the client supports. This should be determined based on the client’s various software versions (OS, GSA version, etc). Next ID: 28 | list(AssistantApiAppCapabilities) |
| appCapabilitiesDelta | Incremental update for app capabilities. | AssistantApiSoftwareCapabilities | These capabilities represent what software features the client supports. This should be determined based on the client’s various software versions (OS, GSA version, etc). Next ID: 28 | list(AssistantApiAppCapabilitiesDelta) |
| carAssistantCapabilities | Capabilities related to Assistant on Auto surfaces. | AssistantApiSoftwareCapabilities | These capabilities represent what software features the client supports. This should be determined based on the client’s various software versions (OS, GSA version, etc). Next ID: 28 | AssistantApiCarAssistantCapabilities |
| clockCapabilities | Capabilities related to clock functionality, like alarms, timers, etc. | AssistantApiSoftwareCapabilities | These capabilities represent what software features the client supports. This should be determined based on the client’s various software versions (OS, GSA version, etc). Next ID: 28 | AssistantApiClockCapabilities |
| conversationVersion | A top-level version of Conversation protocol where the versions are explicitly defined at go/conversation-versions. | AssistantApiSoftwareCapabilities | These capabilities represent what software features the client supports. This should be determined based on the client’s various software versions (OS, GSA version, etc). Next ID: 28 | AssistantApiSupportedConversationVersion |
| crossDeviceExecutionCapabilities | For torus x-device execution support | AssistantApiSoftwareCapabilities | These capabilities represent what software features the client supports. This should be determined based on the client’s various software versions (OS, GSA version, etc). Next ID: 28 | AssistantApiCrossDeviceExecutionCapability |
| gacsCapabilities | AssistantApiSoftwareCapabilities | These capabilities represent what software features the client supports. This should be determined based on the client’s various software versions (OS, GSA version, etc). Next ID: 28 | AssistantApiGacsCapabilities | |
| gcmCapabilities | AssistantApiSoftwareCapabilities | These capabilities represent what software features the client supports. This should be determined based on the client’s various software versions (OS, GSA version, etc). Next ID: 28 | AssistantApiGcmCapabilities | |
| liveTvChannelCapabilities | Capabilities related to live TV channels. | AssistantApiSoftwareCapabilities | These capabilities represent what software features the client supports. This should be determined based on the client’s various software versions (OS, GSA version, etc). Next ID: 28 | AssistantApiLiveTvChannelCapabilities |
| oemCapabilities | List of actions OEM supports. This includes built-in actions and custom actions. | AssistantApiSoftwareCapabilities | These capabilities represent what software features the client supports. This should be determined based on the client’s various software versions (OS, GSA version, etc). Next ID: 28 | AssistantApiOemCapabilities |
| onDeviceAssistantCapabilities | on-device Assistant capabilities | AssistantApiSoftwareCapabilities | These capabilities represent what software features the client supports. This should be determined based on the client’s various software versions (OS, GSA version, etc). Next ID: 28 | AssistantApiOnDeviceAssistantCapabilities |
| onDeviceSmartHomeCapabilities | Capability bits for on-device Smart Home. go/framework-for-local-semex | AssistantApiSoftwareCapabilities | These capabilities represent what software features the client supports. This should be determined based on the client’s various software versions (OS, GSA version, etc). Next ID: 28 | AssistantApiOnDeviceSmartHomeCapabilities |
| onDeviceStorageCapabilities | Reflects the storage capabilities on the device. | AssistantApiSoftwareCapabilities | These capabilities represent what software features the client supports. This should be determined based on the client’s various software versions (OS, GSA version, etc). Next ID: 28 | AssistantApiOnDeviceStorageCapabilities |
| operatingSystem | The operating system of the device. | AssistantApiSoftwareCapabilities | These capabilities represent what software features the client supports. This should be determined based on the client’s various software versions (OS, GSA version, etc). Next ID: 28 | String |
| orderedLiveTvProviders | An ordered list containing the live tv providers available in the client. The order of the providers reflects the ranking in the client and will be respected by server as well. | AssistantApiSoftwareCapabilities | These capabilities represent what software features the client supports. This should be determined based on the client’s various software versions (OS, GSA version, etc). Next ID: 28 | list(AssistantApiLiveTvProvider) |
| robinCapabilities | Capabilities of Robin client. | AssistantApiSoftwareCapabilities | These capabilities represent what software features the client supports. This should be determined based on the client’s various software versions (OS, GSA version, etc). Next ID: 28 | AssistantApiRobinCapabilities |
| selinaCapabilities | The Soli capabilities on Elaine. go/dingo-dc-software | AssistantApiSoftwareCapabilities | These capabilities represent what software features the client supports. This should be determined based on the client’s various software versions (OS, GSA version, etc). Next ID: 28 | AssistantApiSelinaCapabilites |
| settingsAppCapabilities | AssistantApiSoftwareCapabilities | These capabilities represent what software features the client supports. This should be determined based on the client’s various software versions (OS, GSA version, etc). Next ID: 28 | AssistantApiSettingsAppCapabilities | |
| supportedClientOp | AssistantApiSoftwareCapabilities | These capabilities represent what software features the client supports. This should be determined based on the client’s various software versions (OS, GSA version, etc). Next ID: 28 | list(AssistantApiSupportedClientOp) | |
| supportedFeatures | AssistantApiSoftwareCapabilities | These capabilities represent what software features the client supports. This should be determined based on the client’s various software versions (OS, GSA version, etc). Next ID: 28 | AssistantApiSupportedFeatures | |
| supportedMsgVersion | AssistantApiSoftwareCapabilities | These capabilities represent what software features the client supports. This should be determined based on the client’s various software versions (OS, GSA version, etc). Next ID: 28 | AssistantApiSupportedProtocolVersion | |
| supportedProviderTypes | AssistantApiSoftwareCapabilities | These capabilities represent what software features the client supports. This should be determined based on the client’s various software versions (OS, GSA version, etc). Next ID: 28 | AssistantApiSupportedProviderTypes | |
| surfaceProperties | AssistantApiSoftwareCapabilities | These capabilities represent what software features the client supports. This should be determined based on the client’s various software versions (OS, GSA version, etc). Next ID: 28 | AssistantApiSurfaceProperties | |
| dspAvailable | A bool indicating whether device supports dsp based hotword detection. | AssistantApiSpeechCapabilities | DEPRECATED These capabilities are associated with speech detection on devices. | boolean |
| unlockWithHotwordAvailable | A bool indicating whether device supports unlocking device with hotword. | AssistantApiSpeechCapabilities | DEPRECATED These capabilities are associated with speech detection on devices. | boolean |
| clickImpersonationSupported | Whether client supports user impersonation on suggestion chip click. go/suggestion-click-impersonation | AssistantApiSuggestionsSupport | Next ID: 18 | boolean |
| debugDataSupported | Whether client supports suggestions debug data to be displayed. | AssistantApiSuggestionsSupport | Next ID: 18 | boolean |
| drlHistoryChipSupported | Whether DRL history chip is supported. Related bug: http://b/241837879, http://b/171854732 Design doc: http://go/panthera-history-chip-dd DRL history chip was originally rolled out to Panthera in http://google3/googledata/experiments/mobile/agsa/studies/agsa_nga/opa_panthera_one_input_ui_launch.gcl?l=55&rcl=384682900. We plan to roll it out to NGA and TNG. drl_history_chip_supported bit specifies whether the client support (and should have) DRL history chip. | AssistantApiSuggestionsSupport | Next ID: 18 | boolean |
| escapeHatchSupported | Whether client supports escape hatches aka post execution suggestions go/nga-escape-hatch-prd | AssistantApiSuggestionsSupport | Next ID: 18 | String |
| executedTextSupported | Whether the client can rewrite suggestion query text into executed text, if the latter is present. If this feature is disabled, the rewrite happens in Assistant Server. | AssistantApiSuggestionsSupport | Next ID: 18 | boolean |
| executionContextSupported | Whether the client supports passing back `execution_context` from |assistant.api.client_op.SuggestionProcessingParams| when the suggestion is clicked or spoken. | AssistantApiSuggestionsSupport | Next ID: 18 | boolean |
| featureSpecificActionSupport | Whether the client supports features in |SuggestionFeatureSpecificAction|. | AssistantApiSuggestionsSupport | Next ID: 18 | AssistantApiFeatureSpecificActionSupport |
| featureSpecificAppActionsNotificationSupported | Whether the client supports handling App Actions’ notification when the suggestion is clicked. This will allow the server to populate the `app_actions_notification_data` extension field from |SuggestionFeatureSpecificAction| proto message. | AssistantApiSuggestionsSupport | Next ID: 18 | boolean |
| multiStepTrySayingSupported | Whether the multi-step try saying suggestion feature is supported. dd: go/tng-multi-step-simplified | AssistantApiSuggestionsSupport | Next ID: 18 | boolean |
| ruleIdInExecutionContextSupported | Whether the rule_id field in the execution_context is supported. This is a temporary workaround to be able to identify clicks on Person entity suggestions on Sabrina and is expected to be eventually deprecated. TODO(b/185517153) : Deprecate (but do not delete) once click tracking is correctly sent up from the Katniss client. | AssistantApiSuggestionsSupport | Next ID: 18 | boolean |
| showExecutedTextSupported | Whether the client can show executed_text after the click on the suggestion chip. Must be set to false on TNG. TNG disregards |SuggestionProcessingParams.show_executed_text| field and always treats it as if |show_executed_text=true|. | AssistantApiSuggestionsSupport | Next ID: 18 | boolean |
| showTranslationSupported | Whether the client can show chip as (text | translation). go/lang-partner-doc | AssistantApiSuggestionsSupport | Next ID: 18 | boolean |
| supportedDisplayTargets | A list of suggestions display targets supported by this client. If unset only DEFAULT SuggestionDisplayTarget is supported. | AssistantApiSuggestionsSupport | Next ID: 18 | list(AssistantApiSuggestionsSupportDisplayTargetSupport) |
| widgetDataSupported | Whether client supports widget suggestion chip to be displayed. | AssistantApiSuggestionsSupport | Next ID: 18 | boolean |
| executedTextSupported | Whether the client can rewrite suggestion query text into executed text, if the latter is present for the display target. | AssistantApiSuggestionsSupportDisplayTargetSupport | boolean | |
| headerTextSupported | Whether PresentationParams.header_text is supported for the display target. | AssistantApiSuggestionsSupportDisplayTargetSupport | boolean | |
| repressImpressionSupported | Whether Suggestion.repress_impression is supported. If not repressed suggestions are not returned. | AssistantApiSuggestionsSupportDisplayTargetSupport | boolean | |
| target | Display target that is supported. | AssistantApiSuggestionsSupportDisplayTargetSupport | String | |
| sunriseSimulationSupported | If true, the device can slowly brighten the screen and simulate sunrise experience. Alarms with sunrise field enabled can be set on this device. | AssistantApiSunriseFeaturesSupport | boolean | |
| clientOpName | This should be the same as the name of the SemanticClientOp that is supported. | AssistantApiSupportedClientOp | These are the set of ClientOps that are supported by the device. | String |
| clientOpProperties | The properties associated with the ClientOp. This proto should be associated with the client_op_name. | AssistantApiSupportedClientOp | These are the set of ClientOps that are supported by the device. | AssistantApiProtobuf |
| supportedExecution | AssistantApiSupportedClientOp | These are the set of ClientOps that are supported by the device. | AssistantApiSupportedClientOpSupportedExecution | |
| version | A version of 0 is the equivalent to not having support for that client_op type. Note that a client_op is also unsupported if it is not included at all in the list of supported client_ops. | AssistantApiSupportedClientOp | These are the set of ClientOps that are supported by the device. | integer |
| supportsPartialFulfillment | ClientOp execution supports special rendering behavior while the user is in the middle of expressing their query. This behavior includes: 1) New partial output always over-writes prior partial output. 2) Canceling the interaction removes partial fulfilment from any user visible interaction history. If this is true, whether to apply the special rendering behavior will be determined by PartialFulfillmentRenderingParams. More details can be found at go/ma-natcon-pf-api. | AssistantApiSupportedClientOpSupportedExecution | Additional properties that client can support for executing the client op. They are surface-specific execution properties and are unrelated to the execution model. | boolean |
| supportsSynchronousExecution | Client can support synchronous execution of the client op. For tts.OUTPUT client op it means that client would honor |synchronous_playback_args| argument. Please see more at go/synchronous-sounds-design. | AssistantApiSupportedClientOpSupportedExecution | Additional properties that client can support for executing the client op. They are surface-specific execution properties and are unrelated to the execution model. | boolean |
| supportsConversationProtocol | Whether conversation protocol is supported explicitly. If true, SingleDeviceCapabilityChecker::SupportsConversationProtocol will always return true. | AssistantApiSupportedConversationVersion | The overall Conversation Protocol version. As we make fundamental changes to Conversation protocol that are non-backwards compatible, we will increment the protocol version. By default, all clients will support version 0. All versions are documented at go/conversation-versions. | boolean |
| version | The supported version number. | AssistantApiSupportedConversationVersion | The overall Conversation Protocol version. As we make fundamental changes to Conversation protocol that are non-backwards compatible, we will increment the protocol version. By default, all clients will support version 0. All versions are documented at go/conversation-versions. | integer |
| readNotificationSummarizationSupported | Whether the client supports message summarization. Deprecated, use message_summary_support instead. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| fitnessFeatureSupport | Information about what support this device has for fitness. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | AssistantApiFitnessFeatureSupport |
| masqueradeModeSupported | Whether the device supports masquerade mode (go/masquerade). | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| appControlSupport | The client information for app control support. More details in: go/acaia. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | AssistantApiAppControlSupport |
| gearheadNotificationSourceSupported | Whether the client supports the Gearhead message notification source, in which case notification-related operations can access it. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| parentalControlsSupported | Whether or not the client supports enabling parental controls. When a device to supports parental controls, it has the software necessary to store the relevant information required for parental controls to work. This information includes a boolean “enabled bit” as well as the obfuscated gaia ID of the kid account selected for use with parental controls. Devices supportings kids mode send this information to S3 via S3ClientInfo in every request. See go/aff-kidsproduct for details. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| mediaControlSupport | Information about how client handles media controls (play, pause, skip …) | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | AssistantApiMediaControlSupport |
| sunriseFeaturesSupport | Whether the client supports the sunrise screen brightening feature before the alarm fires. This is used to indicate whether sunrise alarms can be set on the device. http://cs/symbol:assistant.api.core_types.governed.RingtoneTaskMetadata.GentleWakeInfo | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | AssistantApiSunriseFeaturesSupport |
| shLockScreenSupported | Whether the client supports SmartHome lock screen logic (i.e. on Tangor). | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| fluidActionsSupport | Fluid Actions features supported by the client. If this field is not set in the incoming request, it could mean that the client does not support Fluid Actions. Alternatively, it could mean that the client supports Fluid Actions, but syncs state with server using the old protocol, namely ConversationStateParams. When b/140733618 is resolved, Surface Adaptation Layer will add this field for old clients that support Fluid Actions framework. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | AssistantApiFluidActionsSupport |
| bypassMsgNotificationDismissal | Whether or not Assistant should enforce the dismissal of communication notifications associated with messages. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| justInTimeSupported | Whether the client supports confirmation flow when a permission is missing. If set to true, the user will be prompted and on confirmation the original flow will continue. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| sleepSensingSupported | Whether the client can monitor sleep. This allows us to show sleep CUJ related information: go/TwilightDesign Use for development only, see the same field in DeviceCapabilities.SoftwareCapabilities.SelinaCapabilities. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| actionV2SupportedFeatures | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | AssistantApiActionV2SupportedFeatures | |
| mediaSessionDetection | The ability of the client to detect media sessions on the device. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | String |
| gdiSupported | Whether account linking via Google Deep Integrations (GDI) is supported. go/opa-gdi-design | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| zoomSupported | Whether the client supports joining a Zoom meeting. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| persistentDisplaySupported | Whether the client supports persistent display. The new feature allows Assistant devices with screen to display a continuously updating permanent display, such as ambient weather, without the need for a user to ask the Assistant. Design doc: go/assistant-persistent-display. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| alarmTimerManagerApiSupported | Whether the client supports AlarmTimerManager API (go/alarm-timer-manager-api). | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| bypassDiDcCheckForComms | Whether communications flows for the client can bypass the DI/DC check. The client will enforce some other equivalent permission as necessary concerning access to device contacts and apps. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| readMessagesTtsTaperingSupported | Whether the client supports tts tapering for the read messages flow. If set to true the tapered tts variant would be used during the read messages flow. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| funtimeSupported | Whether the surface client op performer supports Funtime alarms and timers. go/funtime-engdesign | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| webBrowserSupported | Whether the supports opening a URL in a web browser. For example, we want to disable this for clients like Chirp. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| mapsDialogsSupported | Whether the client supports Assistant dialogs within Maps. This field will be set only when the Maps on the surface supports Assistant dialogs embedded within Maps. go/gsa-gmm. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| opaOnSearchSupported | When the entry source is search, whether the client supports rendering a similar response as OPA one does. Entry source is defined at http://cs/symbol:assistant.api.params.DeviceProperties.EntrySource | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| isPairedPhoneContactUploadNeededForComms | Whether paired-phone contact upload is needed for communications queries to work (e.g. on AAE). | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| noInputResponseSupported | Whether the client can render no input response or just ignore it. No input response is returned when client has a no speech input interaction, eg. user tapped mic but didn’t say anything. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| smartspaceCrossDeviceTimerSupported | Whether the client supports smart space cross-device timers. (go/ss-x-device-timer) | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| clientOpResultBatchingSupported | Whether the client can batch client op results before sending them to the server. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| usesSeparateFullViewer | If set, it indicates that the client can open a separate HTML browser/webviewer (full viewer) to display certain visual results. These visual results usually require more memory to render (e.g. high resolution photos). Compared to the regular viewer that display all other Assistant result, the full viewer does not have memory limit. The field is copied from the device model. See http://google3/assistant/devices_platform/proto/device_model_capabilities.proto?l=225&rcl=312576471 Also see go/webassistant-full-card-viewer. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| confirmationBeforeReadingMultipleMessagesSupported | Whether the client supports confirmation flow before announcement of multiple messages. If set to true the user will be prompted once and confirmation will be taken before all the messages are announced. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| messageSummarySupport | The client information for message summary. More details in: go/roadwayrecap-prd | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | AssistantApiMessageSummarySupport |
| acpSupport | In what way is assistant continued presence supported. (go/opa-acp-prd) | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | AssistantApiAssistantContinuedPresenceSupport |
| viewReminderHubPageNotSupported | Whether the client supports viewing of reminder hub page or not. Default is supported. Set to true to disable returning reminder hub page url in reminder responses. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| duoGroupCallingSupported | Whether the client supports Duo group calling. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| client1mProvidersSupported | Whether the client supports 1m providers (go/1m-partner-expansion). | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| hasPhysicalRadio | Whether the client has a physical radio installed. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| liveCardsSupported | Whether the surface supports LiveCards. In cases where the user intent flow cannot be completed within the Assistant, LiveCards are used to take the user to an external app or website. These cards will be pushed to the Google Home app via the PushMessage ClientOp. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| signInMethod | Which kind of sign in the client supports. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | AssistantApiSignInMethod |
| lottieAnimationSupport | Whether the client supports the Lottie animation library for the broadcast feature. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | String |
| serverGeneratedFeedbackChipsEnabled | Whether the Assistant Server should generate feedback suggestion chips. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| transactionFeaturesSupport | Transactions features, supported by the client. Transactions feature may includes how Transactions team want to populate additional information from the device to the server. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | AssistantApiTransactionFeaturesSupport |
| tapToReadOptimizationSupported | Whether the client supports faster optimization for tap_to_read feature. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| remoteCloudCastingEnabled | Whether the client has remote casting enabled. For ex: we want to disable this for clients like Auto. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| crossDeviceBroadcastSupported | Whether the client supports cross-device broadcast (i.e. on Torus). | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| suggestionsSupport | Suggestion chips features, supported by the client. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | AssistantApiSuggestionsSupport |
| crossDeviceBroadcastVersion | The version of cross device broadcast (ie; broadcast on torus) which the client supports. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | String |
| conversationalCareSupported | Whether the client can render conversational care responses. go/conversational-care | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| assistantForKidsSupported | Whether Assistant for Kids (a.k.a. Designed for Family) features are supported. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| isPairedPhoneNeededForComms | Whether a Bluetooth-paired phone is a core component of communications flows on the client. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| csatVisualOverlaySupported | Whether the client supports csat visual overlay. (go/sd-od-csat) | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| transactionsVersion | The version of transactions which the client supports. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | String |
| duoClientApiFeatures | The features set which duo client on the device supports. This should be serialized from proto {@code duo_client_api.DuoClientApiFeatures}. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | String |
| aaeNotificationSourceSupported | Whether the client supports the alternative message notification sources on AAE, in which case notification-related operations can access it. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| immersiveCanvasSupport | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | AssistantApiImmersiveCanvasSupport | |
| soliGestureDetectionSupported | Whether or not the client supports gesture detection via soli chips. The reason to prepend the name with soli is to distinguish it from computer vision based methods, e.g. Newman devices. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| lensSupported | Whether the client has Google Lens (Assistant Eyes). | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| privacyAwareLockscreenSupported | Whether the client supports the privacy-aware lockscreen protocol (go/assistant-lockscreen-spec). | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| assistantExploreSupported | Whether the client supports the assistant explore section. This field will be active only when the Explore section is available to the user. This means that the user is (a) signed-in, (b) a IOPA / AGSA user, and (c) in a locale where explore is available. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| meetSupported | Whether the client supports joining a Google Meet meeting. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| launchKeyboardSupported | Which way of launching the keyboard the client supports. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | String |
| immersiveCanvasConfirmationMessageSupported | Whether the client supports confirmation messages in Immersive Canvas actions. Deprecated: use the filed in immersive_canvas_support. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| warmWelcomeTutorialSupported | Whether the client supports the programmatic warm welcome tutorial. Design doc: go/opal-pww-design. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| inDialogAccountLinkingSupported | Whether the client supports account linking in-dialog (askForSignIn). This is used before this feature is moved to conversation protocol. To support this, the client needs to: – Integrate with Google Deep Integrations. – Have logic to send the result of account linking back to AS. | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| thirdPartyGuiSupported | Whether the device supports the 3p GUI framework, which allows third parties to enter the conversation with the user, showing their logo next to their chat bubbles, etc. go/3p-phone | AssistantApiSupportedFeatures | These are the set of features that are supported by the device. It’s a part of the SoftwareCapabilities of the device. Next ID: 69 | boolean |
| messageVersion | AssistantApiSupportedProtocolVersion | Contains versions of protocol buffer messages. This is the equivalence of a proto3 map, keyed by a protocol buffer message’s name, and the value is the version of this message. e.g. {“assistant.api.core_types.Timer”: 2, “assistant.api.core_types.Alarm”: 1} See go/assistant-protocol-versioning for more details. | list(AssistantApiSupportedProtocolVersionMessageVersionPair) | |
| messageName | The full path of a message which should start from the package name. e.g. “assistant.api.core_types.Timer”. | AssistantApiSupportedProtocolVersionMessageVersionPair | String | |
| version | The supported version number. | AssistantApiSupportedProtocolVersionMessageVersionPair | integer | |
| supportedTypes | AssistantApiSupportedProviderTypes | Types of providers that are supported by the client. For example, ChromeOS support both web app and Android app (for eligible devices). | list(String) | |
| executionCapabilities | AssistantApiSurfaceProperties | Properties of the surface that are not hardware related or feature specific. | AssistantApiSurfacePropertiesExecutionCapabilities | |
| prefersGlanceableUi | Indicates if the surface prefers glanceable UI when rendering Assistant response. (see go/mobile-dr-hbird-glanceable-comms-cuj for more context). | AssistantApiSurfaceProperties | Properties of the surface that are not hardware related or feature specific. | boolean |
| responseDisplayFormat | If this field is unset, the response format is unknown | AssistantApiSurfaceProperties | Properties of the surface that are not hardware related or feature specific. | String |
| supportsMultiResponse | If true, the client supports receiving multiple responses. See go/multiple-response-in-media-use-cases for more details. | AssistantApiSurfaceProperties | Properties of the surface that are not hardware related or feature specific. | boolean |
| supportsClientOpPreloading | Completes the preloading ie., sets up the stage for the execution of client ops on the device while the previous conv delta is being executed. Refer to go/preload-convdelta for more information. | AssistantApiSurfacePropertiesExecutionCapabilities | Describes the capabilities that are related to the execution of client ops on the device. | boolean |
| supportsNonFinalizedResponses | A value of true indicates that the client supports streaming of non-finalized responses by use of ClientExecutionParams.response_stream_id. and ClientExecutionParams.to_be_finalized. | AssistantApiSurfacePropertiesExecutionCapabilities | Describes the capabilities that are related to the execution of client ops on the device. | boolean |
| supportsNonMaterializedInteractions | If true, the client supports receiving non-materialized interactions (go/as-streaming-protocol-nm). | AssistantApiSurfacePropertiesExecutionCapabilities | Describes the capabilities that are related to the execution of client ops on the device. | boolean |
| categoryState | AssistantApiSystemNotificationRestrictions | Restrictions related to system-level notifications. | list(AssistantApiSystemNotificationRestrictionsNotificationCategoryState) | |
| channelState | AssistantApiSystemNotificationRestrictions | Restrictions related to system-level notifications. | list(AssistantApiSystemNotificationRestrictionsNotificationChannelState) | |
| notificationCapabilities | Specifies whether the surface is able to display notifications. | AssistantApiSystemNotificationRestrictions | Restrictions related to system-level notifications. | String |
| categoryId | Notification channel type. | AssistantApiSystemNotificationRestrictionsNotificationCategoryState | Notification channels state for the new server driven channels. | integer |
| disabled | Weather the notifications on this channel are disabled. | AssistantApiSystemNotificationRestrictionsNotificationCategoryState | Notification channels state for the new server driven channels. | boolean |
| disabledReason | AssistantApiSystemNotificationRestrictionsNotificationCategoryState | Notification channels state for the new server driven channels. | String | |
| channelType | Notification channel type. | AssistantApiSystemNotificationRestrictionsNotificationChannelState | Notification channels state. | String |
| enabled | Whether the notifications on this channel are enabled. | AssistantApiSystemNotificationRestrictionsNotificationChannelState | Notification channels state. | boolean |
| deviceActionCapability | DeviceActionCapability from DeviceModelPackage. | AssistantApiThirdPartyActionConfig | 3P Action Metadata. Next ID: 3 | AssistantDevicesPlatformProtoDeviceActionCapability |
| projectConfigs | List of Action project capabilities. | AssistantApiThirdPartyActionConfig | 3P Action Metadata. Next ID: 3 | list(AssistantApiThirdPartyActionConfigProjectConfig) |
| projectId | Google cloud project id for which the Action Package or Device Model is registered. | AssistantApiThirdPartyActionConfigProjectConfig | Metadata for ActionPackage. Device Actions are disabled by default unless explicitly enabled for the device here, see go/3p-device-actions-v2-design. | String |
| dataSharingRestrictions | Restrictions for the device to share any data with third party apps. See details in go/atv-dsc. | AssistantApiThirdPartyCapabilities | String | |
| hour | The hour, in 0…23. | AssistantApiTimeOfDay | A civil time relative to a timezone. | integer |
| minute | The minute, in 0…59. | AssistantApiTimeOfDay | A civil time relative to a timezone. | integer |
| nanosecond | The fraction of seconds in nanoseconds, in 0..999999999. | AssistantApiTimeOfDay | A civil time relative to a timezone. | integer |
| second | The second, in 0…59. Leap seconds are not supported. | AssistantApiTimeOfDay | A civil time relative to a timezone. | integer |
| nanos | Non-negative fractions of a second at nanosecond resolution. | AssistantApiTimestamp | An absolute point in time independent of timezone or calendar, based on the proto3 Timestamp (//google/protobuf/timestamp.proto). NOTE: THIS IS NO LONGER RECOMMENDED TO BE USED. It was originally defined separately from google.protobuf.Timestamp due to incompatibility with proto2 syntax. The incompatibility issues have since been resolved and so the Google-wide standard representation of google.protobuf.Timestamp should be preferred. In fact, google.protobuf.* protos in general are now recommended to be used in new APIs. | integer |
| seconds | Seconds of UTC time since the Unix epoch. | AssistantApiTimestamp | An absolute point in time independent of timezone or calendar, based on the proto3 Timestamp (//google/protobuf/timestamp.proto). NOTE: THIS IS NO LONGER RECOMMENDED TO BE USED. It was originally defined separately from google.protobuf.Timestamp due to incompatibility with proto2 syntax. The incompatibility issues have since been resolved and so the Google-wide standard representation of google.protobuf.Timestamp should be preferred. In fact, google.protobuf.* protos in general are now recommended to be used in new APIs. | String |
| ianaId | Time zone in IANA format, e.g. America/Los_Angeles for USA Pacific Time. | AssistantApiTimeZone | A time zone. Conceptually, a time zone is a set of rules associated with a location that describes a UTC offset and how it changes over time (e.g. Daylight Saving Time). The offset is used to compute the local date and time. | String |
| voicePinSuppressed | If true, setting this boolean means the device should not support voice PIN. For example, although the phone supports both voice and PIN pad, but we don’t want users using voice. https://docs.google.com/document/d/1M8iJQX3GuxGZGeidS8Gl4KJt3LuBWAIlolPlW10DkxU/edit#heading=h.8ovvdd3i2thv | AssistantApiTransactionFeaturesSupport | boolean | |
| defaultVolumePercentage | The volume percentages for spelled out values. | AssistantApiVolumeProperties | integer | |
| highVolumePercentage | AssistantApiVolumeProperties | integer | ||
| levelStepSize | The number of levels to move for a step. | AssistantApiVolumeProperties | float | |
| lowVolumePercentage | AssistantApiVolumeProperties | integer | ||
| maximumVolumeLevel | The max number of volume levels the client supports. | AssistantApiVolumeProperties | integer | |
| mediumVolumePercentage | AssistantApiVolumeProperties | integer | ||
| veryHighVolumePercentage | AssistantApiVolumeProperties | integer | ||
| veryLowVolumePercentage | AssistantApiVolumeProperties | integer | ||
| maxSupportedAlarms | Maximum number of alarms that can be created on the client. Zero or unset indicates no maximum limit. | AssistantDevicesPlatformProtoAlarmCapability | Capability with regard to support of alarms by the client. | integer |
| restrictAlarmsToNextDay | Whether the client restricts alarms to ring within the next 24 hours. | AssistantDevicesPlatformProtoAlarmCapability | Capability with regard to support of alarms by the client. | boolean |
| supportsGenericMutations | Whether the client supports mutation of any alarm attribute such as time_pattern, recurrence_pattern, etc through the MUTATE action. If this is false, MUTATE may only be used to disable or dismiss an alarm. This field is true by default for backwards-compatibility; clients which don’t support mutation outside of Disable/DismissAlarm should explicitly set this to false. | AssistantDevicesPlatformProtoAlarmCapability | Capability with regard to support of alarms by the client. | boolean |
| supportsStopAction | Whether the client supports the STOP alarm action. If this is false, stop actions will be represented by the MUTATE action, and the device may need to check alarm state to determine if there’s a firing alarm that needs to be dismissed. | AssistantDevicesPlatformProtoAlarmCapability | Capability with regard to support of alarms by the client. | boolean |
| intValueSpec | AssistantDevicesPlatformProtoArgSpec | AssistantDevicesPlatformProtoIntValueSpec | ||
| optionValueSpec | AssistantDevicesPlatformProtoArgSpec | AssistantDevicesPlatformProtoOptionValueSpec | ||
| type | AssistantDevicesPlatformProtoArgSpec | String | ||
| cloudEndpoints | The list of CloudEndpoints supported by this Device Model. Note that each should have a unique |name|. If any cloud endpoints are provided here, then the first one in the list will be used by default for all Cloud Execution. An Intent may override the default by providing an |execution_config|. | AssistantDevicesPlatformProtoCloudCapability | States the cloud capabilities of the device, i.e. the endpoint(s) to use for cloud execution of Actions or Registration. | list(AssistantDevicesPlatformProtoCloudEndpoint) |
| name | The name for this cloud endpoint. It’s unique per Locale. This is not an API resource name. Ex: sample-nlu-endpoint | AssistantDevicesPlatformProtoCloudEndpoint | A cloud endpoints associates with this device, it can be used for query parsing, or cloud execution. | String |
| scopes | The list of scopes to be provided in the OAuth2 token. They must be a subset of the scopes registered in the Account Linking flow, or the request will fail. If the client itself provides the token, then this field is ignored. | AssistantDevicesPlatformProtoCloudEndpoint | A cloud endpoints associates with this device, it can be used for query parsing, or cloud execution. | list(String) |
| url | The URL for this endpoint, it must start with https. | AssistantDevicesPlatformProtoCloudEndpoint | A cloud endpoints associates with this device, it can be used for query parsing, or cloud execution. | String |
| assistantDeviceInRoomOptOut | Integrate your device with Google’s Smart Home solution by putting your device into Google’s Home Graph, a database that stores and provides contextual data about the home and its devices. For example, Home Graph can store the concept of a living room that contains multiple types of devices, when you say “turn on the light” to a device, if you have light in the living room, that light will be turned on. | AssistantDevicesPlatformProtoDeviceActionCapability | This capability represents device action needed capability. Next ID: 10 | boolean |
| builtInIntentMode | Specifies behavior for built-in device actions for this device model. If not specified, defaults to ENABLE_CONFIGURED_INTENTS_ONLY. | AssistantDevicesPlatformProtoDeviceActionCapability | This capability represents device action needed capability. Next ID: 10 | String |
| customIntentMode | Specifies which custom device actions should be enabled for this device model. This will only affect the behavior of intents corresponding to those from the Action Package of this project. If not specified, defaults to ENABLE_ALL. | AssistantDevicesPlatformProtoDeviceActionCapability | This capability represents device action needed capability. Next ID: 10 | String |
| defaultExecutionConfig | Default instructions for routing of any Intent. The data here could be overridden for specific Intents if provided directly in the ‘intents’ field. | AssistantDevicesPlatformProtoDeviceActionCapability | This capability represents device action needed capability. Next ID: 10 | AssistantDevicesPlatformProtoExecutionConfig |
| inlinedActionCapability | Specifies capabilities for device actions that are inlined in the google.assistant.embedded.v1.DeviceAction message. | AssistantDevicesPlatformProtoDeviceActionCapability | This capability represents device action needed capability. Next ID: 10 | AssistantDevicesPlatformProtoInlinedActionCapability |
| intents | Intent configurations. Built-in and custom intents may be configured here. Note that built-in intents will always behave with IntentMode of ENABLE_CONFIGURED_INTENTS_ONLY. The IntentMode for custom intents can be changed using the custom_intent_mode. To configure an intent, list it here with its intent name, e.g. “MY_CUSTOM_INTENT”, “google.assistant.car.model.capabilities.AC_TEMPERATURE”. | AssistantDevicesPlatformProtoDeviceActionCapability | This capability represents device action needed capability. Next ID: 10 | list(AssistantDevicesPlatformProtoIntent) |
| providedData | Provided data which augments the device action capabilities. Some built-in intents may require additional configuration to be provided. One example could be the list of channels available for the `action.intent.SelectChannel` intent. | AssistantDevicesPlatformProtoDeviceActionCapability | This capability represents device action needed capability. Next ID: 10 | list(AssistantDevicesPlatformProtoProvidedData) |
| traits | List of built-in traits such as “action.devices.traits.OnOff” See java/com/google/home/graph/service/config/protoconf.pi As of Nov. 2017, we also support custom traits for EAP users. We’ll eventually disable custom traits once custom actions are in place. | AssistantDevicesPlatformProtoDeviceActionCapability | This capability represents device action needed capability. Next ID: 10 | list(String) |
| understandingConfig | Specifies the format how Google routes queries to 3P cloud. By default, this field is unset, all partners should get shallow NLU. This is needed *ONLY* for specific partners for strong business reasons. | AssistantDevicesPlatformProtoDeviceActionCapability | This capability represents device action needed capability. Next ID: 10 | AssistantDevicesPlatformProtoUnderstandingConfig |
| clientOpProperty | AssistantDevicesPlatformProtoDeviceModifySettingCapability | AssistantApiClientOpPropertiesDeviceModifySettingClientOpProperty | ||
| cloudEndpointName | Instructions for performing a cloud execution request for the Intent when the execution_type is set to CLOUD. If non-empty, then the device execution would be routed to the CloudEndpoint specified by this name. The Account Linking exchange may be performed to fetch the OAuth access token, and the access token will be included in the HTTP header. | AssistantDevicesPlatformProtoExecutionConfig | Specifies the routing capabilities of the Intent. It will apply only when the Intent is triggered. Next ID: 8 | String |
| cloudIntentTranslationDisabled | If this field is set, then the Syndication cloud call will be disabled for this intent. Note this only applies if any Syndication cloud endpoint is associated with the Device Model, otherwise setting this field does nothing. By default, all Intents that are enabled and supported by the Syndication API will be routed through the Syndication cloud endpoint if it’s provided. | AssistantDevicesPlatformProtoExecutionConfig | Specifies the routing capabilities of the Intent. It will apply only when the Intent is triggered. Next ID: 8 | boolean |
| intentCommandFormat | Specifies the intent command format for this Action. For example, in order to launch an Android intent instead of receiving the device action payload on the client, then this field can be set with “intent:/#Intent;…;my_extra={$.params.channels[0].channelCode};end” The parameter “{$.params.channels[0].channelCode}” is in JSON path format, and will be replaced with the content from the original device action payload. Thus, with # JSON “execution”: [ { “command”: “action.devices.commands.SelectChannel”, “params”: { “channels”: [{ “channelName”: “exampleChannel”, “channelCode”: “1-1” }] } } ] as the original action result, then the final result would look like “intent:/#Intent;…;my_extra=\\”1-1\\”;end” | AssistantDevicesPlatformProtoExecutionConfig | Specifies the routing capabilities of the Intent. It will apply only when the Intent is triggered. Next ID: 8 | String |
| localDisabled | If this field is set, then local execution capability is disabled for all matching intents. | AssistantDevicesPlatformProtoExecutionConfig | Specifies the routing capabilities of the Intent. It will apply only when the Intent is triggered. Next ID: 8 | boolean |
| localExecutionType | Specifies how to execute this Action when it is invoked locally (from the same device.) | AssistantDevicesPlatformProtoExecutionConfig | Specifies the routing capabilities of the Intent. It will apply only when the Intent is triggered. Next ID: 8 | String |
| remoteDisabled | If this field is set, then remote execution capability is disabled for all matching intents. | AssistantDevicesPlatformProtoExecutionConfig | Specifies the routing capabilities of the Intent. It will apply only when the Intent is triggered. Next ID: 8 | boolean |
| remoteExecutionType | Specifies how to execute this Action when it is invoked remotely (from a different device.) | AssistantDevicesPlatformProtoExecutionConfig | Specifies the routing capabilities of the Intent. It will apply only when the Intent is triggered. Next ID: 8 | String |
| alarm | Specifies capabilities for handling on-device alarms. The presence of this field, even if empty, implies that the device supports alarms. | AssistantDevicesPlatformProtoInlinedActionCapability | AssistantDevicesPlatformProtoAlarmCapability | |
| responseLimits | Specifies the size limits on responses. If message is not defined then no limits exist. | AssistantDevicesPlatformProtoInlinedActionCapability | AssistantDevicesPlatformProtoResponseLimits | |
| supportSdkExecute | Whether this device model package support sdk.EXECUTE client_op (a.k.a action.devices.EXECUTE intent), which will be filled into google.assistant.embedded.v1.DeviceAction.device_request_json. It is default to true (and not public), since all 3P will depends on the device_request_json. Only internal projects like Edoras will set this to false. | AssistantDevicesPlatformProtoInlinedActionCapability | boolean | |
| supportedDeviceOps | Specifies capabilities for handling assistant.embedded.v1.DeviceOp. | AssistantDevicesPlatformProtoInlinedActionCapability | AssistantDevicesPlatformProtoSupportedDeviceOps | |
| supportsMultiResponse | Specifies whether server can send a series of responses for a single query. Example: Routines where multiple actions to be executed one after another. | AssistantDevicesPlatformProtoInlinedActionCapability | boolean | |
| timer | Specifies capabilities for handling on-device timers. The presence of this field, even if empty, implies that the device supports timers. | AssistantDevicesPlatformProtoInlinedActionCapability | AssistantDevicesPlatformProtoTimerCapability | |
| ttsOutput | Specifies whether client supports receiving `DeviceAction.tts_output`. | AssistantDevicesPlatformProtoInlinedActionCapability | AssistantDevicesPlatformProtoTtsOutputCapability | |
| executionConfig | Instructions for the routing of this Intent. | AssistantDevicesPlatformProtoIntent | An intent configures the behavior of a device action for this device. Next ID: 7 | AssistantDevicesPlatformProtoExecutionConfig |
| name | The name of the intent. | AssistantDevicesPlatformProtoIntent | An intent configures the behavior of a device action for this device. Next ID: 7 | String |
| providedDataNames | List of provided data names used by this intent. Note that some built-in intents will not function properly without provided data, such as `action.intent.SwitchChannel` or `action.intent.AppSelector`. | AssistantDevicesPlatformProtoIntent | An intent configures the behavior of a device action for this device. Next ID: 7 | list(String) |
| securityConfig | Security configuration for this Intent. | AssistantDevicesPlatformProtoIntent | An intent configures the behavior of a device action for this device. Next ID: 7 | AssistantDevicesPlatformProtoSecurityConfig |
| triggerConditions | The conditions which must be met by the device before executing this Intent. More than one can be provided, in which case the conditions operate with the “AND” operator, i.e. the first condition which is failed will be used to restrict the execution of this Intent. | AssistantDevicesPlatformProtoIntent | An intent configures the behavior of a device action for this device. Next ID: 7 | list(AssistantDevicesPlatformProtoTriggerCondition) |
| allowedAssistantSdkAuthProjectIds | When using the Assistant SDK (Embedded Assistant API), the project id used to authenticate the gRPC request is checked and must match against the project id of the Device Model. We will additionally allow the project ids listed in the device model here to be let through. See https://docs.google.com/document/d/1InAczpQJs6LCH1l–2yy67JM9hsBJbiL57fusnL3A8A | AssistantDevicesPlatformProtoInternalCapability | Capabilities that may only be set internally. Only internal callers (i.e. Googlers or Google owned projects) will be able to set these, thanks to go/assistant-device-model-package-ownership. | list(String) |
| appCapabilitiesFromDeviceInstallApps | Load the assistant.api.AppCapabilities from DEVICE_INSTALLED_APP footprint corpus. See go/edoras-geller. | AssistantDevicesPlatformProtoInternalCapability | Capabilities that may only be set internally. Only internal callers (i.e. Googlers or Google owned projects) will be able to set these, thanks to go/assistant-device-model-package-ownership. | boolean |
| cloudDeviceActionEndpoint | Uses this endpoint for device action fulfillment when there’s no endpoint in syndication_metadata. 1p surfaces/devices such as telephone can enable this for its cloud action fulfillment without enabling the whole syndication experience. | AssistantDevicesPlatformProtoInternalCapability | Capabilities that may only be set internally. Only internal callers (i.e. Googlers or Google owned projects) will be able to set these, thanks to go/assistant-device-model-package-ownership. | AssistantDevicesPlatformProtoCloudEndpoint |
| deviceActionsEligibleForHighConfidence | Signals that the model will have updated ranking behavior as described in https://docs.google.com/document/d/1SN_AgadRr_cdIrFe-qgRbIX2J1sOE7lcRXAvM1GUPoU. | AssistantDevicesPlatformProtoInternalCapability | Capabilities that may only be set internally. Only internal callers (i.e. Googlers or Google owned projects) will be able to set these, thanks to go/assistant-device-model-package-ownership. | boolean |
| forceSignIn | Make Google sign-in mandatory for using Google Assistant on the device. (This bit is initially added for Samsung TV.) | AssistantDevicesPlatformProtoInternalCapability | Capabilities that may only be set internally. Only internal callers (i.e. Googlers or Google owned projects) will be able to set these, thanks to go/assistant-device-model-package-ownership. | boolean |
| forceThirdPartyDeviceIdForDeviceLookup | When looking up device (for example for disclosure consent check), then always use the third party device id for lookup instead of any other device id which would normally have higher precedence, such as cast_device_id. | AssistantDevicesPlatformProtoInternalCapability | Capabilities that may only be set internally. Only internal callers (i.e. Googlers or Google owned projects) will be able to set these, thanks to go/assistant-device-model-package-ownership. | boolean |
| forceTransactionsAuthentication | Adds “transactions.AUTHENTICATION” for car automation probers. Since the probers run as Assistant SDK requests, voice match always fails for car automation requests, so we add this client op as a hack to allow probers to appear as personal devices and bypass voice match. See b/137221645. | AssistantDevicesPlatformProtoInternalCapability | Capabilities that may only be set internally. Only internal callers (i.e. Googlers or Google owned projects) will be able to set these, thanks to go/assistant-device-model-package-ownership. | boolean |
| hasCustomSearchResultsRendering | Signals that this device can “render” raw search results even with no screen (e.g., using a text reader). If this is true, fallback search results can be returned as a custom device action in a SearchResults message. http://google3/assistant/embedded/proto_translation/utils/proto/search_results.proto | AssistantDevicesPlatformProtoInternalCapability | Capabilities that may only be set internally. Only internal callers (i.e. Googlers or Google owned projects) will be able to set these, thanks to go/assistant-device-model-package-ownership. | boolean |
| overrideProjectIdForDeviceLookup | When looking up device (for example for disclosure consent check), use this project id as part of the primary key for the device lookup (i.e. instead of the device_config.agent_id.) The precedence is as follows: 1) this field, if set for the device’s device model 2) device_config.agent_id 3) device_model.project_id | AssistantDevicesPlatformProtoInternalCapability | Capabilities that may only be set internally. Only internal callers (i.e. Googlers or Google owned projects) will be able to set these, thanks to go/assistant-device-model-package-ownership. | String |
| stadiaAssistantConfig | AssistantDevicesPlatformProtoInternalCapability | Capabilities that may only be set internally. Only internal callers (i.e. Googlers or Google owned projects) will be able to set these, thanks to go/assistant-device-model-package-ownership. | AssistantDevicesPlatformProtoInternalCapabilityStadiaAssistantConfig | |
| telephoneAttribution | Telephone server is able to send attribution to user feature phone. See go/telephone-attribution. | AssistantDevicesPlatformProtoInternalCapability | Capabilities that may only be set internally. Only internal callers (i.e. Googlers or Google owned projects) will be able to set these, thanks to go/assistant-device-model-package-ownership. | boolean |
| stadiaPlatform | AssistantDevicesPlatformProtoInternalCapabilityStadiaAssistantConfig | The StadiaAssistantConfig. This field should only be set if the device model is a Stadia. | String | |
| maxValue | AssistantDevicesPlatformProtoIntValueSpec | String | ||
| minValue | AssistantDevicesPlatformProtoIntValueSpec | String | ||
| values | AssistantDevicesPlatformProtoOptionValueSpec | list(String) | ||
| name | AssistantDevicesPlatformProtoProvidedData | Provided data which augments the device action capabilities. Some built-in intents may require additional configuration to be provided. One example could be the list of channels available for the `action.intent.SelectChannel` intent. | String | |
| clientOpProperty | AssistantDevicesPlatformProtoProviderOpenCapability | AssistantApiClientOpPropertiesProviderOpenClientOpProperty | ||
| maxAssistResponseSizeBytes | Max size in bytes of the total serialized AssistResponse receivable by the client. If response exceeds this max, response may be modified by the server. | AssistantDevicesPlatformProtoResponseLimits | Specifies the size limits on responses receivable by the client. | integer |
| maxDisplayLinesBytes | Maximum size in bytes (not characters) of text the display can handle (which may be different from how much the display can show at a time due to scrolling). | AssistantDevicesPlatformProtoResponseLimits | Specifies the size limits on responses receivable by the client. | integer |
| maxSuggestionChipBytes | Maximum size in bytes (not characters) for each suggestion chip. | AssistantDevicesPlatformProtoResponseLimits | Specifies the size limits on responses receivable by the client. | integer |
| maxSuggestionChips | Maximum number of suggestion chips the device can handle to display. | AssistantDevicesPlatformProtoResponseLimits | Specifies the size limits on responses receivable by the client. | integer |
| authMechanismForRemoteRequests | Specifies auth mechanism to be used upon remote request for device action. | AssistantDevicesPlatformProtoSecurityConfig | Encapsulates security configuration for a single intent of a device model. | String |
| callCall | |call_call| specifies the support for the call.CALL clientop, and the corresponding call_call field in assistant.embedded.v1.DeviceOp. | AssistantDevicesPlatformProtoSupportedDeviceOps | This message will specify supports for fields in |assistant.embedded.v1.DeviceOp|, for a device model package. See go/easi-client-op2 for more info. Next ID: 19 | AssistantDevicesPlatformProtoCallCallCapability |
| clientReconnect | |client_reconnect| indicates support for client.RECONNECT using assistant.embedded.v1.DeviceOp. There is an alternative API/capability for client.RECONNECT specified in RoutineCapability.supports_reconnect. Client should choose between this and RoutineCapability but not both. | AssistantDevicesPlatformProtoSupportedDeviceOps | This message will specify supports for fields in |assistant.embedded.v1.DeviceOp|, for a device model package. See go/easi-client-op2 for more info. Next ID: 19 | AssistantDevicesPlatformProtoClientReconnectCapability |
| coreDismissAssistant | [core_dismiss_assistant] specifies the support for core.DISMISS_ASSISTANT client_op and the corresponding core_dismiss_assistant field in assistant.embedded.v1.DeviceOp. | AssistantDevicesPlatformProtoSupportedDeviceOps | This message will specify supports for fields in |assistant.embedded.v1.DeviceOp|, for a device model package. See go/easi-client-op2 for more info. Next ID: 19 | AssistantDevicesPlatformProtoCoreDismissAssistantCapability |
| deviceModifySetting | |device_modify_setting| specifies the support for device.MODIFY_SETTING client_op, and the corresponding device_modify_setting field in assistant.embedded.v1.DeviceOp. | AssistantDevicesPlatformProtoSupportedDeviceOps | This message will specify supports for fields in |assistant.embedded.v1.DeviceOp|, for a device model package. See go/easi-client-op2 for more info. Next ID: 19 | AssistantDevicesPlatformProtoDeviceModifySettingCapability |
| deviceTakePhoto | [device_take_photo] specifies the support for the device.TAKE_PHOTO clientop, and the corresponding device_take_photo field in assistant.embedded.v1.DeviceOp. | AssistantDevicesPlatformProtoSupportedDeviceOps | This message will specify supports for fields in |assistant.embedded.v1.DeviceOp|, for a device model package. See go/easi-client-op2 for more info. Next ID: 19 | AssistantDevicesPlatformProtoDeviceTakePhotoCapability |
| executionWait | |execution_wait| specifies the support for execution.WAIT client_op, and the corresponding execution_wait field in assistant.embedded.v1.DeviceOp. | AssistantDevicesPlatformProtoSupportedDeviceOps | This message will specify supports for fields in |assistant.embedded.v1.DeviceOp|, for a device model package. See go/easi-client-op2 for more info. Next ID: 19 | AssistantDevicesPlatformProtoExecutionWaitCapability |
| getHealthObservation | |get_health_observation| specifies the support for get_health_observation client_op, and the corresponding get_health_observation field in assistant.embedded.v1.DeviceOp. | AssistantDevicesPlatformProtoSupportedDeviceOps | This message will specify supports for fields in |assistant.embedded.v1.DeviceOp|, for a device model package. See go/easi-client-op2 for more info. Next ID: 19 | AssistantDevicesPlatformProtoGetHealthObservationCapability |
| mediaNext | AssistantDevicesPlatformProtoSupportedDeviceOps | This message will specify supports for fields in |assistant.embedded.v1.DeviceOp|, for a device model package. See go/easi-client-op2 for more info. Next ID: 19 | AssistantDevicesPlatformProtoMediaNextCapability | |
| mediaPause | AssistantDevicesPlatformProtoSupportedDeviceOps | This message will specify supports for fields in |assistant.embedded.v1.DeviceOp|, for a device model package. See go/easi-client-op2 for more info. Next ID: 19 | AssistantDevicesPlatformProtoMediaPauseCapability | |
| mediaPlayMedia | AssistantDevicesPlatformProtoSupportedDeviceOps | This message will specify supports for fields in |assistant.embedded.v1.DeviceOp|, for a device model package. See go/easi-client-op2 for more info. Next ID: 19 | AssistantDevicesPlatformProtoMediaPlayMediaCapability | |
| mediaPrevious | AssistantDevicesPlatformProtoSupportedDeviceOps | This message will specify supports for fields in |assistant.embedded.v1.DeviceOp|, for a device model package. See go/easi-client-op2 for more info. Next ID: 19 | AssistantDevicesPlatformProtoMediaPreviousCapability | |
| mediaResume | AssistantDevicesPlatformProtoSupportedDeviceOps | This message will specify supports for fields in |assistant.embedded.v1.DeviceOp|, for a device model package. See go/easi-client-op2 for more info. Next ID: 19 | AssistantDevicesPlatformProtoMediaResumeCapability | |
| mediaShowControls | AssistantDevicesPlatformProtoSupportedDeviceOps | This message will specify supports for fields in |assistant.embedded.v1.DeviceOp|, for a device model package. See go/easi-client-op2 for more info. Next ID: 19 | AssistantDevicesPlatformProtoMediaShowControlsCapability | |
| mediaStop | AssistantDevicesPlatformProtoSupportedDeviceOps | This message will specify supports for fields in |assistant.embedded.v1.DeviceOp|, for a device model package. See go/easi-client-op2 for more info. Next ID: 19 | AssistantDevicesPlatformProtoMediaStopCapability | |
| providerFulfill | |provider_fulfill| specifies the support for provider.FULFILL client_op, and the corresponding provider_fulfill field in assistant.embedded.v1.DeviceOp. | AssistantDevicesPlatformProtoSupportedDeviceOps | This message will specify supports for fields in |assistant.embedded.v1.DeviceOp|, for a device model package. See go/easi-client-op2 for more info. Next ID: 19 | AssistantDevicesPlatformProtoProviderFulfillCapability |
| providerOpen | |provider_open| specifies the support for provider.OPEN client_op, and the corresponding provider_open field in assistant.embedded.v1.DeviceOp. | AssistantDevicesPlatformProtoSupportedDeviceOps | This message will specify supports for fields in |assistant.embedded.v1.DeviceOp|, for a device model package. See go/easi-client-op2 for more info. Next ID: 19 | AssistantDevicesPlatformProtoProviderOpenCapability |
| sendChatMessage | |send_chat_message| specifies the support for the chat_message.SEND clientop, and the corresponding send_chat_message field in assistant.embedded.v1.DeviceOp. | AssistantDevicesPlatformProtoSupportedDeviceOps | This message will specify supports for fields in |assistant.embedded.v1.DeviceOp|, for a device model package. See go/easi-client-op2 for more info. Next ID: 19 | AssistantDevicesPlatformProtoSendChatMessageCapability |
| uiShowInterpreter | |ui_show_interpreter| specifies the support for ui.SHOW_INTERPRETER client_op, and the corresponding ui_show_interpreter field in assistant.embedded.v1.DeviceOp. | AssistantDevicesPlatformProtoSupportedDeviceOps | This message will specify supports for fields in |assistant.embedded.v1.DeviceOp|, for a device model package. See go/easi-client-op2 for more info. Next ID: 19 | AssistantDevicesPlatformProtoUiShowInterpreterCapability |
| maxSupportedExtendedTimerDuration | Maximum extended timer duration supported by the client. The extended timer duration is the total start-to-finish duration after an AddTimeToTimer operation. E.g. if a user sets a timer for 30 minutes, and later adds 10 minutes, the extended duration is 40 minutes. Zero or unset indicates no maximum limit. | AssistantDevicesPlatformProtoTimerCapability | Capability with regard to support of timers by the client. | AssistantApiDuration |
| maxSupportedTimerDuration | Maximum timer duration supported by the client. Zero or unset indicates no maximum limit. | AssistantDevicesPlatformProtoTimerCapability | Capability with regard to support of timers by the client. | AssistantApiDuration |
| maxSupportedTimers | Maximum number of timers that can be created on the client. Zero or unset indicates no maximum limit. | AssistantDevicesPlatformProtoTimerCapability | Capability with regard to support of timers by the client. | integer |
| supportsMutateAction | Whether the client supports the MUTATE timer action. If this is false, mutate operations may be handled by sending a pair of REMOVE and CREATE timer actions to replace the existing timer instead of mutating it. | AssistantDevicesPlatformProtoTimerCapability | Capability with regard to support of timers by the client. | boolean |
| simpleTts | A simple TTS to play. | AssistantDevicesPlatformProtoTriggerCondition | A TriggerCondition is described as a set of states which must be met by the device. It also includes instructions to the Assistant on what kind of response to execute when the condition is not met. | String |
| status | Refers to a defined ConditionalResult keyed by its status. It could be a built-in or custom ConditionalResult for this Intent. Note: the states provided by the device MUST contain all of the states required by the ConditionalResult. | AssistantDevicesPlatformProtoTriggerCondition | A TriggerCondition is described as a set of states which must be met by the device. It also includes instructions to the Assistant on what kind of response to execute when the condition is not met. | String |
| supportsStructuredTts | Specifies whether client supports out-of-band TTS synthesis. When this is enabled, client could receive TTS request message in `SpeechOutputArgs.structured_tts` which it can then use to make request to S3 for synthesizing TTS audio. | AssistantDevicesPlatformProtoTtsOutputCapability | Capabilities with regard to support of outputting TTS. | boolean |
| nluLevel | Specifies the NLU level for the intent. | AssistantDevicesPlatformProtoUnderstandingConfig | Specifies the NLU level that Google performs, which determines the request format sent to the 3P cloud. | String |
| type | AssistantDeviceTargetingDeviceTargetingError | The information associated with an error while selecting the target device. Next ID: 2 | String | |
| streams | All active media streams while the user issues the query. | AssistantLogsAllMediaStreamLog | list(AssistantLogsMediaStreamLog) | |
| targetStream | The stream selected by stream transfer logic to be transferred to another device. It will be empty for other features. Target_stream is different from target_device since target_stream could have multiple devices. | AssistantLogsAllMediaStreamLog | AssistantLogsMediaStreamLog | |
| ambiguousDeviceIndex | Device index of the initial ambiguous devices. The device index in this message is consistent with the device index in DeviceInfoLog. It would be used to track more detailed information of a device if needed. | AssistantLogsAmbiguousTargetDeviceLog | This message logs details on ambiguous device targeting logic. 1. It first takes a list of ambiguous devices 2. Then applies two filters: structure filter and playability filter. 3. If more than one device remains, it tiggers DeviceSelectionDialog to let the user pick one device. | list(integer) |
| devicesAfterPromoters | DeviceInfo for devices after the filters and promoters. – When device targeting is only configured for single target, these are ambiguous devices that would have been the output of Lumos. Downstream may perform extra check before disambiguation dialog. For example, Media Initiation checks playability for devices. The output here is before the check. – When configured for multi-target, these are just the target devices. For privacy consideration, we may only log device id field inside. | AssistantLogsAmbiguousTargetDeviceLog | This message logs details on ambiguous device targeting logic. 1. It first takes a list of ambiguous devices 2. Then applies two filters: structure filter and playability filter. 3. If more than one device remains, it tiggers DeviceSelectionDialog to let the user pick one device. | list(AssistantLogsDeviceInfoLog) |
| finalTargetDevice | the final targeted device selected by playability filter or DeviceSelectionDialog | AssistantLogsAmbiguousTargetDeviceLog | This message logs details on ambiguous device targeting logic. 1. It first takes a list of ambiguous devices 2. Then applies two filters: structure filter and playability filter. 3. If more than one device remains, it tiggers DeviceSelectionDialog to let the user pick one device. | AssistantLogsDeviceInfoLog |
| playabilityFilteredDevicesIndex | Device index of the devices after playability filter | AssistantLogsAmbiguousTargetDeviceLog | This message logs details on ambiguous device targeting logic. 1. It first takes a list of ambiguous devices 2. Then applies two filters: structure filter and playability filter. 3. If more than one device remains, it tiggers DeviceSelectionDialog to let the user pick one device. | list(integer) |
| puntInfoLog | When there is no qualified devices after playability check, it would populate punt_info below. If all devices are filtered out for the same reason, there would only be one item. Otherwise, there will be multiple items. | AssistantLogsAmbiguousTargetDeviceLog | This message logs details on ambiguous device targeting logic. 1. It first takes a list of ambiguous devices 2. Then applies two filters: structure filter and playability filter. 3. If more than one device remains, it tiggers DeviceSelectionDialog to let the user pick one device. | list(AssistantLogsAmbiguousTargetDeviceLogPuntInfoLog) |
| structureFilteredDeviceIndex | Device index of the devices after structure filter | AssistantLogsAmbiguousTargetDeviceLog | This message logs details on ambiguous device targeting logic. 1. It first takes a list of ambiguous devices 2. Then applies two filters: structure filter and playability filter. 3. If more than one device remains, it tiggers DeviceSelectionDialog to let the user pick one device. | list(integer) |
| deviceIndex | Index of devices that have the same punt info during playability check, i.e. same media_excuse and provider_mid. | AssistantLogsAmbiguousTargetDeviceLogPuntInfoLog | PuntInfoLog is used to log why devices get filtered out during media content playability check. It contains media excuse, provider mid and also index of devices filtered by them. | list(integer) |
| mediaExcuse | Excuse for media action triggering. See: assistant/verticals/media/proto/media_excuse.proto. | AssistantLogsAmbiguousTargetDeviceLogPuntInfoLog | PuntInfoLog is used to log why devices get filtered out during media content playability check. It contains media excuse, provider mid and also index of devices filtered by them. | integer |
| providerMid | Provider id that the excuse belongs to. This is the KG MID of the provider, e.g., “/m/09jcvs” for Youtube. | AssistantLogsAmbiguousTargetDeviceLogPuntInfoLog | PuntInfoLog is used to log why devices get filtered out during media content playability check. It contains media excuse, provider mid and also index of devices filtered by them. | String |
| localNetworkIdDiff | The diff between AvailableDevice and CTF for the local network ID of the device. | AssistantLogsAvailableDeviceAndCtfContextDiffLog | A list of per-device contexts and their respective diffs between AvailableDevice and CTF. | String |
| locationFeatureDiff | The diff between AvailableDevice and CTF for the feature proto of the location of the device. | AssistantLogsAvailableDeviceAndCtfContextDiffLog | A list of per-device contexts and their respective diffs between AvailableDevice and CTF. | String |
| availableDeviceInfoLog | AssistantLogsAvailableDevicesLog | Contains the available devices in DeviceTargetingContext. | list(AssistantLogsDeviceInfoLog) | |
| rawContactInfo | This list provides account information from the raw contact which is the source of this field. | AssistantLogsCommunicationDeviceContactInfoLog | This is the log version of apps.people.oz.external.mergedpeopleapi.DeviceContactInfo Next ID: 2 | list(AssistantLogsCommunicationRawDeviceContactInfoLog) |
| relativeCost | AssistantLogsCommunicationFuzzyNgramMatchLog | This is the log version of fuzzy ngram match results that’s used for generating the best fuzzy match. Next ID: 3 | number | |
| type | AssistantLogsCommunicationFuzzyNgramMatchLog | This is the log version of fuzzy ngram match results that’s used for generating the best fuzzy match. Next ID: 3 | String | |
| AssistantLogsCommunicationGoogleAccountProvenance | From google3/quality/qrewrite/proto/account_provenance.proto;l=14 We need to copy this as the above proto has Enum field which is not compatible between proto2 and proto3. go/proto2-versus-proto3#enums | String | ||
| gaiaId | AssistantLogsCommunicationGoogleAccountProvenance | From google3/quality/qrewrite/proto/account_provenance.proto;l=14 We need to copy this as the above proto has Enum field which is not compatible between proto2 and proto3. go/proto2-versus-proto3#enums | String | |
| isDasherAccount | AssistantLogsCommunicationGoogleAccountProvenance | From google3/quality/qrewrite/proto/account_provenance.proto;l=14 We need to copy this as the above proto has Enum field which is not compatible between proto2 and proto3. go/proto2-versus-proto3#enums | boolean | |
| accountProvenance | Google AccountProvenance of the contact. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | AssistantLogsCommunicationGoogleAccountProvenance |
| commonNameAliasConfidence | Populated if matched_name_type is GIVEN_NAME_ALIAS or FULL_NAME_ALIAS. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | number |
| conceptId | Concept id for relationships in English, e.g. “Mother” for all non-English locales. It’s only populated for source = RELATIONSHIP. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | String |
| deviceContactAttributes | Integer value corresponding to DeviceContactExtraMetadata.Attribute enum. http://google3/social/graph/wire/proto/merged_person.proto?l=933&rcl=320308954 | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | list(integer) |
| emailIdCount | # emails stored for the contact. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | integer |
| fuzzyNgramMatch | Populate only if ContactRecognitionAlternate.Source is ‘FUZZY_CONTACT_MATCH’. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | list(AssistantLogsCommunicationFuzzyNgramMatchLog) |
| gaiaId | Contact owner’s gaia id from cs/symbol::symbol:quality_qrewrite.PersonalContactData.shared_contact_owner_gaia_id. Only populated for is_shared = true and non sign-out mode and user is not the owner of the contact(shared contact from other user). This field is not being logged in P2. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | String |
| isContactFromSecondaryAccount | Boolean value indicating whether selected contact is from different account than the logged in account. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | boolean |
| isExactMatch | If the contact is matched exactly from the query name. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | boolean |
| isShared | If this is a shared contact. This is true in 2 cases: – User is calling their own contacts that have been marked as shared. – User is calling shared contacts from some other user’s contact list. This field is not being logged in P2. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | boolean |
| isTransliteratedMatch | Indicate the contact matches the transliterated query. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | boolean |
| isVanityContact | True if the contact is a vanity contact(has email = user’s email address). | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | boolean |
| isVisibleToGuestsRelationship | 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. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | boolean |
| matchedNameType | The matched name type of a contact candidate. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | String |
| matchedRecognitionAlternateName | Alternate recognition term which was used to match this contact. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | String |
| matchedStarlightLookupName | Ngram matched by starlight lookup for fuzzy matching in fulfillment. We need this to analyze how many contacts are returned by starlight lookup that is not matched by fuzzy matching. For example, “Komal Dear” is matched to “Komal Dr” by fuzzy match. When doing starlight lookup, “Komal” and “Dr” will be looked up separately. So “Dr xxx” will also be returned. We want to see how often this happens. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | list(String) |
| metadata | PersonMetadata of the selected contact. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | AssistantLogsCommunicationPersonMetadataLog |
| nameMatchedContactIndex | The indices of the contact in |candidate_contact| whose name matches the |selected_contact_data|. |candidate_contact|: http://google3/logs/proto/assistant/contact.proto?l=111&rcl=306283376 |selected_contact_data|: http://google3/logs/proto/assistant/contact.proto?l=108&rcl=306283376 | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | list(integer) |
| originalQueryName | The original name in the query as transcribed by ASR. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | String |
| phone | Information regarding the phone endpoints of the selected contact. Currently it is only logged for selected candidate. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | list(AssistantLogsCommunicationPhoneLog) |
| phoneNumberCount | # phone_numbers stored for the contact. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | integer |
| pkgReferenceType | Encodes if pkg_person was resolved via a name or relationship reference. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | String |
| recognitionAlternateScore | Populate only if ContactRecognitionAlternate.Source is not NONE. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | number |
| recognitionAlternateSource | Recognition alternative source type. If not none, then it indicates the personal contact data is alternative and how the alternative is fulfilled. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | String |
| relationshipMemoryCount | The number of resolved relationship names and contact pointers from Assistant Memory. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | integer |
| selectedPhone | Information regarding the selected phone endpoint. Currently it is only logged for selected candidate. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | AssistantLogsCommunicationPhoneLog |
| shortcutContactInfo | Shortcut information of the contact. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | MajelContactInformationShortcutInformation |
| source | The contact source of a contact candidate. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | String |
| systemContactGroupId | Integer value corresponding to SystemContactGroup enum. http://google3/social/graph/wire/proto/merged_person.proto?l=3151&rcl=320308954 | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | list(integer) |
| whatsappPhoneNumberCount | DEPRECATED. Use phone instead. Used before 2020-01-13. Number of phone numbers annotated with Whatsapp. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | integer |
| deviceContactInfo | AssistantLogsCommunicationPersonMetadataLog | This is the log version of apps.people.oz.external.mergedpeopleapi.PersonMetadata Next ID: 2 | list(AssistantLogsCommunicationDeviceContactInfoLog) | |
| rawDeviceContactInfo | This list provides account information from the raw contact which is the source of this field. | AssistantLogsCommunicationPhoneLog | This is the log version of apps.people.oz.external.mergedpeopleapi.Phone proto. Next ID: 3 | list(AssistantLogsCommunicationRawDeviceContactInfoLog) |
| type | Label for phone number in the Contacts app. It can have standard values provided by the app e.g. MOBILE, HOME, WORK etc, but users are allowed to modify. So essentially it becomes user content. | AssistantLogsCommunicationPhoneLog | This is the log version of apps.people.oz.external.mergedpeopleapi.Phone proto. Next ID: 3 | String |
| accountType | Account type of raw contact, e.g. “com.google” or “com.linkedin.android”. | AssistantLogsCommunicationRawDeviceContactInfoLog | This is the log version of apps.people.oz.external.mergedpeopleapi.RawDeviceContactInfo proto. Next ID: 3 | String |
| defaultSpeaker | AssistantLogsDefaultDeviceLog | Log device info of default speaker and tv | AssistantLogsDeviceInfoLog | |
| defaultTv | AssistantLogsDefaultDeviceLog | Log device info of default speaker and tv | AssistantLogsDeviceInfoLog | |
| sourceDeviceId | AssistantLogsDefaultDeviceLog | Log device info of default speaker and tv | String | |
| localDefaultDevices | AssistantLogsDefaultDevicesLog | AssistantLogsDefaultDeviceLog | ||
| nearbyDefaultDevices | Default settings of nearby devices. | AssistantLogsDefaultDevicesLog | list(AssistantLogsDefaultDeviceLog) | |
| deviceIdLog | The identification of the device. The logging version of the full DeviceId. | AssistantLogsDeviceAnnotationLog | Device annotation mention from query | list(AssistantLogsSettingsDeviceIdLog) |
| rawTextFromQuery | The raw text mentioning a device from the query, such as “any tv”. | AssistantLogsDeviceAnnotationLog | Device annotation mention from query | String |
| type | The annotation type mentioned in the query. | AssistantLogsDeviceAnnotationLog | Device annotation mention from query | String |
| userDefinedName | The matched device name set by the user, such as “big screen tv”. | AssistantLogsDeviceAnnotationLog | Device annotation mention from query | String |
| arbitrationDeviceId | Device identifier string for the current device used in the arbitration service. | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | String |
| availableDeviceAndCtfContextDiff | A list of diffs for the device’s context between AvailableDevice and CTF. | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | AssistantLogsAvailableDeviceAndCtfContextDiffLog |
| connectivity | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | String | |
| deviceId | The identification of the device. DeviceId (go/as-device-id) has multiple fields. To consloidate it to a single to make dremel easier, we use the string obtained by calling go/get-device-id. | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | String |
| deviceIdLog | The identification of the device. The logging version of the full DeviceId. | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | AssistantLogsSettingsDeviceIdLog |
| deviceIndex | We index linked devices and log these index to avoid logging device_id. device_index should always be a positive number or -1. -1 means this device is not in homegraph. | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | integer |
| deviceModelId | This is the device_model_id field in device_settings proto. It has the same value for the same type of devices. e.g. Sonos.Sonos One.S13 | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | String |
| distance | LINT.ThenChange(//depot/google3/assistant/context/proto/device_arbitration.proto:EstimatedRelativeDistance) | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | String |
| eliminatingLumosProcessor | The lumos processor which eliminated this device, if applicable | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | String |
| homeStructureId | The home structure id of the device. | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | String |
| isRemote | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | boolean | |
| isTethered | This flag indicates this is a non-local device that is tethered to local/originating device. Tethered device is a special case of is_remote and typically used in wearable scenarios. This is always false for local device and when it is true, it implies is_remote is also true. | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | boolean |
| mediaCapabilities | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | AssistantLogsMediaCapabilities | |
| mediaDeviceType | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | String | |
| name | User defined device name | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | String |
| sessions | This field should be populated only when there is at least one session on this device. | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | list(AssistantLogsDeviceMediaSessionLog) |
| surfaceType | This field should be populated only when the device is an Assistant device. | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | String |
| deviceId | AssistantLogsDeviceMediaSessionLog | Log about the media session on a device. | AssistantApiCoreTypesDeviceId | |
| mediaSessionType | AssistantLogsDeviceMediaSessionLog | Log about the media session on a device. | String | |
| mediaType | The type of the media session. If provider does not report this field, we ## compute it by mapping provider type to media type. Here is the mapping: |ProviderType |MediaItemMetadata.Type| |————————————– |MUSIC |TRACK | |VIDEO |VIDEO | |LIVE_TV |TV_CHANNEL | |AUDIOBOOK |AUDIO_BOOK | |PODCAST |PODCAST_EPISODE | ## |LIVE_STREAMING|VIDEO | | AssistantLogsDeviceMediaSessionLog | Log about the media session on a device. | String |
| playbackState | The playback states of the session. | AssistantLogsDeviceMediaSessionLog | Log about the media session on a device. | String |
| providerMid | The KG mid of the media provider. | AssistantLogsDeviceMediaSessionLog | Log about the media session on a device. | String |
| supportedTransportControl | AssistantLogsDeviceMediaSessionLog | Log about the media session on a device. | list(String) | |
| allDefaultDevices | Default settings of all nearby devices Deprecated, use default_devices_log instead. | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | list(AssistantLogsDefaultDeviceLog) |
| allMediaStreamLog | Logs all active media sessions. | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | AssistantLogsAllMediaStreamLog |
| availableDevicesLog | The list of `available_devices` as they appear in DeviceTargetingContext. This is very useful for debugging diffs between GB and CMP since they have different methods of populating the `available_devices` field. | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | AssistantLogsAvailableDevicesLog |
| counterfactualDeviceSelectionLog | DeviceSelectionLog for counterfactual logging. | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | AssistantLogsDeviceSelectionLog |
| defaultDevices | Include default tv and default speaker Deprecated, use all_default_devices below. | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | AssistantLogsDefaultDeviceLog |
| defaultDevicesLog | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | AssistantLogsDefaultDevicesLog | |
| devicesStr | Temporaray field for debugging ANDROID_AUTO multi_target_devices punt. This will be removed once we identify the root cause. | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | list(String) |
| inputErrorLog | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | list(AssistantLogsInputErrorLog) | |
| localDevice | Now we just log the media sessions on local device Deprecated, use NearbyDevicesLog::LocalDevice instead. | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | AssistantLogsDeviceInfoLog |
| logDataSource | Indicates which library populated the device_selection_log for this query. | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | String |
| mediaFocus | The Media Focus information. This field should be populated only when there is a Media Focus. Deprecated, use media_focuses below instead. | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | AssistantLogsMediaFocusInfoLog |
| mediaFocusesLog | Media focuses on all devices. | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | AssistantLogsMediaFocusesLog |
| nearbyDevicesLog | All nearby devices and local device. | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | AssistantLogsNearbyDevicesLog |
| queryAnnotation | This should log the query annotation features found in the device, such as the device annotation, the room annotation, and the structure annotation from the query. | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | AssistantLogsQueryAnnotationLog |
| selectionResult | The result of device selection. | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | AssistantLogsDeviceSelectionResultLog |
| testCodes | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | list(AssistantLogsDeviceTargetingTestCode) | |
| ambiguousTargetDevices | Deprecated, please use qualified_devices. | AssistantLogsDeviceSelectionResultLog | Log the selection result. Next ID: 11 | AssistantLogsAmbiguousTargetDeviceLog |
| deviceSelectionDecisionSummary | AssistantLogsDeviceSelectionResultLog | Log the selection result. Next ID: 11 | AssistantLogsMediaDeviceSelectionDecisionSummary | |
| deviceTargetingErrorType | AssistantLogsDeviceSelectionResultLog | Log the selection result. Next ID: 11 | String | |
| finalLumosStage | The class name for the final filter/promoter used by Lumos for device targeting. This filter or promoter runs for all users, and contains no data specific to the individual user. | AssistantLogsDeviceSelectionResultLog | Log the selection result. Next ID: 11 | String |
| lowConfidenceTargetDevice | ////////////////////////////////////////////////////////////////////////// Ambiguous Results: the library failed to select the final target device(s) but it narrows down to a set of devices which are all valid target device candidates. The client needs to do further disambiguation, e.g., giving a dialog or having customized logic. The low confidence target device means the library falied to select the target device but it picked two devices for the client to do disambiguation. | AssistantLogsDeviceSelectionResultLog | Log the selection result. Next ID: 11 | AssistantLogsLowConfidenceTargetDeviceLog |
| mediaFocusSelectionErrorType | ////////////////////////////////////////////////////////////////////////// This field log the error while selecting target device in media_focus_selector. | AssistantLogsDeviceSelectionResultLog | Log the selection result. Next ID: 11 | String |
| processorInfo | The log for each stage of Lumos, showing the number of eliminated devices from each processor. | AssistantLogsDeviceSelectionResultLog | Log the selection result. Next ID: 11 | list(AssistantLogsLumosProcessorInfo) |
| qualifiedDevices | We will apply several filters and dialogs to select a target device if media_focus_selector fail to select one. This field should log the devices left after each filter or dialog. It also log the detailed info of the final target device. | AssistantLogsDeviceSelectionResultLog | Log the selection result. Next ID: 11 | AssistantLogsAmbiguousTargetDeviceLog |
| singleTargetDevice | ////////////////////////////////////////////////////////////////////////// Unambiguous Results: the library successfully selected the final target device(s) and no further disambiguation is needed. Deprecated, please use target_device. | AssistantLogsDeviceSelectionResultLog | Log the selection result. Next ID: 11 | AssistantLogsDeviceInfoLog |
| targetDevice | AssistantLogsDeviceSelectionResultLog | Log the selection result. Next ID: 11 | AssistantLogsTargetDeviceLog | |
| type | AssistantLogsDeviceTargetingTestCode | Test code is used to track special events happening in Device Targeting Library. Next Id: 2 | String | |
| errorCode | AssistantLogsInputErrorLog | integer | ||
| errorType | AssistantLogsInputErrorLog | String | ||
| fallbackDeviceLog | The fallback device. | AssistantLogsLowConfidenceTargetDeviceLog | Represents the case where there is a target device with low confidence so that the library didn’t directly target it. Instead, the library returns the low confidence target device and the fallback device for the client to decide to either trigger a dialog to disambiguate or select one of them based on extra business logic. Next ID: 3 | AssistantLogsDeviceInfoLog |
| lowConfTargetDeviceLog | The selected low confidence focus device. | AssistantLogsLowConfidenceTargetDeviceLog | Represents the case where there is a target device with low confidence so that the library didn’t directly target it. Instead, the library returns the low confidence target device and the fallback device for the client to decide to either trigger a dialog to disambiguate or select one of them based on extra business logic. Next ID: 3 | AssistantLogsDeviceInfoLog |
| devicesAfterRun | Number of candidate devices after this stage is run. | AssistantLogsLumosProcessorInfo | integer | |
| devicesBeforeRun | Number of candidate devices before this stage is run. | AssistantLogsLumosProcessorInfo | integer | |
| processorName | Name of the processor for this stage. | AssistantLogsLumosProcessorInfo | String | |
| canReceiveRemoteAction | AssistantLogsMediaCapabilities | boolean | ||
| hasScreen | AssistantLogsMediaCapabilities | boolean | ||
| deviceSelectionPreferenceUsed | AssistantLogsMediaDeviceSelectionDecisionSummary | A summary of the reasons that we chose a certain target device. | String | |
| deviceSelectionReason | AssistantLogsMediaDeviceSelectionDecisionSummary | A summary of the reasons that we chose a certain target device. | String | |
| miscSelectionSignal | AssistantLogsMediaDeviceSelectionDecisionSummary | A summary of the reasons that we chose a certain target device. | list(String) | |
| dialogTriggered | AssistantLogsMediaFocusesLog | Following are the MDA compatible loggings for media focus, default settings and nearby devices. | boolean | |
| localMediaFocus | AssistantLogsMediaFocusesLog | Following are the MDA compatible loggings for media focus, default settings and nearby devices. | AssistantLogsMediaFocusInfoLog | |
| mediaFocuses | Deprecated, use nearby_media_focuses instead. | AssistantLogsMediaFocusesLog | Following are the MDA compatible loggings for media focus, default settings and nearby devices. | list(AssistantLogsMediaFocusInfoLog) |
| nearbyMediaFocuses | MediaFouces found on nearby devices. | AssistantLogsMediaFocusesLog | Following are the MDA compatible loggings for media focus, default settings and nearby devices. | list(AssistantLogsMediaFocusInfoLog) |
| currentFocusDurationSec | How long the device is in focus so far | AssistantLogsMediaFocusInfoLog | The information related to Media Focus. TODO(b/138952173) Deprecate MediaFocusState in logs/proto/majel_gws/media_action_triggering_info.proto and assistant/verticals/media/proto/target_device_info.proto | integer |
| dialogTriggered | TODO(b/134944092) Log MediaFocusDialogTrigger Enum in focus_status. | AssistantLogsMediaFocusInfoLog | The information related to Media Focus. TODO(b/138952173) Deprecate MediaFocusState in logs/proto/majel_gws/media_action_triggering_info.proto and assistant/verticals/media/proto/target_device_info.proto | boolean |
| focusDevice | LINT.ThenChange(//depot/google3/logs/proto/majel_gws/media_action_triggering_info.proto) The focus device. | AssistantLogsMediaFocusInfoLog | The information related to Media Focus. TODO(b/138952173) Deprecate MediaFocusState in logs/proto/majel_gws/media_action_triggering_info.proto and assistant/verticals/media/proto/target_device_info.proto | AssistantLogsDeviceInfoLog |
| mediaFocusState | The media focus state at the time of the request. | AssistantLogsMediaFocusInfoLog | The information related to Media Focus. TODO(b/138952173) Deprecate MediaFocusState in logs/proto/majel_gws/media_action_triggering_info.proto and assistant/verticals/media/proto/target_device_info.proto | String |
| sourceDeviceId | The source device of media focus. | AssistantLogsMediaFocusInfoLog | The information related to Media Focus. TODO(b/138952173) Deprecate MediaFocusState in logs/proto/majel_gws/media_action_triggering_info.proto and assistant/verticals/media/proto/target_device_info.proto | String |
| deviceIndex | The device index in this message is consistent with the device index in DeviceInfoLog. This field refers to the devices that hosting the session. | AssistantLogsMediaStreamLog | Media stream is composed of a media session and one or more devices which are hosting (playing) the session. Usually, a session is only hosted by one devcie. However, with cast group or stream transfer/expansion, a session could be hosted by multiple devices, which are playing the same session simultaneously. | list(integer) |
| session | AssistantLogsMediaStreamLog | Media stream is composed of a media session and one or more devices which are hosting (playing) the session. Usually, a session is only hosted by one devcie. However, with cast group or stream transfer/expansion, a session could be hosted by multiple devices, which are playing the same session simultaneously. | AssistantLogsDeviceMediaSessionLog | |
| deviceArbitrationCreationTimestampMs | The timestamp that DeviceArbitration is created in milliseconds. | AssistantLogsNearbyDevicesLog | String | |
| deviceTargetingInputCreationTimestampMs | The timestamp that DeviceTargetingInput is built in milliseconds. | AssistantLogsNearbyDevicesLog | String | |
| eliminatedByFurtherDistance | AssistantLogsNearbyDevicesLog | integer | ||
| eliminatedByLocalClosest | AssistantLogsNearbyDevicesLog | integer | ||
| eliminatedByUnknownDifferentRoom | AssistantLogsNearbyDevicesLog | integer | ||
| eliminatedByUnregisteredDevice | AssistantLogsNearbyDevicesLog | integer | ||
| localDevice | AssistantLogsNearbyDevicesLog | AssistantLogsDeviceInfoLog | ||
| nearbyDevices | AssistantLogsNearbyDevicesLog | list(AssistantLogsDeviceInfoLog) | ||
| numClosestDevices | AssistantLogsNearbyDevicesLog | integer | ||
| numEquallyCloseDevices | AssistantLogsNearbyDevicesLog | integer | ||
| numFurtherDevices | AssistantLogsNearbyDevicesLog | integer | ||
| numHearingDevices | AssistantLogsNearbyDevicesLog | integer | ||
| numUnknownDistanceDevices | AssistantLogsNearbyDevicesLog | integer | ||
| lang | AssistantLogsProviderAnnotationLog | Provider annotation annotated from the query. These fields contain the detailed information for the provider. (e.g. for Youtube, package_names contains “com.google.android.youtube”, localized_names contains “youtube”, and lang contains “en” from “en-US” which depends on user’s setting.) | String | |
| localizedNames | AssistantLogsProviderAnnotationLog | Provider annotation annotated from the query. These fields contain the detailed information for the provider. (e.g. for Youtube, package_names contains “com.google.android.youtube”, localized_names contains “youtube”, and lang contains “en” from “en-US” which depends on user’s setting.) | list(String) | |
| packageNames | AssistantLogsProviderAnnotationLog | Provider annotation annotated from the query. These fields contain the detailed information for the provider. (e.g. for Youtube, package_names contains “com.google.android.youtube”, localized_names contains “youtube”, and lang contains “en” from “en-US” which depends on user’s setting.) | list(String) | |
| deviceAnnotation | Deprecated, please use room_annotations. | AssistantLogsQueryAnnotationLog | Log about the query requirements | AssistantLogsDeviceAnnotationLog |
| deviceAnnotations | Log the device annotations mentioned in the query. | AssistantLogsQueryAnnotationLog | Log about the query requirements | list(AssistantLogsDeviceAnnotationLog) |
| providerAnnotation | Log the provider annotations annotated from the query. | AssistantLogsQueryAnnotationLog | Log about the query requirements | AssistantLogsProviderAnnotationLog |
| roomAnnotation | TODO(b/171250187) Deprecates the optional RoomAnnotationLog and DeviceAnnotationLog. Deprecated, please use device_annotations. | AssistantLogsQueryAnnotationLog | Log about the query requirements | AssistantLogsRoomAnnotationLog |
| roomAnnotations | Log the room annotations mentioned in the query. | AssistantLogsQueryAnnotationLog | Log about the query requirements | list(AssistantLogsRoomAnnotationLog) |
| structureAnnotations | Log the structure annotations mentioned in the query. | AssistantLogsQueryAnnotationLog | Log about the query requirements | list(AssistantLogsStructureAnnotationLog) |
| createdSecondsAgo | The reminder is created N seconds ago. This helps tracking how the user issues follow-up actions after reminder is created. For example, whether the user likes to issues another [show reminders] query right after reminder is created? | AssistantLogsReminderLog | Annotate a single reminder instance. | String |
| retrievedRankingClass | If the reminder is retrieved by a ranking class (see go/opa-reminders-ranker), this will be populated with the class info. Refer to assistant.productivity.ReminderRankingClass.RankingType. Since that proto is in proto2 format, we can only wire by int type. | AssistantLogsReminderLog | Annotate a single reminder instance. | integer |
| rawTextFromQuery | The raw text mentioning a room from the query, such as “my living room”. | AssistantLogsRoomAnnotationLog | Room annotation mentioned in query. | String |
| roomCount | The number of rooms annotated, if there are multiple structures. They are guaranteed to have the same text_from_query and name due to exact matching. | AssistantLogsRoomAnnotationLog | Room annotation mentioned in query. | integer |
| roomId | The identification of the room. | AssistantLogsRoomAnnotationLog | Room annotation mentioned in query. | list(String) |
| type | The annotation type mentioned in the query. | AssistantLogsRoomAnnotationLog | Room annotation mentioned in query. | String |
| userDefinedName | AssistantLogsRoomAnnotationLog | Room annotation mentioned in query. | String | |
| agsaClientInstanceId | The client_instance_id on devices with GSA. See ‘client_instance_field’ in go/androidids. | AssistantLogsSettingsDeviceIdLog | The logging-version of DeviceId proto, which identifies a device. This mirrors cs/google3/assistant/api/core_types/device_type.proto?q=symbol:DeviceId Next ID: 9 | String |
| alloDeviceId | Allo Id. Corresponds to the GBotRequest.Sender.sender. This ID type should be deprecated by now, yet we’ve observed it serving prod traffic in GB. | AssistantLogsSettingsDeviceIdLog | The logging-version of DeviceId proto, which identifies a device. This mirrors cs/google3/assistant/api/core_types/device_type.proto?q=symbol:DeviceId Next ID: 9 | String |
| canonicalDeviceId | A unique device ID for Assistant devices as proposed by go/ocelot-team. | AssistantLogsSettingsDeviceIdLog | The logging-version of DeviceId proto, which identifies a device. This mirrors cs/google3/assistant/api/core_types/device_type.proto?q=symbol:DeviceId Next ID: 9 | String |
| castDeviceId | If set, indicates that the device is a cast device, and contains the UUID of the cast device. Corresponds to the device_id field of the CastDevice proto. | AssistantLogsSettingsDeviceIdLog | The logging-version of DeviceId proto, which identifies a device. This mirrors cs/google3/assistant/api/core_types/device_type.proto?q=symbol:DeviceId Next ID: 9 | String |
| clientInstanceId | DUSI (go/dusi) is used as the identifier here. This identifier is unique to the user and device. This will help identify which device or application the user’s request originated from. This is not to be confused with the client_instance_id that android devices provide. This is currently used by surfaces that use the assistant-legacy-nexus and assistant-legacy-clockwork pipelines. DUSI is created and set in S3. This field is only filled for GAIA requests. | AssistantLogsSettingsDeviceIdLog | The logging-version of DeviceId proto, which identifies a device. This mirrors cs/google3/assistant/api/core_types/device_type.proto?q=symbol:DeviceId Next ID: 9 | String |
| deviceConfigId | The unique DeviceConfig to the specific third party device. It is also used by Android Auto Embedded first party device. See go/opa-ids. | AssistantLogsSettingsDeviceIdLog | The logging-version of DeviceId proto, which identifies a device. This mirrors cs/google3/assistant/api/core_types/device_type.proto?q=symbol:DeviceId Next ID: 9 | String |
| homeGraphDeviceId | The unique device ID for HomeGraph devices. This is the HomeGraph ID, created when the device is registered into HomeGraph. It is immutable for the same device unless it is completely deleted and recreated. See go/home-graph for details. } | AssistantLogsSettingsDeviceIdLog | The logging-version of DeviceId proto, which identifies a device. This mirrors cs/google3/assistant/api/core_types/device_type.proto?q=symbol:DeviceId Next ID: 9 | String |
| libassistantDeviceId | The unique ID for libassistant based devices. | AssistantLogsSettingsDeviceIdLog | The logging-version of DeviceId proto, which identifies a device. This mirrors cs/google3/assistant/api/core_types/device_type.proto?q=symbol:DeviceId Next ID: 9 | String |
| opaIosDeviceId | The unique device ID for the Assistant App on iOS. See go/opa-ios-design for details. | AssistantLogsSettingsDeviceIdLog | The logging-version of DeviceId proto, which identifies a device. This mirrors cs/google3/assistant/api/core_types/device_type.proto?q=symbol:DeviceId Next ID: 9 | String |
| rawTextFromQuery | The raw text mentioning a structure from the query, such as “my house”. | AssistantLogsStructureAnnotationLog | Structure annotation mentioned in query. | String |
| structureId | The identification of the structure. | AssistantLogsStructureAnnotationLog | Structure annotation mentioned in query. | list(String) |
| type | The annotation type mentioned in the query. | AssistantLogsStructureAnnotationLog | Structure annotation mentioned in query. | String |
| userDefinedName | AssistantLogsStructureAnnotationLog | Structure annotation mentioned in query. | String | |
| devices | AssistantLogsTargetDeviceLog | Represents the case where the library successfully selects the target device. It could be one or multiple devices. Next ID: 4 | list(AssistantLogsDeviceInfoLog) | |
| lowConfidenceReason | AssistantLogsTargetDeviceLog | Represents the case where the library successfully selects the target device. It could be one or multiple devices. Next ID: 4 | String | |
| resultConfidenceLevel | AssistantLogsTargetDeviceLog | Represents the case where the library successfully selects the target device. It could be one or multiple devices. Next ID: 4 | String | |
| deviceName | AssistantPfrDeviceRdMetadata | String | ||
| deviceTypes | AssistantPfrDeviceRdMetadata | list(String) | ||
| effectiveArgSpanLength | AssistantPfrDeviceRdMetadata | number | ||
| hasAmbiguousResolutions | True if there are more than one possible resolutions to the RD. | AssistantPfrDeviceRdMetadata | boolean | |
| hasResolvedDeviceId | True if there’s at least one device id that gets resolved. Note this is different from is_grounded = true: it is possible that is_grounded = false (num_grounded_args =0) but there is resolved device ids. E.g.: “turn on the blue light” Power_on(device_object = [d1, d2]:RD(category=DeviceObject(name=’blue light’)) where there are “blue light 1” and “blue light 2” hence two resolved device ids. But since the quantifier is single, GB can’t resolve the ambiguity and would set num_grounded_args = 0 to indicate such unresolved ambiguity. | AssistantPfrDeviceRdMetadata | boolean | |
| roomName | AssistantPfrDeviceRdMetadata | String | ||
| deviceRdMetadata | Each DeviceRdMetadata represents one device RD (device slot) in the intent. Note that each device RD could have multiple device groundings inside of it. | AssistantPfrSmartHomeIntentMetadata | Used by the Smarthome Business Rules twiddler to determine whether to replace the top-scoring Smarthome intent with another. | list(AssistantPfrDeviceRdMetadata) |
| intentName | AssistantPfrSmartHomeIntentMetadata | Used by the Smarthome Business Rules twiddler to determine whether to replace the top-scoring Smarthome intent with another. | String | |
| isExactMatch | When num_constraints == num_constraints_satisfied, indicating all slot matchings are exact match. | AssistantPfrSmartHomeIntentMetadata | Used by the Smarthome Business Rules twiddler to determine whether to replace the top-scoring Smarthome intent with another. | boolean |
| isGrounded | When num_grounded_args > 0, indicating there is at least one top-level argument is grounded. | AssistantPfrSmartHomeIntentMetadata | Used by the Smarthome Business Rules twiddler to determine whether to replace the top-scoring Smarthome intent with another. | boolean |
| fingerprint | AssistantPfrTiebreakingMetadata | Features used by the PrefulfillmentRanker’s scorer exclusively to break ties. | String | |
| sortedNameString | AssistantPfrTiebreakingMetadata | Features used by the PrefulfillmentRanker’s scorer exclusively to break ties. | String | |
| fulfillableDominantMedia | Whether this is a fulfillable, dominant Media intent. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| generatedByLegacyAquaDomain | Whether or not the intent was generated by a legacy Aqua domain that PFR should care about. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| hasAnswerGroup | Whether the interpretation has a Search answer group object, signifying it came from Search resolution. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| subIntentType | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | String | |
| isIntentFromOrbit | Whether the intent is from ORBIT. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| usesGroundingBox | Whether the interpretation should run through grounding box or not. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| effectiveArgSpanLength | 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). | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | number |
| phase | Query understanding phase the intent was produced in. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | String |
| isFullyGrounded | Whether the intent is fully grounded. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| isSageInNageIntent | 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). | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| isSageDisabledIntent | Whether the intent is an intent marked disabled by the Sage IG. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| deepMediaDominant | Whether the intent is dominant according to NSP deep-media. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| isVideoIntent | Whether the intent is a media object video intent. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| parsingScoreMse8BucketId | A ID corresponding to which bucket a given parsing score belongs in. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | integer |
| predictedIntentConfidence | Intent confidence predicted by the AssistantVerticalClassifier QRewrite servlet. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | number |
| nspIntentParseScore | Parse score generated by NSP. If NSP intent has been pruned due to dededuplication, It will have highest parse score for deduplicated intent. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | float |
| numConstraints | Signals as proposed in go/improved-grounding-signals. Sum of the number of constraints used by the Grounding Box to ground each variable. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | float |
| isPodcastIntent | Whether the intent is a podcast intent. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| isDummyIntent | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean | |
| isScoreBasedIntent | Whether this intent is a score-based intent, relying on PFR for scoring and pruning to the top intent. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| platinumSource | Whether the intent comes from the Sage IntentGenerator’s “platinum” source, signifying high-confidence in quality. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| nspRank | Rank of the intent as reported by NSP. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | integer |
| dominant | Indicates interpretation dominance predicted by KScorer | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| isRadioIntent | Whether the intent is a PlayMedia radio intent. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| searchDispatch | The determination made by the SearchDispatchingConfig as to whether and how this interpretation should be dispatched to Search. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | String |
| isHighConfidencePodcastIntent | Used for PFR manual rule to prefer high confidence podcast intent (e.g. topical, genre) over generic podcast intents. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| calibratedParsingScore | A parsing score that is independently calibrated by each parser/IG. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | float |
| intentNameAuisScoreExp | Assistant User Interaction Score which is aggregated using intent name from exp laelaps. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | float |
| inQueryMaxEffectiveArgSpanLength | 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). | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | number |
| pq2tVsAssistantIbstCosine | 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. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | float |
| isTvmIntent | Whether the intent is a media object tvm intent. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| numGroundedArgs | Number of grounded arguments the intent has, populated by the Grounding Box. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | float |
| numGroundableArgs | Grounding Signals. Number of groundable arguments the intent has, populated by the Grounding Box. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | float |
| intentType | 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”. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | String |
| pq2tVsIbstCosine | 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. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | float |
| isNspIntent | Whether this interpretation was genearted by NSP. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| isSageIntent | Whether this intent was generated by Sage. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| intentNameAuisScore | QUS intent-based ranking signals. Assistant User Interaction Score which is aggregated using intent name. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | float |
| kScore | Used for PFR manaul rule to prefer high kscore radio intent. The k-score comes from twiddled_ranking_scores in query interpretations. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | number |
| isAquaMediaIntent | Whether the intent aqua intent from media domain enabled in QBT | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| isValidSmarthomeIntent | Whether the intent is a Smarthome-domain intent with valid device arguments. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| tiebreakingMetadata | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | AssistantPfrTiebreakingMetadata | |
| smarthomeIntentMetadata | SmartHome intent metadata used for the SmartHome business-rules twiddler. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | AssistantPfrSmartHomeIntentMetadata |
| numConstraintsSatisfied | 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. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | float |
| isMediaControlIntent | Whether the intent is a media control intent. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| isPodcastGenericIntent | Used for PFR manual rule to prefer high confidence podcast intent (e.g. topical, genre) over generic podcast intents. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| maxHgrScoreAcrossBindingSets | The maximum score assigned by the Horizontal Grounding Ranker (HGR) across all of the intent’s binding sets. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | float |
| intentName | intent_name is used by PFR ensemble model. See go/pfr_ha_launch_doc | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | String |
| kscorerRank | 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. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | integer |
| isPlayGenericMusic | Whether the intent is a PlayGenericMusic-type intent. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| name | [REQUIRED] The name of the list item. | AssistantProductivityListItem | A message to represent an item in a list. Just a basic string for now, but extensible for the future. | String |
| id | REQUIRED. An unique identifier for the attachment. We have a plan to index this field, so it’s marked as REQUIRED. Chat with opa-reminders-eng@ if you have a use case without an attachment ID. | AssistantRemindersAttachment | Proto descrbing an attachment to an Assistant Reminder. If the attachment has different behavior on different surfaces (e.g., deeplinks), there will be multiple attachments attach to the Reminder. Each of them will specify the surface type and the corresponding deeplink. | String |
| link | AssistantRemindersAttachment | Proto descrbing an attachment to an Assistant Reminder. If the attachment has different behavior on different surfaces (e.g., deeplinks), there will be multiple attachments attach to the Reminder. Each of them will specify the surface type and the corresponding deeplink. | AssistantRemindersAttachmentLink | |
| surfaceType | REQUIRED. Surface types this attachment should be shown. | AssistantRemindersAttachment | Proto descrbing an attachment to an Assistant Reminder. If the attachment has different behavior on different surfaces (e.g., deeplinks), there will be multiple attachments attach to the Reminder. Each of them will specify the surface type and the corresponding deeplink. | list(String) |
| linkUrl | REQUIRED. The link to surface to frontends (e.g., Hubpage, notifications.) This could also be a surface-specific deeplink (be sure to set `surface_type` accordingly.) | AssistantRemindersAttachmentLink | String | |
| notificationText | REQUIRED. The text for the notification link button. Note: We cannot take nlp_generation.TemplateData yet due to cyclic dependency. The plan is to cut dependency from TemplateData to quality.actions.Reminder. DEPRECATED. No longer used as part of the notification flow. | AssistantRemindersAttachmentLink | AssistantRemindersNlgTemplateKey | |
| hasReferencedEntityAtCreation | Whether the reminder created has a referenced_entity attached to it or not(go/hub-memory-payload). Since we plan to set this in Assistant reminder creation path flow, in case later the referenced_entity is removed from the reminder, then this bit might still remain true. Also in case referenced_entity is later added to reminder(for example when referenced_entity is attached by Server), then also this bit might remain false. This bit will be used to *guess* if the user has a memory-enabled AGSA, thus we’ll surface the “open memory” button on hubpage. This check is not perfect, as the user might have other phones with older AGSA, so this is just a *best guess*. This field won’t be stored in Memory backend, and will not be populated back when retrieving reminders. | AssistantRemindersMemoryPayload | Since this is stored in BE, any update on this proto needs LGTM by ARIS storage owner | boolean |
| recordId | Id of record that is associated with Reminder. This will be set for all Assistant reminders created after the first launch of the Reminder Memory integration, see go/reminders-memory for more details. Also, this might apply to all other types of reminders. | AssistantRemindersMemoryPayload | Since this is stored in BE, any update on this proto needs LGTM by ARIS storage owner | String |
| messageSet | REQUIRED. | AssistantRemindersNlgTemplateKey | Equivalent to nlp_generation.TemplateKey. We cannot use nlp_generation.TemplateKey message directly becasue that proto is defined in a relatively large proto and has other dependencies, which will increase the size unnecessary and might hit many limitations (e.g., 5MiB limitation for Spanner type environment.). | String |
| templateName | REQUIRED. | AssistantRemindersNlgTemplateKey | Equivalent to nlp_generation.TemplateKey. We cannot use nlp_generation.TemplateKey message directly becasue that proto is defined in a relatively large proto and has other dependencies, which will increase the size unnecessary and might hit many limitations (e.g., 5MiB limitation for Spanner type environment.). | String |
| hasLocationInterpretation | Whether the nickname could also refer to a location. For example, “walmart”, “starbucks”. | AssistantTeleportTeleportNicknameSignals | boolean | |
| installInfo | Indicates whether the user has the app installed. | AssistantTeleportTeleportNicknameSignals | String | |
| isGeneric | True when the name is generic, i.e when it could refer to multiple packages from different developrs. For example, “mail” is considered a generic name (since it can refer to “gmail”, “yahoo mail” etc.) but “facebook” although could refer to both “facebook” and “facebook lite” is not considered generic (both packages are from the same third party). | AssistantTeleportTeleportNicknameSignals | boolean | |
| nicknameTier | The tier of the nickname. | AssistantTeleportTeleportNicknameSignals | String | |
| source | AssistantTeleportTeleportNicknameSignals | String | ||
| matchScore | Neural contact match similarity score. | AssistantVerticalsCommonContactMatchSignal | Neural contact match signals. | number |
| contextId | Actions-on-Google action context ID. See go/sdm-hospitality-design. | AssistantVerticalsHomeautomationProtoActionProjectConfig | Metadata for Actions-on-Google configuration. | String |
| agentId | The agent’s ID. Generally it is the agent’s Google pantheon project id. | AssistantVerticalsHomeautomationProtoAgentDeviceId | An agent + device pair that uniquely identifies a device. | String |
| deviceId | Device ID defined by the agent. | AssistantVerticalsHomeautomationProtoAgentDeviceId | An agent + device pair that uniquely identifies a device. | String |
| authType | AssistantVerticalsHomeautomationProtoAgentInformation | AgentInformation represents the details needed to support both 1P and 3P partnerships for Home Automation. Next ID: 7 | String | |
| deviceSource | AssistantVerticalsHomeautomationProtoAgentInformation | AgentInformation represents the details needed to support both 1P and 3P partnerships for Home Automation. Next ID: 7 | String | |
| executionPath | AssistantVerticalsHomeautomationProtoAgentInformation | AgentInformation represents the details needed to support both 1P and 3P partnerships for Home Automation. Next ID: 7 | String | |
| id | Unique Agent ID which maps to a specific Agent. Not using Agent Name here as it may change over time. | AssistantVerticalsHomeautomationProtoAgentInformation | AgentInformation represents the details needed to support both 1P and 3P partnerships for Home Automation. Next ID: 7 | String |
| key | Agent’s foreign key that uniquely identifies a user’s device. | AssistantVerticalsHomeautomationProtoAgentInformation | AgentInformation represents the details needed to support both 1P and 3P partnerships for Home Automation. Next ID: 7 | String |
| structureBasedRoutine | AssistantVerticalsHomeautomationProtoAttribute | Protos representing device or structure attributes. See go/hgs-attributes-protos. Only protos approved and formalized by assistant/HG team should be added here. | AssistantVerticalsHomeautomationProtoCommonStructureBasedRoutine | |
| attributeProtos | AssistantVerticalsHomeautomationProtoAttributes | LINT.IfChange(proto_attributes) | list(AssistantVerticalsHomeautomationProtoAttribute) | |
| enabled | AssistantVerticalsHomeautomationProtoCommonEventTrigger | LINT.IfChange(proto_event_trigger) Next id: 5 | boolean | |
| eventTriggerPayload | Detailed settings for the event trigger; unset if not applicable. | AssistantVerticalsHomeautomationProtoCommonEventTrigger | LINT.IfChange(proto_event_trigger) Next id: 5 | map |
| eventTriggerType | Different event type may have different settings. For example: * SCHEDULED will have event_trigger_payload of cs/symbol:assistant.verticals.voice_shortcut.proto.Schedule * LOCATION will have event_trigger_payload of cs/symbol:assistant.verticals.voice_shortcut.proto.LocationTriggerEvent | AssistantVerticalsHomeautomationProtoCommonEventTrigger | LINT.IfChange(proto_event_trigger) Next id: 5 | String |
| triggerSource | Unique identifier for the EventTrigger, e.g. SCHEDULED_ROUTINES. See the enum values of cs/symbol:WorkflowTriggerInput.TriggerSource | AssistantVerticalsHomeautomationProtoCommonEventTrigger | LINT.IfChange(proto_event_trigger) Next id: 5 | integer |
| enabled | Whether this Routine is enabled or not. If false, then this Routine can’t be triggered by Voice. | AssistantVerticalsHomeautomationProtoCommonStructureBasedRoutine | Routines team stores the core Structure Based Routine data as the payload. We will add specific metadata on a per-need basis. LINT.IfChange(proto_structure_based_routine) Next id: 12 These two forms of payload are equivalent data in different formats and both will be stored in Home Graph. 1. The internal format will fan out to the DynamicEntity Footprints for read in Settings flow and Execution. 2. The UI format will be stripped out upon replication to DynamicEntity Footprints due to its redundancy and the Footprints data size limit, i.e. DE Footprints will only contain the internal format. | boolean |
| googlePreconfigWorkflowId | The unique identifier for a class of workflows. For example: * “sbr_001” => Away * “sbr_002” => Home * “category_template” => CUSTOM | AssistantVerticalsHomeautomationProtoCommonStructureBasedRoutine | Routines team stores the core Structure Based Routine data as the payload. We will add specific metadata on a per-need basis. LINT.IfChange(proto_structure_based_routine) Next id: 12 These two forms of payload are equivalent data in different formats and both will be stored in Home Graph. 1. The internal format will fan out to the DynamicEntity Footprints for read in Settings flow and Execution. 2. The UI format will be stripped out upon replication to DynamicEntity Footprints due to its redundancy and the Footprints data size limit, i.e. DE Footprints will only contain the internal format. | String |
| language | AssistantVerticalsHomeautomationProtoCommonStructureBasedRoutine | Routines team stores the core Structure Based Routine data as the payload. We will add specific metadata on a per-need basis. LINT.IfChange(proto_structure_based_routine) Next id: 12 These two forms of payload are equivalent data in different formats and both will be stored in Home Graph. 1. The internal format will fan out to the DynamicEntity Footprints for read in Settings flow and Execution. 2. The UI format will be stripped out upon replication to DynamicEntity Footprints due to its redundancy and the Footprints data size limit, i.e. DE Footprints will only contain the internal format. | String | |
| payload | Internal format payload primarily for Routines team use. | AssistantVerticalsHomeautomationProtoCommonStructureBasedRoutine | Routines team stores the core Structure Based Routine data as the payload. We will add specific metadata on a per-need basis. LINT.IfChange(proto_structure_based_routine) Next id: 12 These two forms of payload are equivalent data in different formats and both will be stored in Home Graph. 1. The internal format will fan out to the DynamicEntity Footprints for read in Settings flow and Execution. 2. The UI format will be stripped out upon replication to DynamicEntity Footprints due to its redundancy and the Footprints data size limit, i.e. DE Footprints will only contain the internal format. | map |
| securityLevel | The security level of the Structure Based Routine as determined by the most security-sensitive task. | AssistantVerticalsHomeautomationProtoCommonStructureBasedRoutine | Routines team stores the core Structure Based Routine data as the payload. We will add specific metadata on a per-need basis. LINT.IfChange(proto_structure_based_routine) Next id: 12 These two forms of payload are equivalent data in different formats and both will be stored in Home Graph. 1. The internal format will fan out to the DynamicEntity Footprints for read in Settings flow and Execution. 2. The UI format will be stripped out upon replication to DynamicEntity Footprints due to its redundancy and the Footprints data size limit, i.e. DE Footprints will only contain the internal format. | String |
| shared | AssistantVerticalsHomeautomationProtoCommonStructureBasedRoutine | Routines team stores the core Structure Based Routine data as the payload. We will add specific metadata on a per-need basis. LINT.IfChange(proto_structure_based_routine) Next id: 12 These two forms of payload are equivalent data in different formats and both will be stored in Home Graph. 1. The internal format will fan out to the DynamicEntity Footprints for read in Settings flow and Execution. 2. The UI format will be stripped out upon replication to DynamicEntity Footprints due to its redundancy and the Footprints data size limit, i.e. DE Footprints will only contain the internal format. | boolean | |
| storagePayload | AssistantVerticalsHomeautomationProtoCommonStructureBasedRoutine | Routines team stores the core Structure Based Routine data as the payload. We will add specific metadata on a per-need basis. LINT.IfChange(proto_structure_based_routine) Next id: 12 These two forms of payload are equivalent data in different formats and both will be stored in Home Graph. 1. The internal format will fan out to the DynamicEntity Footprints for read in Settings flow and Execution. 2. The UI format will be stripped out upon replication to DynamicEntity Footprints due to its redundancy and the Footprints data size limit, i.e. DE Footprints will only contain the internal format. | map | |
| structureId | AssistantVerticalsHomeautomationProtoCommonStructureBasedRoutine | Routines team stores the core Structure Based Routine data as the payload. We will add specific metadata on a per-need basis. LINT.IfChange(proto_structure_based_routine) Next id: 12 These two forms of payload are equivalent data in different formats and both will be stored in Home Graph. 1. The internal format will fan out to the DynamicEntity Footprints for read in Settings flow and Execution. 2. The UI format will be stripped out upon replication to DynamicEntity Footprints due to its redundancy and the Footprints data size limit, i.e. DE Footprints will only contain the internal format. | String | |
| triggers | Voice or event triggers. | AssistantVerticalsHomeautomationProtoCommonStructureBasedRoutine | Routines team stores the core Structure Based Routine data as the payload. We will add specific metadata on a per-need basis. LINT.IfChange(proto_structure_based_routine) Next id: 12 These two forms of payload are equivalent data in different formats and both will be stored in Home Graph. 1. The internal format will fan out to the DynamicEntity Footprints for read in Settings flow and Execution. 2. The UI format will be stripped out upon replication to DynamicEntity Footprints due to its redundancy and the Footprints data size limit, i.e. DE Footprints will only contain the internal format. | list(AssistantVerticalsHomeautomationProtoCommonStructureBasedRoutineTrigger) |
| type | AssistantVerticalsHomeautomationProtoCommonStructureBasedRoutine | Routines team stores the core Structure Based Routine data as the payload. We will add specific metadata on a per-need basis. LINT.IfChange(proto_structure_based_routine) Next id: 12 These two forms of payload are equivalent data in different formats and both will be stored in Home Graph. 1. The internal format will fan out to the DynamicEntity Footprints for read in Settings flow and Execution. 2. The UI format will be stripped out upon replication to DynamicEntity Footprints due to its redundancy and the Footprints data size limit, i.e. DE Footprints will only contain the internal format. | String | |
| uiPayload | UI format payload primarily for external team use. | AssistantVerticalsHomeautomationProtoCommonStructureBasedRoutine | Routines team stores the core Structure Based Routine data as the payload. We will add specific metadata on a per-need basis. LINT.IfChange(proto_structure_based_routine) Next id: 12 These two forms of payload are equivalent data in different formats and both will be stored in Home Graph. 1. The internal format will fan out to the DynamicEntity Footprints for read in Settings flow and Execution. 2. The UI format will be stripped out upon replication to DynamicEntity Footprints due to its redundancy and the Footprints data size limit, i.e. DE Footprints will only contain the internal format. | map |
| eventTrigger | AssistantVerticalsHomeautomationProtoCommonStructureBasedRoutineTrigger | Next id: 3 | AssistantVerticalsHomeautomationProtoCommonEventTrigger | |
| voiceTrigger | AssistantVerticalsHomeautomationProtoCommonStructureBasedRoutineTrigger | Next id: 3 | AssistantVerticalsHomeautomationProtoCommonVoiceTrigger | |
| query | AssistantVerticalsHomeautomationProtoCommonVoiceTrigger | LINT.IfChange(proto_voice_trigger) Next id: 2 | String | |
| conciergeProductFeatures | AssistantVerticalsHomeautomationProtoConciergeFeatures | The Concierge features a structure is eligible for. See {@link home.graph.common.ConciergeFeatures}. | list(String) | |
| annotatedSpanDevice | The query span for device mention. | AssistantVerticalsHomeautomationProtoDeviceTargetingOutputQueryInfo | Next ID: 5 | String |
| annotatedSpanRoom | The query span for room mention. | AssistantVerticalsHomeautomationProtoDeviceTargetingOutputQueryInfo | Next ID: 5 | String |
| annotatedSpanStructure | The query span for structure mention. | AssistantVerticalsHomeautomationProtoDeviceTargetingOutputQueryInfo | Next ID: 5 | String |
| processedMentionedSpan | This field is from query_info.processed_mentioned_span in DTO. | AssistantVerticalsHomeautomationProtoDeviceTargetingOutputQueryInfo | Next ID: 5 | String |
| supportedStructureFeatures | The features that are available for a structure. Will only be populated if the item_type == STRUCTURE. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | AssistantVerticalsHomeautomationProtoSupportedStructureFeatures |
| traitRoutingHints | For SHED devices, some traits can only be executed on 3P cloud, e.g. “action.devices.traits.MediaInitiation”, “action.devices.traits.Channel” go/shed-per-trait-routing | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | list(HomeGraphCommonTraitRoutingHints) |
| parentNode | LINT.IfChange(home_graph_single_parent) At the moment, we just have a single string. In future this will expand with additional metadata from client or cloud execution data store. In today’s ‘tree’ HomeGraph each object has a single parent. In the future this may have a mesh for complex cases — zones, doors, etc — so we make this a repeated element today. LINT.ThenChange(//depot/google3/assistant/assistant_server/settings/user_defined_actions/footprints/footprint_accessor.cc:home_graph_single_parent) | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | list(String) |
| actionProjectConfigs | Custom actions that this item supports. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | list(AssistantVerticalsHomeautomationProtoActionProjectConfig) |
| zoneNameSaftDocument | SAFT Document with linguistic annotations for the zone name, if applicable. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | NlpSaftDocument |
| operationalNodeId | Operational CHIP Node ID that combines the fabric ID and node id in format of . (Hex format without 0x prefix, for example, 0F001234FA67AA39.1234ABCD1111DDDD). | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | String |
| saftDocument | SAFT Document with linguistic annotations for the primary device name. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | NlpSaftDocument |
| opaqueCustomData | Store custom data for agent calls here. This will likely be short-lived — we will replace this with calls to HGS. (Note: This may end up not temporary if we only need it for a couple partners — more efficient to have it on a few users than require HGS reads for all users. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | String |
| lanscanOptedIn | Whether local home platform should discover new devices via LAN for the structure. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | boolean |
| plural | We use this to determine if the synonyms matched in the aqua interpretation is plural. Then we will return disambiguate dialog or execute commands with all the targets. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | list(String) |
| deviceModelId | See note in home_graph.proto; loaded into DE now to avoid having to double-read assistant settings records as per go/smarthome-removing-assistant-settings | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | String |
| notificationSupportedByAgent | Indicates whether the device is capable of sending notifications. This field will be set by the agent (partner) on an incoming SYNC. If a device is not capable of generating notifications, the partner should set this flag to false. If a partner is not capable of calling ReportStateAndNotification to send notifications to Google, the partner should set this flag to false. If there is a user setting in the partner app to enable notifications and it is turned off, the partner should set this flag to false. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | boolean |
| parentType | The type of the parent. Currently only set for devices, to distinguish between structure and room parents. Items currently have only one parent, and entries after the first parent_type are ignored. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | list(String) |
| gcmExecutionAddress | GCM address for cloud execution across google cloud messaging rather than 3p cloud. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | String |
| smartDeviceManagementData | Data needed for SDM (fleet management). See go/enterprise-id-in-assistant. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | AssistantVerticalsHomeautomationProtoSmartDeviceManagementData |
| voiceMatchRequired | Set to which level of voice match is needed. Enum based on string input from the partner in json sync. Values accepted: “none” (but in this case partners won’t set it), “owner” [requires matching one of the creator gaia IDs], or “member” [any recognized voice ‘enrolled’ on the device]. This may expand; only “owner” is in use for first partner, Tile. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | String |
| personalizedNicknames | User-given nicknames for an entity (e.g. “My house”). These nicknames are unique to the gaia user. Nickname in DeviceInfo is per-entity level nickname, while personalized_nicknames is per-user per-entity. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | list(String) |
| primaryName | Which of the values was the original, user-provided name — or our disambiguated, cleaned-up version of it. This is what we use in TTS when we need to identify an object that wasn’t just spoken uniquely by the user — in disambiguation dialogue, or in response to a collective interrogative (e.g. “what lights are on in the kitchen?”) | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | String |
| attributes | Attributes data as provided from SYNC. This gets used in mutation and execution and in some potential cases, in biasing. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | map |
| hashValue | The hash value from go/de-consistency-check | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | String |
| willReportState | This device will report state; we can query realtime state from local HGS rather than slow QUERY intent to the 3p cloud. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | boolean |
| matterUniqueId | Matter Unique ID. Contains VID/PID information | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | AssistantVerticalsHomeautomationProtoMatterUniqueId |
| userDefinedDeviceType | The priority order of speech targeting: 1. user_defined_device_type 2. derived_device_type 3. device_type | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | String |
| supportsDirectResponse | This device supports direct response — if the device itself is issuing the query (which means it’s also an assistant surface) we can return its payload directly rather than via cloud. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | boolean |
| targetDeviceSignalStrengths | Only present for an AoGH device. HGS Device ID of a target device and the signal strength (RSSI in dB, higher is better) between that target device and the AoGH device. If this map is empty, there are no target devices reachable by this AoGH device. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | map |
| roleInformation | User’s role information for this device. This will be used in Home Automation server to decide if user has authority to fulfill its request. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | AssistantVerticalsHomeautomationProtoRoleInformation |
| assistantDeviceId | Device ID that matches the ID passed from the device to discourse_context when a user issues a query to an Assistant-enabled device that is registered with Cast (via CCS (see go/castservers)), or some other service. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | String |
| derivedType | Any types that are not the given item type, but derived later. For example, if an item has type action.devices.types.OUTLET but is named “floor lamp” we can derive that it also has type action.devices.types.LIGHT. Also considered along with |type| when triggering type-based actions. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | list(String) |
| modelName | Model name from HomeGraph, populated from model_manifest.model_name. See b/200087451. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | String |
| notificationEnabledByUser | Indicates whether notifications have been enabled by a user and will be announced for this device. This is set by the user within the Google app settings, and Google will announce the device notification only if both notification_supported_by_agent and notification_enabled_by_user are true. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | boolean |
| otherDeviceIds | Other agent id + foreign id pairs associated with the device. This can be used to represent a group of devices (e.g. Sonos’ bonded zone) as a single device, or a device that comes in through different sync flows (e.g. Newman with a Nest camera). | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | list(AssistantVerticalsHomeautomationProtoAgentDeviceId) |
| smartHomeFeatures | SmartHome feature flags that may be enabled per-item. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | AssistantVerticalsHomeautomationProtoSmartHomeFeatures |
| type | The item type, such as “action.devices.types.VACUUM” – to be used in triggering type-based actions, e.g. “start vacuuming”: go/smarthome-type-based-actions. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | String |
| tdssUpdateTimestamp | The timestamp at which the TDSS map was last updated. This information is used to help determine which hub would be preferred if multiple hubs report the same reach-ability for a device. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | DateTime |
| creatorGaiaId | See Device.creator_gaia_ids in //home/graph/proto/service/types.proto. If empty, the GAIA ID from the request EUC is assumed to be the creator. We only need at most one creator_gaia_id. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | String |
| reportStateStatus | Whether device report state is out of sync with Query response. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | String |
| routableViaGcm | Only present for a target device. Indicates this target device is reachable by a local (AoGH) path via an AoGH device. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | boolean |
| groupIds | List of parent group IDs, if the device is added to one or multiple device groups (see go/home-groups). Will be consumed by Smart Home APIs and (in the future) Assistant CTF to populate the group member list of device groups. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | list(String) |
| physicalLocation | Stores the location for the STRUCTURE type. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | AssistantVerticalsHomeautomationProtoPhysicalLocation |
| otherDeviceSources | Additional device sources. This can be the result of the device being merged with other devices with a different source. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | list(String) |
| agentInformation | Agent details. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | AssistantVerticalsHomeautomationProtoAgentInformation |
| traits | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaDataSupportedTraits | list(String) | ||
| deviceSelectionLog | the next 3 fields are for Lumos output (DTO) that needs to be propagated to the Fulfilment through the HomeAutomationDevice proto. | AssistantVerticalsHomeautomationProtoHomeAutomationDevice | Next ID: 9 | AssistantLogsDeviceSelectionLog |
| dtoError | AssistantVerticalsHomeautomationProtoHomeAutomationDevice | Next ID: 9 | AssistantDeviceTargetingDeviceTargetingError | |
| dtoQueryInfo | This field is from query_info in DTO. | AssistantVerticalsHomeautomationProtoHomeAutomationDevice | Next ID: 9 | AssistantVerticalsHomeautomationProtoDeviceTargetingOutputQueryInfo |
| homeautomationMetadata | Device meta data. | AssistantVerticalsHomeautomationProtoHomeAutomationDevice | Next ID: 9 | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData |
| list | list of HomeAutomationDeviceItem. After migration completes, we will mark the above 4 field as deprecated and only use this field. | AssistantVerticalsHomeautomationProtoHomeAutomationDevice | Next ID: 9 | list(AssistantVerticalsHomeautomationProtoHomeAutomationDeviceItem) |
| matchedItemKey | Corresponding to casse matched_item CustomTypeItem key. | AssistantVerticalsHomeautomationProtoHomeAutomationDevice | Next ID: 9 | String |
| matchedItemRawvalue | Corresponding to casse Argument raw_value. | AssistantVerticalsHomeautomationProtoHomeAutomationDevice | Next ID: 9 | String |
| matchedItemValue | Corresponding to casse matched_item CustomTypeItem value. | AssistantVerticalsHomeautomationProtoHomeAutomationDevice | Next ID: 9 | list(String) |
| homeautomationMetadata | Device meta data. | AssistantVerticalsHomeautomationProtoHomeAutomationDeviceItem | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | |
| matchedItemKey | Corresponding to casse matched_item CustomTypeItem key. | AssistantVerticalsHomeautomationProtoHomeAutomationDeviceItem | String | |
| matchedItemRawvalue | Corresponding to casse Argument raw_value. | AssistantVerticalsHomeautomationProtoHomeAutomationDeviceItem | String | |
| matchedItemValue | Corresponding to casse matched_item CustomTypeItem value. | AssistantVerticalsHomeautomationProtoHomeAutomationDeviceItem | list(String) | |
| productId | AssistantVerticalsHomeautomationProtoMatterUniqueId | Matter unique Id. These values are provided by the device. | integer | |
| uniqueId | AssistantVerticalsHomeautomationProtoMatterUniqueId | Matter unique Id. These values are provided by the device. | String | |
| vendorId | AssistantVerticalsHomeautomationProtoMatterUniqueId | Matter unique Id. These values are provided by the device. | integer | |
| address | AssistantVerticalsHomeautomationProtoPhysicalLocation | String | ||
| geoLocation | AssistantVerticalsHomeautomationProtoPhysicalLocation | GoogleTypeLatLng | ||
| iamCheckRequired | When true, role_type will be ignored, Nest IAM RPC will called to check authority. | AssistantVerticalsHomeautomationProtoRoleInformation | Represents the user’s role such as assistant only or manager for a device. Design doc: https://docs.google.com/document/d/1c1hnauEbBfDkywO3GZkI8ejHP765l2tLspmPgckEe2Y/ | boolean |
| roleType | AssistantVerticalsHomeautomationProtoRoleInformation | Represents the user’s role such as assistant only or manager for a device. Design doc: https://docs.google.com/document/d/1c1hnauEbBfDkywO3GZkI8ejHP765l2tLspmPgckEe2Y/ | String | |
| enterpriseId | The enterprise that owns the structure. E.g. Disney, Dream Hotel, etc. This is used for log/analytics purpose. For privacy reasons, we log at enterprise level instead of structure level. | AssistantVerticalsHomeautomationProtoSmartDeviceManagementData | String | |
| circadianLightingEnabled | Flag indicating whether the background Circadian Lighting effect is enabled for a particular light (go/circadian-lighting-e2e). | AssistantVerticalsHomeautomationProtoSmartHomeFeatures | SmartHome feature flags that may be enabled per-item. LINT.IfChange | boolean |
| energySavingsEnabled | Flag indicating whether automatic Energy Savings are enabled for this item. | AssistantVerticalsHomeautomationProtoSmartHomeFeatures | SmartHome feature flags that may be enabled per-item. LINT.IfChange | boolean |
| gentleWakeupEnabled | Flag indicating whether Gentle Wake Up is enabled for this item (go/sleep-wake-design). | AssistantVerticalsHomeautomationProtoSmartHomeFeatures | SmartHome feature flags that may be enabled per-item. LINT.IfChange | boolean |
| homeAwayOverMatterEnabled | Flag indicating whether the user has enabled / disabled sending Home/Away status updates to the device through the Google custom IntelligenceEvents Matter cluster. (go/google-clusters-design) | AssistantVerticalsHomeautomationProtoSmartHomeFeatures | SmartHome feature flags that may be enabled per-item. LINT.IfChange | boolean |
| conciergeFeatures | AssistantVerticalsHomeautomationProtoSupportedStructureFeatures | The features a structure supports. | AssistantVerticalsHomeautomationProtoConciergeFeatures | |
| deviceId | The unique device on which the mention occurred. For example, if the user has two Google Home devices, this indicates which of the two was used. | AttentionalEntitiesMentionProperties | Represents the properties of a mention. Next ID: 13 | AssistantApiCoreTypesDeviceId |
| eventId | ID of the event that resulted in this entity mention. For user and system turn AEs, this is taken from the ConversationSnapshotId of the snapshot containing this mention. For client AEs, this is empty. This can be used to join back this particular mention to the specific “turn” in which this mention took place. | AttentionalEntitiesMentionProperties | Represents the properties of a mention. Next ID: 13 | EventIdMessage |
| factoidScore | If this mention corresponds to a WebAnswer, then this defines the score associated with that answer. | AttentionalEntitiesMentionProperties | Represents the properties of a mention. Next ID: 13 | number |
| listEntryInfo | If present, this entity was mentioned as part of a larger list. | AttentionalEntitiesMentionProperties | Represents the properties of a mention. Next ID: 13 | AttentionalEntitiesMentionPropertiesListEntryInfo |
| recency | Estimates the recency of the mention. This is internally computed at runtime on a turn-by-turn basis. | AttentionalEntitiesMentionProperties | Represents the properties of a mention. Next ID: 13 | String |
| role | The semantic role that the entity was used in. | AttentionalEntitiesMentionProperties | Represents the properties of a mention. Next ID: 13 | AttentionalEntitiesSemanticRoleId |
| salience | How salient this mention is. This field will only be set if the mention is derived from a SearchAnswerValue. See go/webresultsdata-as-aes for more details. | AttentionalEntitiesMentionProperties | Represents the properties of a mention. Next ID: 13 | String |
| source | Contains metadata about the source of the mention. | AttentionalEntitiesMentionProperties | Represents the properties of a mention. Next ID: 13 | AttentionalEntitiesMentionPropertiesSource |
| spatialProperties | If present, properties of visual mentions (e.g., how they are displayed to the user, visibility, etc.). | AttentionalEntitiesMentionProperties | Represents the properties of a mention. Next ID: 13 | AttentionalEntitiesSpatialProperties |
| surfaceForm | Details about how this mention was presented. | AttentionalEntitiesMentionProperties | Represents the properties of a mention. Next ID: 13 | AttentionalEntitiesSurfaceForm |
| timestamp | Unix timestamp noting (approximately) when this mention occurred. We do not guarantee that the time will correspond precisely to when the user uttered/heard a response. If mentions within a single turn have *different* timestamps, they should accurately reflect the order in which the mentions occurred. If that order is unknown, they should all have the same timestamp. | AttentionalEntitiesMentionProperties | Represents the properties of a mention. Next ID: 13 | DateTime |
| index | The index of the entity presented to the user. NOTE: Indexing starts from 0. | AttentionalEntitiesMentionPropertiesListEntryInfo | Contains information about how an entity was presented as part of a list. | String |
| lexicalGroundingsId | A string which uniquely identifies the list item this entity represents in the list. For example, consider the “OrderPizza” intent with the “size” slot: U: I want to order a pizza A: Sure. What size do you want: large, medium, or small? U: Gigantic The lexical_groundings_id can be “large” to identify the large item in the list. This lexical_groundings_id together with the semantic role fields (i.e., role.intent_id & role.role_id) can be used to match the nlp_semantic_parsing::LexicalGroundings::ValueTermType to utilize lexical grounding for i18n of static list selection items. Note that this field only needs to be populated when developers expect to provide lexical groundings for the list item this entity represents. Effectively, this field will be populated when this entity is published by ListPresentationFrame and the ::quality::dialog_manager::IntentStageSignals::FieldCandidate.lexical_groundings_id field is populated. See go/lpf-i18nv2 & go/taskstate-ae-sync for more details. | AttentionalEntitiesMentionPropertiesListEntryInfo | Contains information about how an entity was presented as part of a list. | String |
| client | AttentionalEntitiesMentionPropertiesSource | The agent or system from which the mention was derived. Each mention corresponds to a single source. | AttentionalEntitiesMentionPropertiesSourceClient | |
| system | AttentionalEntitiesMentionPropertiesSource | The agent or system from which the mention was derived. Each mention corresponds to a single source. | AttentionalEntitiesMentionPropertiesSourceSystem | |
| user | AttentionalEntitiesMentionPropertiesSource | The agent or system from which the mention was derived. Each mention corresponds to a single source. | AttentionalEntitiesMentionPropertiesSourceUser | |
| intentId | Semantic roles will be defined locally, within the context of a single task/feature. The |intent_id| is a unique identifier for such a local cluster. In most cases, this should be exactly the same as the name of the intent used for TaskState (see go/assistant-intent-catalog). In cases where the intent isn’t well-defined, this can be an arbitrary, feature-defined identifier. | AttentionalEntitiesSemanticRoleId | Uniquely identifies a semantic role. When this role corresponds to a slot in a registered user intent (see go/assistant-intent-catalog), then the SemanticRoleId maps precisely onto that slot in the intent catalog. However, not all semantic roles corresponds to such user intent slots. | String |
| roleId | Identifier for a semantic role, unique within the namespace of |intent_id|. When this role corresponds to a slot in the intent, the |role_id| should be equal to the name of that argument. For example, consider an entry in the intent catalog: core_intent { id { id: “BookARide” } slot { name: “provider” type { string_type { } } } slot { name: “num_riders” type { number_type { } } } } Then, the |role_id| would be “provider” or “num_riders” when referring to one of these slots. NOTE: when responding to the user, the Assistant may actually make use of other roles such as “ETA” or “driver” that are not part of the intent declaration. These should still be assigned consistent semantic roles. For example, a dialog with the Shopping feature: User: Where can I buy XYZ? Google: [Best Buy in Sunnyvale] has [XYZ] in stock. User: Great! Give me directions. In this case, both “Best Buy” and “XYZ” would be pushed to attentional entities. Best Buy, in this case, may not be an argument in the ShoppingItemStockInquiry intent, but should still have a consistent |role_id| such as “possessing_business”. | AttentionalEntitiesSemanticRoleId | Uniquely identifies a semantic role. When this role corresponds to a slot in a registered user intent (see go/assistant-intent-catalog), then the SemanticRoleId maps precisely onto that slot in the intent catalog. However, not all semantic roles corresponds to such user intent slots. | String |
| visibility | AttentionalEntitiesSpatialProperties | Properties of visual mentions (e.g., how they are displayed to the user, visibility, etc.). | String | |
| text | AttentionalEntitiesSurfaceForm | How the entity was presented in this mention at a surface level. For example, “President Barack Obama” or “Barack Obama” or “he” might all be reasonable surface forms for the MID /m/02mjmr. | String | |
| biasingfield | BiasingPerDocData | This data is expected to appear in approximately 2 out of every 1,000 documents with an average of 2 fields per document. Rough order of size is in the hundreds of kilobytes per Mustang shard. | list(BiasingPerDocDataBiasingField) | |
| biasingField | BiasingPerDocData2 | A replacement for BiasingPerDocData that is more efficient wrt size in the index. | list(BiasingPerDocData2BiasingField) | |
| compressedName | A fingerprint of the actual name of the field. | BiasingPerDocData2BiasingField | integer | |
| value | The value, under various representations to get maximum compression. Exactly one of them is guaranteed to be filled. value as a double. | BiasingPerDocData2BiasingField | float | |
| valueFloat | a floating value, represented as an integer by converting using floating_value * 1000. Useable for all floating values that need 3 digits of precision, and are small enough. | BiasingPerDocData2BiasingField | integer | |
| valueInt | value as an int32. When the value is encode-able as an integer. | BiasingPerDocData2BiasingField | integer | |
| Name | Fingerprint of the attribute name (no need to keep long field names) | BiasingPerDocDataBiasingField | Metadata fields on which we can bias (sort) search results independently from the normal ranking using a ScoreAdjuster | String |
| Value | Biasing value translated into a double for uniform comparison | BiasingPerDocDataBiasingField | Metadata fields on which we can bias (sort) search results independently from the normal ranking using a ScoreAdjuster | float |
| BlobID | BlobstoreBlobRef | A BlobRef is used to refer to a blob in BlobStore. Clients may only manipulate blobs through BlobRefs. BlobRefs should not be sent in the clear outside of Google (for example, encoded in URLs, stored in a client cookie, or referred to in Javascript); for efficiency, the IDs expose internal details of the blobstore (such as machine IPs or cluster names). If clients need to store BlobRefs outside of Google, they must encrypt the BlobRef securely or use an alternative insecure identifier with an id->BlobRef mapping inside our network. | String | |
| Options | BlobstoreBlobRef | A BlobRef is used to refer to a blob in BlobStore. Clients may only manipulate blobs through BlobRefs. BlobRefs should not be sent in the clear outside of Google (for example, encoded in URLs, stored in a client cookie, or referred to in Javascript); for efficiency, the IDs expose internal details of the blobstore (such as machine IPs or cluster names). If clients need to store BlobRefs outside of Google, they must encrypt the BlobRef securely or use an alternative insecure identifier with an id->BlobRef mapping inside our network. | String | |
| RefID | BlobstoreBlobRef | A BlobRef is used to refer to a blob in BlobStore. Clients may only manipulate blobs through BlobRefs. BlobRefs should not be sent in the clear outside of Google (for example, encoded in URLs, stored in a client cookie, or referred to in Javascript); for efficiency, the IDs expose internal details of the blobstore (such as machine IPs or cluster names). If clients need to store BlobRefs outside of Google, they must encrypt the BlobRef securely or use an alternative insecure identifier with an id->BlobRef mapping inside our network. | String | |
| ShardBin | BlobstoreBlobRef | A BlobRef is used to refer to a blob in BlobStore. Clients may only manipulate blobs through BlobRefs. BlobRefs should not be sent in the clear outside of Google (for example, encoded in URLs, stored in a client cookie, or referred to in Javascript); for efficiency, the IDs expose internal details of the blobstore (such as machine IPs or cluster names). If clients need to store BlobRefs outside of Google, they must encrypt the BlobRef securely or use an alternative insecure identifier with an id->BlobRef mapping inside our network. | integer | |
| Size | Size of the complete blob, in bytes. | BlobstoreBlobRef | A BlobRef is used to refer to a blob in BlobStore. Clients may only manipulate blobs through BlobRefs. BlobRefs should not be sent in the clear outside of Google (for example, encoded in URLs, stored in a client cookie, or referred to in Javascript); for efficiency, the IDs expose internal details of the blobstore (such as machine IPs or cluster names). If clients need to store BlobRefs outside of Google, they must encrypt the BlobRef securely or use an alternative insecure identifier with an id->BlobRef mapping inside our network. | String |
| SourceV2BlobID | The ID of the V2 blob this blob has | BlobstoreBlobRef | A BlobRef is used to refer to a blob in BlobStore. Clients may only manipulate blobs through BlobRefs. BlobRefs should not be sent in the clear outside of Google (for example, encoded in URLs, stored in a client cookie, or referred to in Javascript); for efficiency, the IDs expose internal details of the blobstore (such as machine IPs or cluster names). If clients need to store BlobRefs outside of Google, they must encrypt the BlobRef securely or use an alternative insecure identifier with an id->BlobRef mapping inside our network. | String |
| V2ReadBlobToken | Deprecated. | BlobstoreBlobRef | A BlobRef is used to refer to a blob in BlobStore. Clients may only manipulate blobs through BlobRefs. BlobRefs should not be sent in the clear outside of Google (for example, encoded in URLs, stored in a client cookie, or referred to in Javascript); for efficiency, the IDs expose internal details of the blobstore (such as machine IPs or cluster names). If clients need to store BlobRefs outside of Google, they must encrypt the BlobRef securely or use an alternative insecure identifier with an id->BlobRef mapping inside our network. | String |
| blogurlFp | used for blogurl crowding. | BlogPerDocData | Additional data for Blog/Posts | String |
| clientSpamminess | This score captures how spammy the client is that the micropost was created with. The higher the score the worse. | BlogPerDocData | Additional data for Blog/Posts | integer |
| convTree | For the threaded conversation view. Only populated in docs with provider type SYNTHETIC_CONVERSATION_DOC. | BlogPerDocData | Additional data for Blog/Posts | BlogsearchConversationTree |
| copycatScore | BlogPerDocData | Additional data for Blog/Posts | integer | |
| docQualityScore | BlogPerDocData | Additional data for Blog/Posts | integer | |
| isSyntacticReshare | A syntactic reshare is a document that is * created from an original and shared with friends and * we detect this resharing property by syntactically parsing the doc. . For example, a retweet is an example of a syntactic_reshare because we can detect that it’s a reshare by grepping for “RT @”. | BlogPerDocData | Additional data for Blog/Posts | boolean |
| microblogQualityExptData | Experimental data for quality experiments. This will NOT be populated in prod, but we will use this for experiments. | BlogPerDocData | Additional data for Blog/Posts | Proto2BridgeMessageSet |
| numMentions | For replies/reshares. num_mentions = number of times the pattern @foo appears in the document. | BlogPerDocData | Additional data for Blog/Posts | integer |
| outlinks | BlogPerDocData | Additional data for Blog/Posts | list(BlogPerDocDataOutlinks) | |
| postContentFingerprint | The fingerprint for the body text of the microblog post. It is copied from MicroBlogPost.post_content_fingerprint. | BlogPerDocData | Additional data for Blog/Posts | integer |
| qualityScore | BlogPerDocData | Additional data for Blog/Posts | integer | |
| spamScore | Blog scoring signals. | BlogPerDocData | Additional data for Blog/Posts | integer |
| universalWhitelisted | BlogPerDocData | Additional data for Blog/Posts | boolean | |
| userQualityScore | User and doc quality scores for updates (aka microposts). | BlogPerDocData | Additional data for Blog/Posts | integer |
| aggregationFp | Representative id for an equivalence class of URLs. E.g. http://youtube.com/watch?v=12 and http://youtube.com/watch?v=12&feature=related have the same aggregation id since they’re effectively the same webpage | BlogPerDocDataOutlinks | Resolved url and site spamscore for outlinks in updates (aka microposts). | String |
| resolvedUrl | BlogPerDocDataOutlinks | Resolved url and site spamscore for outlinks in updates (aka microposts). | String | |
| siteSpamScore | BlogPerDocDataOutlinks | Resolved url and site spamscore for outlinks in updates (aka microposts). | integer | |
| title | BlogPerDocDataOutlinks | Resolved url and site spamscore for outlinks in updates (aka microposts). | String | |
| authorName | The username of the author of the microblog post represented by this node. | BlogsearchConversationNode | String | |
| children | A list of docids of child nodes. | BlogsearchConversationNode | list(String) | |
| date | The creation date of the doc. | BlogsearchConversationNode | String | |
| docid | Docid of the microblog post represented by this node. | BlogsearchConversationNode | String | |
| parent | The docid of the parent node. The root of the tree will leave this empty. | BlogsearchConversationNode | String | |
| convId | The id of this conversation. | BlogsearchConversationTree | String | |
| nodes | The nodes in this conversation. No particular order is assumed. | BlogsearchConversationTree | list(BlogsearchConversationNode) | |
| modules | List of supported modules for a business. | BlueGingerClientVisibleProtoBlueGingerSupportedServices | Information to indicate BG availability for businesses. This message is filled from Topic Server and stored in the GSR in Superroot. | list(BlueGingerClientVisibleProtoBlueGingerSupportedServicesBlueGingerModule) |
| name | Module name, e.g. hairdresser_reservation. from quality/views/extraction/kcube/bg/modules/modules.bzl. | BlueGingerClientVisibleProtoBlueGingerSupportedServicesBlueGingerModule | String | |
| services | Services of this module that are supported by the business, e.g. haircuts. | BlueGingerClientVisibleProtoBlueGingerSupportedServicesBlueGingerModule | list(String) | |
| useCase | BlueGingerClientVisibleProtoBlueGingerSupportedServicesBlueGingerModule | String | ||
| bookId | the book id for the main citation | BookCitationPerDocData | Per-doc data for the web page about the cited book Approximate size is on average ~10bytes | String |
| discretizedCitationScore | the discretized citation score for the main book. we map the raw score 1.0-20.0 to 0 – 127 | BookCitationPerDocData | Per-doc data for the web page about the cited book Approximate size is on average ~10bytes | integer |
| previewable | Is there a preview or excerpt of the book on this document? | BookCitationPerDocData | Per-doc data for the web page about the cited book Approximate size is on average ~10bytes | boolean |
| secondBookId | book id for the second citation if we can’t separate the two top citations (they are too close). | BookCitationPerDocData | Per-doc data for the web page about the cited book Approximate size is on average ~10bytes | String |
| secondDiscretizedCitationScore | the discretized score for the second citation | BookCitationPerDocData | Per-doc data for the web page about the cited book Approximate size is on average ~10bytes | integer |
| dayopen | BusinessHours | We divide up a week into individual open intervals. If any are present then they must be arranged in strictly increasing order, with non-empty spaces between successive intervals, and all times between 0 and 604800, the number of seconds in a week. | integer | |
| interval | BusinessHours | We divide up a week into individual open intervals. If any are present then they must be arranged in strictly increasing order, with non-empty spaces between successive intervals, and all times between 0 and 604800, the number of seconds in a week. | list(BusinessHoursInterval) | |
| end | The interval ends at the start of this second | BusinessHoursInterval | integer | |
| start | Time in seconds since Midnight-Monday-Morn | BusinessHoursInterval | integer | |
| expiryTimeMicros | Time since epoch (micros) that this will expire | ChatBotPlatformBotSendToken | Token to be exposed and stored by the bot | String |
| sendToken | Encrypted InternalSendToken | ChatBotPlatformBotSendToken | Token to be exposed and stored by the bot | String |
| id | When used as a user ID, it’s the phone number of the sender. When used as a session ID: For group conversation, it is the group ID. For 1 to 1, it is the receiver or sender phone number. For 1 to bot, it is the receiver phone number or empty. | ChatBotPlatformFireballId | GoogleInternalCommunicationsInstantmessagingV1Id | |
| classification | ClassifierPornClassifierData | Next ID: 6 | list(ClassifierPornClassifierDataClassification) | |
| imageBasedDetectionDone | Records whether the image linker is run already. This is only used for Alexandria but NOT for Segindexer. | ClassifierPornClassifierData | Next ID: 6 | boolean |
| timestamp | ClassifierPornClassifierData | Next ID: 6 | String | |
| label | ClassifierPornClassifierDataClassification | String | ||
| score | ClassifierPornClassifierDataClassification | number | ||
| classifierdata | ClassifierPornDocumentData | Next ID: 3 | ClassifierPornClassifierData | |
| sitedata | ClassifierPornDocumentData | Next ID: 3 | ClassifierPornSiteData | |
| csaiClassification | This field is only filled for the CSAI vertical. | ClassifierPornQueryClassifierOutput | Generic output for one vertical. | String |
| debug | Human-readable debug information about the classification. This field is only set if output_debug is set in the classification input. | ClassifierPornQueryClassifierOutput | Generic output for one vertical. | String |
| isPositive | The bit that shows if this classifier outputs positive classification for the input query. Set by thresholding with a recommended threshold. | ClassifierPornQueryClassifierOutput | Generic output for one vertical. | boolean |
| score | The score that the classifier assigned to the input query. This is filled by all verticals. | ClassifierPornQueryClassifierOutput | Generic output for one vertical. | number |
| csai | ClassifierPornQueryMultiLabelClassifierOutput | Multi-label classification output. It contains the output for each vertical. The output for some verticals can be empty, in case that vertical is not supported by the classifier or if the set of verticals was restricted using MultiLabelClassifierInput.verticals. | ClassifierPornQueryClassifierOutput | |
| fringe | ClassifierPornQueryMultiLabelClassifierOutput | Multi-label classification output. It contains the output for each vertical. The output for some verticals can be empty, in case that vertical is not supported by the classifier or if the set of verticals was restricted using MultiLabelClassifierInput.verticals. | ClassifierPornQueryClassifierOutput | |
| medical | ClassifierPornQueryMultiLabelClassifierOutput | Multi-label classification output. It contains the output for each vertical. The output for some verticals can be empty, in case that vertical is not supported by the classifier or if the set of verticals was restricted using MultiLabelClassifierInput.verticals. | ClassifierPornQueryClassifierOutput | |
| minor | ClassifierPornQueryMultiLabelClassifierOutput | Multi-label classification output. It contains the output for each vertical. The output for some verticals can be empty, in case that vertical is not supported by the classifier or if the set of verticals was restricted using MultiLabelClassifierInput.verticals. | ClassifierPornQueryClassifierOutput | |
| offensive | ClassifierPornQueryMultiLabelClassifierOutput | Multi-label classification output. It contains the output for each vertical. The output for some verticals can be empty, in case that vertical is not supported by the classifier or if the set of verticals was restricted using MultiLabelClassifierInput.verticals. | ClassifierPornQueryClassifierOutput | |
| porn | ClassifierPornQueryMultiLabelClassifierOutput | Multi-label classification output. It contains the output for each vertical. The output for some verticals can be empty, in case that vertical is not supported by the classifier or if the set of verticals was restricted using MultiLabelClassifierInput.verticals. | ClassifierPornQueryClassifierOutput | |
| spoof | ClassifierPornQueryMultiLabelClassifierOutput | Multi-label classification output. It contains the output for each vertical. The output for some verticals can be empty, in case that vertical is not supported by the classifier or if the set of verticals was restricted using MultiLabelClassifierInput.verticals. | ClassifierPornQueryClassifierOutput | |
| violence | ClassifierPornQueryMultiLabelClassifierOutput | Multi-label classification output. It contains the output for each vertical. The output for some verticals can be empty, in case that vertical is not supported by the classifier or if the set of verticals was restricted using MultiLabelClassifierInput.verticals. | ClassifierPornQueryClassifierOutput | |
| vulgar | ClassifierPornQueryMultiLabelClassifierOutput | Multi-label classification output. It contains the output for each vertical. The output for some verticals can be empty, in case that vertical is not supported by the classifier or if the set of verticals was restricted using MultiLabelClassifierInput.verticals. | ClassifierPornQueryClassifierOutput | |
| queryTextPornScore | A query text porn score for the queries which have clicks to the image: query_text_porn_score := sum(clicks(query) * text_porn_score(query)) / sum(clicks(query)) | ClassifierPornQueryStats | QuerySats contains the information about the queries that users typed to search for this image. | number |
| totalClicks | ClassifierPornQueryStats | QuerySats contains the information about the queries that users typed to search for this image. | number | |
| adult | ClassifierPornReferrerCounts | ReferrerCounts stores how many referrers an images has and how many of them were classified as porn and as adult/softporn respectively. Note that a referrer is usually a landing page, but as of March 2011 this also includes referrers which an image can ‘inherit’ by propagating counts from near duplicate images. | integer | |
| porn | Number of referrers which are classified as porn and as adult. | ClassifierPornReferrerCounts | ReferrerCounts stores how many referrers an images has and how many of them were classified as porn and as adult/softporn respectively. Note that a referrer is usually a landing page, but as of March 2011 this also includes referrers which an image can ‘inherit’ by propagating counts from near duplicate images. | integer |
| total | Total number of referrers. | ClassifierPornReferrerCounts | ReferrerCounts stores how many referrers an images has and how many of them were classified as porn and as adult/softporn respectively. Note that a referrer is usually a landing page, but as of March 2011 this also includes referrers which an image can ‘inherit’ by propagating counts from near duplicate images. | integer |
| avgPedoPageScore | The average pedo page score for the site. | ClassifierPornSiteData | Next ID: 53 | number |
| finalPedoSiteScore | ClassifierPornSiteData | Next ID: 53 | number | |
| numberOfPages | The number of pages that were used to compute the scores and ratios. | ClassifierPornSiteData | Next ID: 53 | String |
| numberOfPedoPages | The number of pages with pedo restrict. | ClassifierPornSiteData | Next ID: 53 | String |
| site | Sitechunk used to compute the signals. The field is present only for data created after December 2022. | ClassifierPornSiteData | Next ID: 53 | String |
| sitePornRatio | The ratio of porn/softporn of the site this page belongs to. | ClassifierPornSiteData | Next ID: 53 | number |
| siteSoftpornRatio | ClassifierPornSiteData | Next ID: 53 | number | |
| versionedscore | ClassifierPornSiteData | Next ID: 53 | list(ClassifierPornSiteDataVersionedScore) | |
| violenceScore | The cubic mean aggregation of violence page scores in the site. | ClassifierPornSiteData | Next ID: 53 | number |
| violenceStats | ClassifierPornSiteData | Next ID: 53 | ClassifierPornSiteViolenceStats | |
| score | ClassifierPornSiteDataVersionedScore | The site porn score of the site to which the page of interest belongs to. Multiple versions are kept across large changes for some time. The Version-4 score is the average Universal Page Probability of all the site’s pages, and will come with populated verticals4_score and site_rule (if any rule fires) fields. When using this score it is recommended to subscribe to the following mailing list: g/safesearch-announce. | number | |
| siteRule | ClassifierPornSiteDataVersionedScore | The site porn score of the site to which the page of interest belongs to. Multiple versions are kept across large changes for some time. The Version-4 score is the average Universal Page Probability of all the site’s pages, and will come with populated verticals4_score and site_rule (if any rule fires) fields. When using this score it is recommended to subscribe to the following mailing list: g/safesearch-announce. | list(String) | |
| version | ClassifierPornSiteDataVersionedScore | The site porn score of the site to which the page of interest belongs to. Multiple versions are kept across large changes for some time. The Version-4 score is the average Universal Page Probability of all the site’s pages, and will come with populated verticals4_score and site_rule (if any rule fires) fields. When using this score it is recommended to subscribe to the following mailing list: g/safesearch-announce. | integer | |
| verticals4Score | Please talk to safesearch@ before relying on any of these internal fields: | ClassifierPornSiteDataVersionedScore | The site porn score of the site to which the page of interest belongs to. Multiple versions are kept across large changes for some time. The Version-4 score is the average Universal Page Probability of all the site’s pages, and will come with populated verticals4_score and site_rule (if any rule fires) fields. When using this score it is recommended to subscribe to the following mailing list: g/safesearch-announce. | number |
| meanFinalViolenceScore | ClassifierPornSiteViolenceStats | Next ID: 6 | number | |
| numberOfImages | ClassifierPornSiteViolenceStats | Next ID: 6 | String | |
| numberOfVideos | ClassifierPornSiteViolenceStats | Next ID: 6 | String | |
| videoViolenceScore | ClassifierPornSiteViolenceStats | Next ID: 6 | number | |
| cloudSqlInstanceConnectionName | Output only. The CloudSQL instance connection name. | CloudAiPlatformTenantresourceCloudSqlInstanceConfig | The identity to configure a CloudSQL instance provisioned via SLM Terraform. | String |
| cloudSqlInstanceName | Input/Output [Optional]. The CloudSQL instance name within SLM instance. If not set, a random UUIC will be generated as instance name. | CloudAiPlatformTenantresourceCloudSqlInstanceConfig | The identity to configure a CloudSQL instance provisioned via SLM Terraform. | String |
| kmsKeyReference | Input [Optional]. The KMS key name or the KMS grant name used for CMEK encryption. Only set this field when provisioning new CloudSQL instances. For existing CloudSQL instances, this field will be ignored because CMEK re-encryption is not supported. | CloudAiPlatformTenantresourceCloudSqlInstanceConfig | The identity to configure a CloudSQL instance provisioned via SLM Terraform. | String |
| mdbRolesForCorpAccess | Input [Optional]. MDB roles for corp access to CloudSQL instance. | CloudAiPlatformTenantresourceCloudSqlInstanceConfig | The identity to configure a CloudSQL instance provisioned via SLM Terraform. | list(String) |
| slmInstanceName | Output only. The SLM instance’s full resource name. | CloudAiPlatformTenantresourceCloudSqlInstanceConfig | The identity to configure a CloudSQL instance provisioned via SLM Terraform. | String |
| slmInstanceTemplate | Input [Required]. The SLM instance template to provision CloudSQL. | CloudAiPlatformTenantresourceCloudSqlInstanceConfig | The identity to configure a CloudSQL instance provisioned via SLM Terraform. | String |
| slmInstanceType | Input [Required]. The SLM instance type to provision CloudSQL. | CloudAiPlatformTenantresourceCloudSqlInstanceConfig | The identity to configure a CloudSQL instance provisioned via SLM Terraform. | String |
| admins | CloudAiPlatformTenantresourceGcsBucketConfig | The identity to configure a GCS bucket. | list(String) | |
| bucketName | Input/Output [Optional]. The name of a GCS bucket with max length of 63 chars. If not set, a random UUID will be generated as bucket name. | CloudAiPlatformTenantresourceGcsBucketConfig | The identity to configure a GCS bucket. | String |
| entityName | Input/Output [Optional]. Only needed for per-entity tenant GCP resources. During Deprovision API, the on-demand deletion will only cover the tenant GCP resources with the specified entity name. | CloudAiPlatformTenantresourceGcsBucketConfig | The identity to configure a GCS bucket. | String |
| kmsKeyReference | Input/Output [Optional]. The KMS key name or the KMS grant name used for CMEK encryption. Only set this field when provisioning new GCS bucket. For existing GCS bucket, this field will be ignored because CMEK re-encryption is not supported. | CloudAiPlatformTenantresourceGcsBucketConfig | The identity to configure a GCS bucket. | String |
| ttlDays | Input/Output [Optional]. Only needed when the content in bucket need to be garbage collected within some amount of days. | CloudAiPlatformTenantresourceGcsBucketConfig | The identity to configure a GCS bucket. | integer |
| viewers | Input/Output [Required]. IAM roles (viewer/admin) put on the bucket. | CloudAiPlatformTenantresourceGcsBucketConfig | The identity to configure a GCS bucket. | list(String) |
| members | Input/Output [Required]. The member service accounts with the roles above. Note: placeholders are same as the resource above. | CloudAiPlatformTenantresourceIamPolicyBinding | The dynamic IAM bindings to be granted after tenant projects are created. | list(String) |
| resource | Input/Output [Required]. The resource name that will be accessed by members, which also depends on resource_type. Note: placeholders are supported in resource names. For example, ${tpn} will be used when the tenant project number is not ready. | CloudAiPlatformTenantresourceIamPolicyBinding | The dynamic IAM bindings to be granted after tenant projects are created. | String |
| resourceType | Input/Output [Required]. Specifies the type of resource that will be accessed by members. | CloudAiPlatformTenantresourceIamPolicyBinding | The dynamic IAM bindings to be granted after tenant projects are created. | String |
| role | Input/Output [Required]. The role for members below. | CloudAiPlatformTenantresourceIamPolicyBinding | The dynamic IAM bindings to be granted after tenant projects are created. | String |
| createDatabaseOptions | Input [Optional]. The options to create a spanner database. Note: give the right options to ensure the right KMS key access audit logging and AxT logging in expected logging category. | CloudAiPlatformTenantresourceInfraSpannerConfig | The configuration for a spanner database provisioning. Next ID: 8 | CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions |
| kmsKeyReference | Input [Optional]. The KMS key name or the KMS grant name used for CMEK encryption. Only set this field when provisioning new Infra Spanner databases. For existing Infra Spanner databases, this field will be ignored because CMEK re-encryption is not supported. For example, projects//locations//keyRings//cryptoKeys/ | CloudAiPlatformTenantresourceInfraSpannerConfig | The configuration for a spanner database provisioning. Next ID: 8 | String |
| sdlBundlePath | Input [Required]. The file path to the spanner SDL bundle. | CloudAiPlatformTenantresourceInfraSpannerConfig | The configuration for a spanner database provisioning. Next ID: 8 | String |
| spannerBorgServiceAccount | Input [Optional]. The spanner borg service account for delegating the kms key to. For example, [email protected], for the nonprod universe. | CloudAiPlatformTenantresourceInfraSpannerConfig | The configuration for a spanner database provisioning. Next ID: 8 | String |
| spannerLocalNamePrefix | CloudAiPlatformTenantresourceInfraSpannerConfig | The configuration for a spanner database provisioning. Next ID: 8 | String | |
| spannerNamespace | CloudAiPlatformTenantresourceInfraSpannerConfig | The configuration for a spanner database provisioning. Next ID: 8 | String | |
| spannerUniverse | Input [Required]. Every database in Spanner can be identified by the following path name: /span//: | CloudAiPlatformTenantresourceInfraSpannerConfig | The configuration for a spanner database provisioning. Next ID: 8 | String |
| cmekCloudResourceName | The cloud resource name for the CMEK encryption. For example, projects//locations/ | CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions | The options to create a spanner database. KMS key access audit logging and AxT logging will be associated with the given resource name, resource type and service name. Please ensure to give right options to enable correct audit logging and AxT logging. | String |
| cmekCloudResourceType | The cloud resource type for the CMEK encryption. For example, contentwarehouse.googleapis.com/Location | CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions | The options to create a spanner database. KMS key access audit logging and AxT logging will be associated with the given resource name, resource type and service name. Please ensure to give right options to enable correct audit logging and AxT logging. | String |
| cmekServiceName | The service name for the CMEK encryption. For example, contentwarehouse.googleapis.com | CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions | The options to create a spanner database. KMS key access audit logging and AxT logging will be associated with the given resource name, resource type and service name. Please ensure to give right options to enable correct audit logging and AxT logging. | String |
| serviceAccountEmail | Output only. The service account email that has been created. | CloudAiPlatformTenantresourceServiceAccountIdentity | The identity to configure a service account. | String |
| tag | Input/Output [Optional]. The tag that configures the service account, as defined in google3/configs/production/cdpush/acl-zanzibar-cloud-prod/activation_grants/activation_grants.gcl. Note: The default P4 service account has the empty tag. | CloudAiPlatformTenantresourceServiceAccountIdentity | The identity to configure a service account. | String |
| billingConfig | Input/Output [Required]. The billing account properties to create the tenant project. | CloudAiPlatformTenantresourceTenantProjectConfig | The identity to configure a tenant project. | GoogleApiServiceconsumermanagementV1BillingConfig |
| folder | Input/Output [Required]. The folder that holds tenant projects and folder-level permissions will be automatically granted to all tenant projects under the folder. Note: the valid folder format is `folders/{folder_number}`. | CloudAiPlatformTenantresourceTenantProjectConfig | The identity to configure a tenant project. | String |
| policyBindings | Input/Output [Required]. The policy bindings that are applied to the tenant project during creation. At least one binding must have the role `roles/owner` with either `user` or `group` type. | CloudAiPlatformTenantresourceTenantProjectConfig | The identity to configure a tenant project. | list(GoogleApiServiceconsumermanagementV1PolicyBinding) |
| services | Input/Output [Required]. The API services that are enabled on the tenant project during creation. | CloudAiPlatformTenantresourceTenantProjectConfig | The identity to configure a tenant project. | list(String) |
| cloudSqlInstances | The CloudSQL instances that are provisioned under the tenant project. | CloudAiPlatformTenantresourceTenantProjectResource | The tenant project and tenant resources. Next ID: 10 | list(CloudAiPlatformTenantresourceCloudSqlInstanceConfig) |
| gcsBuckets | The GCS buckets that are provisioned under the tenant project. | CloudAiPlatformTenantresourceTenantProjectResource | The tenant project and tenant resources. Next ID: 10 | list(CloudAiPlatformTenantresourceGcsBucketConfig) |
| iamPolicyBindings | The dynamic IAM bindings that are granted under the tenant project. Note: this should only add new bindings to the project if they don’t exist and the existing bindings won’t be affected. | CloudAiPlatformTenantresourceTenantProjectResource | The tenant project and tenant resources. Next ID: 10 | list(CloudAiPlatformTenantresourceIamPolicyBinding) |
| infraSpannerConfigs | The Infra Spanner databases that are provisioned under the tenant project. Note: this is an experimental feature. | CloudAiPlatformTenantresourceTenantProjectResource | The tenant project and tenant resources. Next ID: 10 | list(CloudAiPlatformTenantresourceInfraSpannerConfig) |
| tag | Input/Output [Required]. The tag that uniquely identifies a tenant project within a tenancy unit. Note: for the same tenant project tag, all tenant manager operations should be idempotent. | CloudAiPlatformTenantresourceTenantProjectResource | The tenant project and tenant resources. Next ID: 10 | String |
| tenantProjectConfig | The configurations of a tenant project. | CloudAiPlatformTenantresourceTenantProjectResource | The tenant project and tenant resources. Next ID: 10 | CloudAiPlatformTenantresourceTenantProjectConfig |
| tenantProjectId | Output only. The tenant project ID that has been created. | CloudAiPlatformTenantresourceTenantProjectResource | The tenant project and tenant resources. Next ID: 10 | String |
| tenantProjectNumber | Output only. The tenant project number that has been created. | CloudAiPlatformTenantresourceTenantProjectResource | The tenant project and tenant resources. Next ID: 10 | String |
| tenantServiceAccounts | The service account identities (or enabled API service’s P4SA) that are expclicitly created under the tenant project (before JIT provisioning during enabled API services). | CloudAiPlatformTenantresourceTenantProjectResource | The tenant project and tenant resources. Next ID: 10 | list(CloudAiPlatformTenantresourceTenantServiceAccountIdentity) |
| p4ServiceAccounts | A list of P4 service accounts (go/p4sa) to provision or deprovision. | CloudAiPlatformTenantresourceTenantResource | A collection of tenant resources. | list(CloudAiPlatformTenantresourceServiceAccountIdentity) |
| tenantProjectResources | A list of tenant projects and tenant resources to provision or deprovision. | CloudAiPlatformTenantresourceTenantResource | A collection of tenant resources. | list(CloudAiPlatformTenantresourceTenantProjectResource) |
| serviceAccountEmail | Output only. The email address of the generated service account. | CloudAiPlatformTenantresourceTenantServiceAccountIdentity | The identity of service accounts that have been explicitly created under tenant projects. | String |
| serviceName | Input/Output [Required]. The service that the service account belongs to. (e.g. cloudbuild.googleapis.com for GCB service accounts) | CloudAiPlatformTenantresourceTenantServiceAccountIdentity | The identity of service accounts that have been explicitly created under tenant projects. | String |
| confidence | The confidence of the tag, encoded to 14 bits (range [0, 16383]). Due to modeling details, a large number of tags become trustworthy with confidence greater than 0.001, so two bytes of precision are required. | CommerceDatastoreDeepTag | The basic message that contains a single decision output of go/deeptagger. | integer |
| tag | A Deep Tag enum in uint32 form. | CommerceDatastoreDeepTag | The basic message that contains a single decision output of go/deeptagger. | integer |
| modelOutputs | The set of outputs for a series of model versions. The size of this field should not extend beyond 4 at any time: two versions for slow-update track dependencies, and two versions for fast-update track dependencies. | CommerceDatastoreImageDeepTags | Image-level deep tags: essentially equivalent to the proto above but containing tags that are computed at the image level. These image signals are maintained by the Visual Shopping team (visual-shopping@). *** If you do use the signals, please add an entry in go/ShoppingImageAttributeClients to be notified for model upgrade. *** We recommend our clients against using the raw confidence value directly. Instead, the clients should use the library, cs/ads/shopping/visual/deeptags/public/single_tag.h and cs/ads/shopping/visual/deeptags/public/single_scored_tag.h to specify an operating point in terms of precision or recall. See the following code example: http://google3/shopping/visual/explore_looks/looks_offline_pipeline.cc?l=268&rcl=304165166 *** `model_outputs` is a repeated field. Please check `version` to get the model you desire to use, instead of indexing the model_outputs directly e.g. model_outputs(0). We will remove the old versions in the future and this will lead to incorrect model. *** Models: As of Q2 2020, we have two models running within Shopping: model one only has the overlay tag, which we are deprecating, and model two has the tags specified in go/VisualShoppingImageAttributes. | list(CommerceDatastoreImageDeepTagsModelOutput) |
| backgroundType | CommerceDatastoreImageDeepTagsModelOutput | CommerceDatastoreDeepTag | ||
| collage | CommerceDatastoreImageDeepTagsModelOutput | CommerceDatastoreDeepTag | ||
| cropping | We are looking to deploy a model for the Ads team to identify images with bad cropping. The model will be for Ads only and we will not populate the cropping field in CDS. | CommerceDatastoreImageDeepTagsModelOutput | CommerceDatastoreDeepTag | |
| modelType | CommerceDatastoreImageDeepTagsModelOutput | CommerceDatastoreDeepTag | ||
| nfs | Tag corresponds to the shopping non-family safe (nfs) image signal. | CommerceDatastoreImageDeepTagsModelOutput | CommerceDatastoreDeepTag | |
| objectCount | CommerceDatastoreImageDeepTagsModelOutput | CommerceDatastoreDeepTag | ||
| overlay | Tag corresponding to unwanted text overlay (watermarks, logos, promotional elements, artifacts, etc). | CommerceDatastoreImageDeepTagsModelOutput | CommerceDatastoreDeepTag | |
| selfie | CommerceDatastoreImageDeepTagsModelOutput | CommerceDatastoreDeepTag | ||
| textOverlay | Tag corresponding to the text overlay classifier (watermarks, logos, promotional elements, artifacts, etc). | CommerceDatastoreImageDeepTagsModelOutput | list(CommerceDatastoreDeepTag) | |
| version | CommerceDatastoreImageDeepTagsModelOutput | integer | ||
| localizedvariations | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | CompositeDocLocalizedVariations | |
| localizedAlternateName | Localized alternate names are similar to alternate names, except that it is associated with a language different from its canonical. This is the subset of webmaster-provided localized alternate names being in the dup cluster of this document. Used during serving for swapping in the URL based on regional and language preferences of the user. | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | list(IndexingConverterLocalizedAlternateName) |
| forwardingdup | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | list(CompositeDocForwardingDup) | |
| perDocData | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | PerDocData | |
| accessRequirements | Contains necessary information to enforce row level Docjoin access control. | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | IndexingPrivacyAccessAccessRequirements |
| properties | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | DocProperties | |
| badSslCertificate | This field is present iff the page has a bad SSL certificate itself or in its redirect chain. | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | IndexingBadSSLCertificate |
| extradup | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | list(CompositeDocExtraDup) | |
| subindexid | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | list(String) | |
| ptoken | Contains information necessary to perform policy decision on the usage of the data assosiated with this cdoc. | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | PtokenPToken |
| richcontentData | If present, indicates that some content was inserted, deleted, or replaced in the document’s content (in CompositeDoc::doc::Content::Representation), and stores information about what was inserted, deleted, or replaced. | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | IndexingConverterRichContentData |
| scaledIndyRank | to copy to per-doc | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | integer |
| cseId | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | list(QualityProseCSEUrlInfo) | |
| indexingIntermediate | Serialized indexing intermediate data. | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | String |
| docVideos | Info about videos embedded in the document. | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | list(ImageRepositoryVideoProperties) |
| indexinginfo | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | CompositeDocIndexingInfo | |
| localinfo | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | LocalWWWInfo | |
| storageRowTimestampMicros | Row timestamp in CDoc storage. | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | String |
| partialUpdateInfo | Only present in partial cdocs. | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | CompositeDocPartialUpdateInfo |
| additionalchecksums | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | CompositeDocAdditionalChecksums | |
| anchors | Mark as non-personal since no personal fields will be populated in `anchors.link_additional_info` and `anchors.additional_info`. For more details of Search personal data, see go/dma52-search-cdoc-fields. | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | Anchors |
| registrationinfo | Information about the most recent creation and expiration of this domain. It’s extracted from domainedge signal. | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | RegistrationInfo |
| docAttachments | A generic container to hold document annotations and signals. For a full list of extensions live today, see go/wde. | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | Proto2BridgeMessageSet |
| docinfoPassthroughAttachments | This message set is used for data pushed into the index using the signals framework that is never to be used in Mustang or TG Continuum scoring/snippeting code. Any protocol buffer stored in this message set is automatically returned in a docinfo response – it ends up in the “info” message set in the WWWSnippetResponse, so it can be used in post-doc twiddlers and for display in GWS with no code changes in Mustang or Teragoogle. | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | Proto2BridgeMessageSet |
| docImages | Info about “selected” images associated with the document for which we (already) have ImageData. For each image URL, some fixed number of documents are selected as web referrers for the image URL, and within those selected documents, we say the image is “selected”. Within the remaining documents, we say the image is “rejected”. Note that this distinction is slightly different from selected for indexing. Only images within doc_images where is_indexed_by_imagesearch is true will be selected for indexing. You can find the rejected images at composite_doc.doc_attachments().get(). You can find images that are selected, but for which we have no ImageData (yet) at composite_doc.image_indexing_info().selected_not_indexed_image_link() | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | list(ImageData) |
| includedcontent | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | list(CompositeDocIncludedContent) | |
| porninfo | Porn related data used for image and web search porn classification as well as for diagnostics purposes. | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | ClassifierPornDocumentData |
| urldate | Date in the url extracted by quality/snippets/urldate/date-in-url.cc This is given as midnight GMT on the date in question. | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | String |
| embeddedContentInfo | Data produced by the embedded-content system. This is a thin message, containing only embedded_links_info data for the embedder and JavaScript/CSS embedded links (the embedded-content bigtable also contains snapshots, compressed document trees and all embedded link types). Provided using the index signal API. | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | IndexingEmbeddedContentEmbeddedContentInfo |
| richsnippet | rich snippet extracted from the content of a document. | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | RichsnippetsPageMap |
| qualitysignals | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | CompositeDocQualitySignals | |
| anchorStats | Mark as non-personal since it’s an aggregation of anchors. For more details of Search personal data, see go/dma52-search-cdoc-fields. | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | IndexingDocjoinerAnchorStatistics |
| alternatename | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | list(CompositeDocAlternateName) | |
| dataVersion | Contains the tracking version of various data fields in CompositeDoc. | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | IndexingDocjoinerDataVersion |
| syntacticDate | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | QualityTimebasedSyntacticDate | |
| url | WARNING!!! “url” field in CompositeDoc is optional, and is usually missing: e.g., Docjoin CompositeDoc’s don’t have CompositeDoc::url. has_url() checking is often useful. So don’t rely on CompositeDoc::url unless you’re sure otherwise. Usually you want to use CompositeDoc::doc::url instead. | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | String |
| docjoinsOnSpannerCommitTimestampMicros | The commit timestamp of a CDoc update to Docjoins on Spanner. | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | String |
| ContentChecksum96 | Visible content checksum as computed by repository::parsehandler::checksum::Checksum96bitsParseHandler. The value is a Fprint96 in “key format” (i.e., by Fprint96::AsKey()). | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | String |
| liveexperimentinfo | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | CompositeDocLiveExperimentInfo | |
| labelData | This field associates a document to particular labels and assigns confidence values to them. | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | QualityLabelsGoogleLabelData |
| sitemap | Sitelinks: a collection of interesting links a user might be interested in, given they are interested in this document. WARNING: this is different from the crawler Sitemaps (see SitemapsSignals in the attachments). | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | Sitemap |
| robotsinfolist | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | CompositeDocRobotsInfoList | |
| doc | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | GDocumentBase | |
| csePagerankCutoff | URL should only be selected for CSE Index if it’s pagerank is higher than cse_pagerank_cutoff. | CompositeDoc | Protocol record used for collecting together all information about a document. Please consult go/dj-explorer for two basic questions about `CompositeDoc`: – Where should I look up certain information (e.g: pagerank, language)? – What does each field in CompositeDoc mean and who should I contact if I have questions? To add a new field into CompositeDoc, or change existing field’s size significantly, please file a ticket at go/dj-new-field, fill in necessary information and get approved by docjoin-access@ team. Next id: 194 | integer |
| NoTransientChecksum96 | Same as ContentChecksum96 but without transient boilerplate. | CompositeDocAdditionalChecksums | Additional checksums of the document. | String |
| SimHash | Deprecated. Use simhash_v2 and simhash_v2_significance instead. | CompositeDocAdditionalChecksums | Additional checksums of the document. | String |
| SimHashIsTrusted | CompositeDocAdditionalChecksums | Additional checksums of the document. | boolean | |
| simhashV2 | Simhash-v2 is generated by SimHashParseHandler, designed as a complete replacement of simhash-v1 (a.k.a. the original simhash above) from ApproxDupsParseHandler. Simhash-v2 uses a revised algorithm so that it is expected to work better in most cases than simhash-v1. They coexist in current transition period, then simhash-v1 will be retired. | CompositeDocAdditionalChecksums | Additional checksums of the document. | String |
| simhashV2Significance | Simhash-v2-significance is used to describe the confidence about the corresponding simhash-v2 value. It is defined as the average absolute difference from zero of all internal state components when finalizing a simhash-v2 value in HashMultiSetDotCauchy. We used to compare the significance against some pre-defined threshold (default: 20) to get a boolean value “trusted_simhash_v2”. However, it is possible that this field is missing while “simhash_v2” is present, in such case (1) Use “SimHashIsTrusted” instead if it is present, AND/OR (2) Assume “simhash_v2” is trusted if its value is non-zero. | CompositeDocAdditionalChecksums | Additional checksums of the document. | float |
| Url | CompositeDocAlternateName | Alternate names are some urls that we would like to associate with documents in addition to canonicals. Sometimes we may want to serve these alternatenames instead of canonicals. Alternames in CompositeDoc should come from WebMirror pipeline. | String | |
| UrlEncoding | See webutil/urlencoding | CompositeDocAlternateName | Alternate names are some urls that we would like to associate with documents in addition to canonicals. Sometimes we may want to serve these alternatenames instead of canonicals. Alternames in CompositeDoc should come from WebMirror pipeline. | integer |
| ecnFp | Fp96 of webmirror equivalence class as of last time this was exported. | CompositeDocAlternateName | Alternate names are some urls that we would like to associate with documents in addition to canonicals. Sometimes we may want to serve these alternatenames instead of canonicals. Alternames in CompositeDoc should come from WebMirror pipeline. | String |
| ecnFp | Fp96 of webmirror equivalence class as of last time this was exported. | CompositeDocExtraDup | The top non-forwarding dups of the canonical url. | String |
| url | The url of the non-forwarding dup. | CompositeDocExtraDup | The top non-forwarding dups of the canonical url. | String |
| ecn | The name of the url’s webmirror equivalence class. | CompositeDocForwardingDup | The top forwarding dups of the canonical url. (note: it may actually include some dups that are NOT used for forwarding data but for making “info:” complete) | String |
| ecnFp | CompositeDocForwardingDup | The top forwarding dups of the canonical url. (note: it may actually include some dups that are NOT used for forwarding data but for making “info:” complete) | String | |
| purposes | The purpose(s) of the forwarding dup indicating if it is used for forwarding signal/anchors generally, or only for forwarding some specific signal (e.g. navboost), or for some other purposes (e.g., not for forwarding any data but for making “info:” complete). See indexing/dups/public/dups.h for more details. | CompositeDocForwardingDup | The top forwarding dups of the canonical url. (note: it may actually include some dups that are NOT used for forwarding data but for making “info:” complete) | integer |
| rawPagerank | Raw pagerank of the url. | CompositeDocForwardingDup | The top forwarding dups of the canonical url. (note: it may actually include some dups that are NOT used for forwarding data but for making “info:” complete) | integer |
| repid | The webmirror repid of the forwarding dup. | CompositeDocForwardingDup | The top forwarding dups of the canonical url. (note: it may actually include some dups that are NOT used for forwarding data but for making “info:” complete) | String |
| url | The url of the forwarding dup. | CompositeDocForwardingDup | The top forwarding dups of the canonical url. (note: it may actually include some dups that are NOT used for forwarding data but for making “info:” complete) | String |
| urlencoding | The encoding of the url (see webutil/urlencoding for details). | CompositeDocForwardingDup | The top forwarding dups of the canonical url. (note: it may actually include some dups that are NOT used for forwarding data but for making “info:” complete) | integer |
| SourceTypeBitfield | Indicate how this content came to be included. Legal values are constructed by bitwise-OR-ing values from the included_content::SourceType enum. Default SourceTypeBitfield = included_content::INCLUDED_FRAME | CompositeDocIncludedContent | String | |
| includedDoc | CompositeDocIncludedContent | GDocumentBase | ||
| linkUrl | CompositeDocIncludedContent | String | ||
| perDocData | CompositeDocIncludedContent | PerDocData | ||
| properties | CompositeDocIncludedContent | DocProperties | ||
| cdocBuildInfo | To hold extra info for building a final cdoc from raw cdoc and goldmine annotations. | CompositeDocIndexingInfo | Contains information *mostly* used within indexing (e.g. not used for building the production serving shards). Most of this data is generated only in Alexandria, however there are exceptions. | IndexingDocjoinerCDocBuildInfo |
| contentProtected | Whether current page is under content protection, i.e. a page has been crawled as an error page, but we preserve its last known good content and keep its crawl_status as converter.CrawlStatus::CONTENT. | CompositeDocIndexingInfo | Contains information *mostly* used within indexing (e.g. not used for building the production serving shards). Most of this data is generated only in Alexandria, however there are exceptions. | boolean |
| convertToRobotedReason | If set, indicates that the crawl status was converted to ROBOTED for the reason specified by the enum value in converter.RobotedReasons.ConvertToRobotedReasons. See indexing/converter/proto/converter.proto for details. If unset, then the document was not converted to roboted, and if the document crawl status is ROBOTED, then the document is disallowed (at least to Google) in robots.txt. | CompositeDocIndexingInfo | Contains information *mostly* used within indexing (e.g. not used for building the production serving shards). Most of this data is generated only in Alexandria, however there are exceptions. | integer |
| crawlStatus | One of the enum values in converter.CrawlStatus.State (see indexing/converter/proto/converter.proto for details). Default is converter.CrawlStatus::CONTENT. The document is roboted if the value is converter.CrawlStatus::ROBOTED. | CompositeDocIndexingInfo | Contains information *mostly* used within indexing (e.g. not used for building the production serving shards). Most of this data is generated only in Alexandria, however there are exceptions. | integer |
| demotionTags | CompositeDocIndexingInfo | Contains information *mostly* used within indexing (e.g. not used for building the production serving shards). Most of this data is generated only in Alexandria, however there are exceptions. | list(String) | |
| errorType | One of the enum values in converter.ErrorPageType (see indexing/converter/proto/error-page-detector-enum.proto for detail). Default is converter::ERROR_PAGE_NONE. | CompositeDocIndexingInfo | Contains information *mostly* used within indexing (e.g. not used for building the production serving shards). Most of this data is generated only in Alexandria, however there are exceptions. | integer |
| freshdocsCorpora | CompositeDocIndexingInfo | Contains information *mostly* used within indexing (e.g. not used for building the production serving shards). Most of this data is generated only in Alexandria, however there are exceptions. | list(String) | |
| hostid | The host id of the document. Used chiefly to determine whether the document is part of a parked domain. | CompositeDocIndexingInfo | Contains information *mostly* used within indexing (e.g. not used for building the production serving shards). Most of this data is generated only in Alexandria, however there are exceptions. | String |
| ieIdentifier | A short descriptive string to help identify the IE application or setup where this CDoc is generated. For example: websearch_m3 This field is for debuggability purposes. | CompositeDocIndexingInfo | Contains information *mostly* used within indexing (e.g. not used for building the production serving shards). Most of this data is generated only in Alexandria, however there are exceptions. | String |
| imageIndexingInfo | Indexing info about images (i.e. image links missing image data, etc). | CompositeDocIndexingInfo | Contains information *mostly* used within indexing (e.g. not used for building the production serving shards). Most of this data is generated only in Alexandria, however there are exceptions. | ImageSearchImageIndexingInfo |
| indexingTs | The timestamp (the time since the Epoch, in microseconds) when the docjoin is exported from indexing. The main purpose of this field is to identify different versions of the same document. | CompositeDocIndexingInfo | Contains information *mostly* used within indexing (e.g. not used for building the production serving shards). Most of this data is generated only in Alexandria, however there are exceptions. | String |
| noLongerCanonicalTimestamp | If set, the timestamp in microseconds when the URL stopped being canonical. This should never be set for exported canonical documents. This field is used by dups during canonical flip, and by webmain when doc selection switched between desktop and mobile. Union respects this timestamp to prevent old doc being deleted until the new doc is picked up | CompositeDocIndexingInfo | Contains information *mostly* used within indexing (e.g. not used for building the production serving shards). Most of this data is generated only in Alexandria, however there are exceptions. | String |
| normalizedClickScore | This score is calculated by re-mapping the back onto the partition’s score distribution, such that the score represents the score of the equivalently ranked organically-selected document. | CompositeDocIndexingInfo | Contains information *mostly* used within indexing (e.g. not used for building the production serving shards). Most of this data is generated only in Alexandria, however there are exceptions. | number |
| primaryVertical | Vertical membership of the document. – `primary_vertical` is the vertical that initiated indexing of this document (or empty if the vertical was websearch). – `verticals` is the full list of verticals that contained this document (excluding websearch) at indexing time. `primary_vertical` may or may not be an element of `verticals` because of vertical membership skew between the ingestion time and indexing time. See go/one-indexing-for-web for more background. | CompositeDocIndexingInfo | Contains information *mostly* used within indexing (e.g. not used for building the production serving shards). Most of this data is generated only in Alexandria, however there are exceptions. | String |
| rawNavboost | The raw navboost count for the canonical url without aggregating the navboost from dup urls. This field is used when building forwarding map. | CompositeDocIndexingInfo | Contains information *mostly* used within indexing (e.g. not used for building the production serving shards). Most of this data is generated only in Alexandria, however there are exceptions. | integer |
| rowTimestamp | The timestamp (the time since the Epoch, in microseconds) to represent doc version, which is used in the downstream processing after Raffia. If it’s not set, indexing_ts will be used as row_timestamp. The timestamp is generally set by reprocessing to set slightly newer indexing_ts such that the system can respect the reprocessed version to overwrite old data in storage. | CompositeDocIndexingInfo | Contains information *mostly* used within indexing (e.g. not used for building the production serving shards). Most of this data is generated only in Alexandria, however there are exceptions. | String |
| selectionTierRank | Selection tier rank is a language normalized score ranging from 0-1 over the serving tier (Base, Zeppelins, Landfills) for this document. | CompositeDocIndexingInfo | Contains information *mostly* used within indexing (e.g. not used for building the production serving shards). Most of this data is generated only in Alexandria, however there are exceptions. | number |
| tracingId | The tracing ids is to label the version of url for url status tracking. This repeated field will carry at most 10 tracing id. See more details in go/rich-tracing-design There will be less than 2% base+uz cdocs carrying this field. The major sources of tracing ids include: * Indexing API pushed urls * Index Metrics sampling urls The tracing ids will be written into cdocs by Webmain Ramifier. The consumer of the tracing ids is Union serving notification collector see more at go/serving-notification-from-union | CompositeDocIndexingInfo | Contains information *mostly* used within indexing (e.g. not used for building the production serving shards). Most of this data is generated only in Alexandria, however there are exceptions. | list(String) |
| urlChangerate | Changerate information for this doc (see crawler/changerate/changerate.proto for details). | CompositeDocIndexingInfo | Contains information *mostly* used within indexing (e.g. not used for building the production serving shards). Most of this data is generated only in Alexandria, however there are exceptions. | CrawlerChangerateUrlChangerate |
| urlHistory | Url change history for this doc (see crawler/changerate/changerate.proto for details). Note if a doc has more than 20 changes, we only keep the last 20 changes here to avoid adding to much data in its docjoin. | CompositeDocIndexingInfo | Contains information *mostly* used within indexing (e.g. not used for building the production serving shards). Most of this data is generated only in Alexandria, however there are exceptions. | CrawlerChangerateUrlHistory |
| urlPatternSignals | UrlPatternSignals for this doc, used to compute document score in LTG (see indexing/signal_aggregator/proto/signal-aggregator.proto for details). | CompositeDocIndexingInfo | Contains information *mostly* used within indexing (e.g. not used for building the production serving shards). Most of this data is generated only in Alexandria, however there are exceptions. | IndexingSignalAggregatorUrlPatternSignals |
| verticals | CompositeDocIndexingInfo | Contains information *mostly* used within indexing (e.g. not used for building the production serving shards). Most of this data is generated only in Alexandria, however there are exceptions. | list(String) | |
| videoIndexingInfo | Indexing info about videos. | CompositeDocIndexingInfo | Contains information *mostly* used within indexing (e.g. not used for building the production serving shards). Most of this data is generated only in Alexandria, however there are exceptions. | ImageRepositoryVideoIndexingInfo |
| perLiveExperimentInfo | List of necessary information for each live experiments. | CompositeDocLiveExperimentInfo | Contains information needed for end-to-end live experiments. For a cdoc generated by production pipeline, it includes experiment IDs that have selected current document. For a cdoc generated by experiment pipeline, it includes current experiment ID. | list(CompositeDocLiveExperimentInfoPerLiveExperimentInfo) |
| experimentId | ID of a live experiment. | CompositeDocLiveExperimentInfoPerLiveExperimentInfo | Contains information for a live experiment. | String |
| partialCdoc | Partial CDoc for a live experiment. | CompositeDocLiveExperimentInfoPerLiveExperimentInfo | Contains information for a live experiment. | CompositeDoc |
| dupsComputedAlternateNames | A subset of computed variations, only the members which are dups to the main url. Used during serving for swapping in the URL based on regional and language preferences of the user. | CompositeDocLocalizedVariations | list(IndexingDupsComputedLocalizedAlternateNamesLocaleEntry) | |
| webmasterAlternateNames | All localized alternate names provided by the webmaster (canonical and dups, indexed and not-indexed). Used on the ranking side for swapping out results based on the webmaster preference. | CompositeDocLocalizedVariations | list(IndexingConverterLocalizedAlternateName) | |
| goldmineAnnotatorNames | List of goldmine annotator updates present in the enclosing partial cdoc. | CompositeDocPartialUpdateInfo | Contains information about the partial updates present in a partial CompositeDoc. | list(String) |
| imagesSignalNames | List of images signal updates present in the enclosing partial cdoc. Images signal name for a images signal is the unique name for the signal according to SignalSpec. | CompositeDocPartialUpdateInfo | Contains information about the partial updates present in a partial CompositeDoc. | list(String) |
| lastFullIndexingInfo | Contains last full indexing information for partial updates. | CompositeDocPartialUpdateInfo | Contains information about the partial updates present in a partial CompositeDoc. | list(CompositeDocPartialUpdateInfoLastFullIndexingInfo) |
| shouldLookupDocjoinsTier | Which tier we should do cdoc lookup to merge partial cdocs. This uses the integer value of indexing.selection.CorpusId. NOT intended for other usage. | CompositeDocPartialUpdateInfo | Contains information about the partial updates present in a partial CompositeDoc. | integer |
| shouldLookupDocjoinsVerticalCorpus | Which vertical docjoin corpus we should do cdoc lookup to merge partial cdocs. This uses the string value of table name in google3/indexing/docjoins/spanner/schema/global_tables_data.sdl. For example, Voce and ShortVideo. NOT intended for other usage. | CompositeDocPartialUpdateInfo | Contains information about the partial updates present in a partial CompositeDoc. | String |
| signalNames | List of signal updates present in the enclosing partial cdoc. Signal name for a signal is unique name for the signal according to SignalSpec. | CompositeDocPartialUpdateInfo | Contains information about the partial updates present in a partial CompositeDoc. | list(String) |
| corpus | The corpus of last full updates. | CompositeDocPartialUpdateInfoLastFullIndexingInfo | Last full indexing information for the partial CDoc. | String |
| lastFullIndexingTsMicros | Last full update indexing timestamp in microseconds. | CompositeDocPartialUpdateInfoLastFullIndexingInfo | Last full indexing information for the partial CDoc. | String |
| lastSignificantUpdate | Contains a date used for the “Date Last Modified” toolbelt restrict mode. Note: this date is a combined date and is different from the pure shingle-based signal stored in contentage.last_significant_update field. | CompositeDocQualitySignals | Note: This is a misleading name as of 2022/10/14. The field is still set and has meaningful data, but no longer holds quality signals. All the data are freshness-related and they’re not particularly sensitive. | QualityTimebasedLastSignificantUpdate |
| pagetype | CompositeDocQualitySignals | Note: This is a misleading name as of 2022/10/14. The field is still set and has meaningful data, but no longer holds quality signals. All the data are freshness-related and they’re not particularly sensitive. | QualityTimebasedPageType | |
| newsRobotsInfo | CompositeDocRobotsInfoList | List of robots info parsed for the user-agents other than the default used to crawl this page. | IndexingConverterRobotsInfo | |
| ugcDiscussionEffortScore | UGC page quality signals. (Times 1000 and floored) | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | integer |
| productReviewPPromotePage | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | integer | |
| experimentalQstarDeltaSignal | This field is *not* propagated to shards. It is meant to be populated at serving time using one of the versions present in the `experimental_nsr_team_wsj_data` field above (using the `ExperimentalNsrTeamDataOverridesParams` opti to populate it; see http://source/search?q=ExperimentalNsrTeamDataOverridesParams%20file:ascorer.proto). The purpose of this field is to be read by an experimental Q* component, in order to quickly run LEs with new delta components. See go/0DayLEs for details. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | number |
| productReviewPDemoteSite | Product review demotion/promotion confidences. (Times 1000 and floored) | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | integer |
| experimentalQstarSiteSignal | This field is *not* propagated to shards. It is meant to be populated at serving time using one of the versions present in the `experimental_nsr_team_wsj_data` field above (using the `ExperimentalNsrTeamDataOverridesParams` opti to populate it; see http://source/search?q=ExperimentalNsrTeamDataOverridesParams%20file:ascorer.proto). The purpose of this field is to be read by an experimental Q* component, in order to quickly run LEs with new site components. See go/0DayLEs for details. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | number |
| exactMatchDomainDemotion | Page quality signals converted from fields in proto QualityBoost in quality/q2/proto/quality-boost.proto. To save indexing space, we convert the float values in [0, 1] to integers in range [0, 1023] (use 10 bits). exact_match_domain_demotion: converted from QualityBoost.emd.boost. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | integer |
| nsrVersionedData | Versioned NSR score to be used in continuous evaluation of the upcoming NSR version and assess quality impact on various slices. This field is deprecated – used the equivalent field inside nsr_data_proto instead. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | list(NSRVersionedItem) |
| nsrConfidence | NSR confidence score: converted from quality_nsr.NsrData. This field is deprecated – use nsr_variance inside nsr_data_proto instead. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | integer |
| lowQuality | S2V low quality score: converted from quality_nsr.NsrData, applied in Qstar. See quality_nsr::util::ConvertNsrDataToLowQuality. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | integer |
| navDemotion | nav_demotion: converted from QualityBoost.nav_demoted.boost. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | integer |
| pqData | Encoded page-level PQ signals. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | integer |
| siteAuthority | site_authority: converted from quality_nsr.SiteAuthority, applied in Qstar. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | integer |
| crapsNewUrlSignals | For craps_[url|pattern]_signals, please avoid accessing these fields directly, even in minor ways like checking has_craps_*. Instead, please use methods from quality/navboost/craps/craps-lossy-compression.h or talk to craps-team@. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | String |
| babyPandaV2Demotion | New BabyPanda demotion, applied on top of Panda. This is meant to replace |baby_panda_demotion|. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | integer |
| authorityPromotion | authority promotion: converted from QualityBoost.authority.boost | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | integer |
| productReviewPUhqPage | The possibility of a page being a high quality review page. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | integer |
| crapsAbsoluteHostSignals | Impressions, unsquashed, host level, not to be used with compressed ratios. Not to be used in Pattern Data. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | integer |
| productReviewPPromoteSite | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | integer | |
| nsrOverrideBid | NSR override bid, used in Q* for emergency overrides. This field is deprecated – used the equivalent field inside nsr_data_proto instead. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | number |
| babyPandaDemotion | baby_panda_demotion: converted from QualityBoost.rendered.boost. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | integer |
| serpDemotion | serp demotion: applied in Qstar. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | integer |
| anchorMismatchDemotion | anchor_mismatch_demotion: converted from QualityBoost.mismatched.boost. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | integer |
| crapsNewHostSignals | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | String | |
| experimentalQstarSignal | This field is *not* propagated to shards. It is meant to be populated at serving time using one of the versions present in the `experimental_nsr_team_wsj_data` field above (using the `ExperimentalNsrTeamDataOverridesParams` opti to populate it; see http://source/search?q=ExperimentalNsrTeamDataOverridesParams%20file:ascorer.proto). The purpose of this field is to be read by an experimental Q* component, in order to quickly run LEs with new components. See go/0DayLEs for details. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | number |
| pairwiseqScoringData | Deprecated and unused field. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | PairwiseQScoringData |
| topicEmbeddingsVersionedData | Versioned TopicEmbeddings data to be populated later into superroot / used directly in scorers. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | list(QualityAuthorityTopicEmbeddingsVersionedItem) |
| scamness | Scam model score. Used as one of the web page quality qstar signals. Value range from 0 to 1023. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | integer |
| crapsUnscaledIpPriorBadFraction | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | integer | |
| pandaDemotion | This is the encoding of Panda fields in the proto SiteQualityFeatures in quality/q2/proto/site_quality_features.proto. The encoding/decoding is performed using functions from quality_coati::coati_util. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | integer |
| unauthoritativeScore | Unauthoritative score. Used as one of the web page quality qstar signals. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | integer |
| experimentalNsrTeamWsjData | This field is *not* propagated to shards, but it’s populated at serving time by go/web-signal-joins (see b/207344056). See go/0DayLEs for details. This is only meant to be used during LEs, it should *not* be used for launches. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | list(QualityNsrExperimentalNsrTeamWSJData) |
| experimentalNsrTeamData | This field is *not* propagated to shards, but it’s populated at serving time by go/web-signal-joins (see b/207344056). See go/0DayLEs for details. This is only meant to be used during LEs, it should *not* be used for launches. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | QualityNsrExperimentalNsrTeamData |
| productReviewPReviewPage | Fields product_review_p_review_page and product_review_p_uhq_page are for promoting/demoting HQ/LQ review pages in NGS. See go/pr-boosts for details. The possibility of a page being a review page. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | integer |
| pqDataProto | Stripped page-level signals, not present in the encoded field ‘pq_data’. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | QualityNsrPQData |
| pairwiseqVersionedData | Versioned PairwiseQ score to be used in continuous evaluation of the upcoming PairwiseQ versions and assess quality impact on various slices. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | list(PairwiseQVersionedItem) |
| crapsNewPatternSignals | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | String | |
| vlqNsr | NSR for low-quality videos, converted from quality_nsr.NsrData.vlq_nsr. This field is deprecated – used the equivalent field inside nsr_data_proto instead. | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | integer |
| productReviewPDemotePage | CompressedQualitySignals | A message containing per doc signals that are compressed and included in Mustang and TeraGoogle. For TeraGoogle, this message is included in perdocdata which means it can be used in preliminary scoring. CAREFUL: For TeraGoogle, this data resides in very limited serving memory (Flash storage) for a huge number of documents. Next id: 43 | integer | |
| conceptId | ConceptsConceptId | String | ||
| id | uint64 bring lots of issues, and string a better practice. | ConceptsConceptId | String | |
| freshdocsOutgoing | Selected outgoing attributions extracted on FreshDocs. | ContentAttributions | The following protobuf is used to store an attribution from one page to (usually) one other page, giving credit for the content. This information is used during ranking to promote the attributed page. This protobuf is copied from a quality_contra::SelectedAttribution. See //quality/contra/authorship/attribution and https://qwiki.corp.google.com/display/Q/ContentTrackingContentAttribution. | list(ContentAttributionsOutgoingAttribution) |
| offlineOutgoing | Selected outgoing attributions extracted via offline MR jobs. | ContentAttributions | The following protobuf is used to store an attribution from one page to (usually) one other page, giving credit for the content. This information is used during ranking to promote the attributed page. This protobuf is copied from a quality_contra::SelectedAttribution. See //quality/contra/authorship/attribution and https://qwiki.corp.google.com/display/Q/ContentTrackingContentAttribution. | list(ContentAttributionsOutgoingAttribution) |
| onlineOutgoing | Selected outgoing attributions extracted online on Alexandria. | ContentAttributions | The following protobuf is used to store an attribution from one page to (usually) one other page, giving credit for the content. This information is used during ranking to promote the attributed page. This protobuf is copied from a quality_contra::SelectedAttribution. See //quality/contra/authorship/attribution and https://qwiki.corp.google.com/display/Q/ContentTrackingContentAttribution. | list(ContentAttributionsOutgoingAttribution) |
| bestEvidenceType | ContentAttributionsOutgoingAttribution | This is a copy of quality_contra::SelectedAttribution::SelectedInfo. The url is converted to docid and other fields are copied directly. | String | |
| docid | ContentAttributionsOutgoingAttribution | This is a copy of quality_contra::SelectedAttribution::SelectedInfo. The url is converted to docid and other fields are copied directly. | String | |
| properties | ContentAttributionsOutgoingAttribution | This is a copy of quality_contra::SelectedAttribution::SelectedInfo. The url is converted to docid and other fields are copied directly. | integer | |
| usableForClustering | ContentAttributionsOutgoingAttribution | This is a copy of quality_contra::SelectedAttribution::SelectedInfo. The url is converted to docid and other fields are copied directly. | boolean | |
| mustangBytes | Compact representation for Mustang storage. See image/search/utils/packed_crops.h for details on the packing format. | ContentAwareCropsIndexing | String | |
| mustangBytesVersion | ContentAwareCropsIndexing | integer | ||
| canonicalLexicalMid | Mid for an entity that has lexical data (a LexiconEntry). See https://g3doc.corp.google.com/nlp/generation/g3doc/lexical_data.md for for more information about lexical data. This is the canonical mid for this entity (eg. it would be for “mother” in EN even if user referred to “mom”). | CopleyLexicalMetadata | Contains lexical metadata for a given reference. For example, this proto will be used to store locale-specific Lexical mids for contact relationships (e.g. /g/11gv0vypg4 is the mid for mother in english and /g/11gmy_gv87 is for mother in french) as an extension to QRefAnnotation::other_metadata, when available. | String |
| personalReferenceType | The manner in which the entity was referenced (e.g. “my hotel”, “the airport”). | CopleyPersonalReference | Represents a reference made by a user that refers to some personal entity. | String |
| referenceScore | The strength of the personal reference. For example “my flight” may receive a high reference_score, whereas “the airport” may receive a low score. | CopleyPersonalReferenceMetadata | General message used to store metadata about references to personal entities, even if those entities cannot be resolved. | number |
| references | A list of all references made. Empty if no personal references exist. Multiple references can be present when multiple references were made in a single query, or the type of reference was ambiguous. | CopleyPersonalReferenceMetadata | General message used to store metadata about references to personal entities, even if those entities cannot be resolved. | list(CopleyPersonalReference) |
| subreferenceMetadata | Subreference metadata for all compound references on this span. | CopleyPersonalReferenceMetadata | General message used to store metadata about references to personal entities, even if those entities cannot be resolved. | CopleySubreferenceMetadata |
| sourceTypeMetadata | CopleySourceTypeList | list(CopleySourceTypeMetadata) | ||
| contactAnnotationId | Annotation ID of a contact annotation, e.g. a relationship set via Assistant. This ID is generated by People Write Server. It is used to delete Contact Annotations via People API. | CopleySourceTypeMetadata | Contains the source and type information related to a personal entity, for example if it’s an hotel or a restaurant (type) and if it comes from gmail, calendar, etc. (source). Next ID: 13 | String |
| displayableName | CopleySourceTypeMetadata | Contains the source and type information related to a personal entity, for example if it’s an hotel or a restaurant (type) and if it comes from gmail, calendar, etc. (source). Next ID: 13 | String | |
| emailIdentifier | Only used if personal_data_provenance == PERSONAL_SOURCE_GMAIL. Used to create a link to the source email in the form: mail.google.com/mail/u/0/?extsrc=sync&client=h&plid={email_identifier} | CopleySourceTypeMetadata | Contains the source and type information related to a personal entity, for example if it’s an hotel or a restaurant (type) and if it comes from gmail, calendar, etc. (source). Next ID: 13 | String |
| eventId | Populated for some footprints data sources; uniquely identifies the footprint that generated the personal data that this provenance is attached to. | CopleySourceTypeMetadata | Contains the source and type information related to a personal entity, for example if it’s an hotel or a restaurant (type) and if it comes from gmail, calendar, etc. (source). Next ID: 13 | EventIdMessage |
| localDiscoverySettingsMetadata | CopleySourceTypeMetadata | Contains the source and type information related to a personal entity, for example if it’s an hotel or a restaurant (type) and if it comes from gmail, calendar, etc. (source). Next ID: 13 | PersonalizationSettingsApiProtoLocalDiscoveryLocalDiscoverySettingsMetadata | |
| personalDataProvenance | CopleySourceTypeMetadata | Contains the source and type information related to a personal entity, for example if it’s an hotel or a restaurant (type) and if it comes from gmail, calendar, etc. (source). Next ID: 13 | String | |
| personalDataType | CopleySourceTypeMetadata | Contains the source and type information related to a personal entity, for example if it’s an hotel or a restaurant (type) and if it comes from gmail, calendar, etc. (source). Next ID: 13 | String | |
| provenanceCategory | CopleySourceTypeMetadata | Contains the source and type information related to a personal entity, for example if it’s an hotel or a restaurant (type) and if it comes from gmail, calendar, etc. (source). Next ID: 13 | list(String) | |
| sensitivity | Sensitivity applying to this copley annotation. | CopleySourceTypeMetadata | Contains the source and type information related to a personal entity, for example if it’s an hotel or a restaurant (type) and if it comes from gmail, calendar, etc. (source). Next ID: 13 | KnowledgeAnswersSensitivitySensitivity |
| mostCompoundResolvedEntities | Resolved entities are sorted from highest resolution score to lowest. | CopleySubreferenceMetadata | Represents the most compound resolved entities and most nested unresolved references for a span. Useful for punting. | list(CopleySubreferenceResolution) |
| mostNestedUnresolvedReference | This is a merged representation of the compound reference having the most_compound_resolved_entities as an argument. | CopleySubreferenceMetadata | Represents the most compound resolved entities and most nested unresolved references for a span. Useful for punting. | CopleySubreferenceReference |
| personalReferenceTypes | Type of reference. There may be multiple for a single reference (e.g. relationship and contact). | CopleySubreferenceReference | Represents a reference that may be part of a larger compound reference. For example, “my brother’s birthday” will have a subreference that may have references for “my brother”. | list(String) |
| referenceScore | Highest reference score for any references merged in this span. | CopleySubreferenceReference | Represents a reference that may be part of a larger compound reference. For example, “my brother’s birthday” will have a subreference that may have references for “my brother”. | number |
| relationshipLexicalInfo | Only set for unresolved relationship references and can be used to get the canonical word for the relationship (e.g. “mother”) in TTS. | CopleySubreferenceReference | Represents a reference that may be part of a larger compound reference. For example, “my brother’s birthday” will have a subreference that may have references for “my brother”. | CopleyLexicalMetadata |
| mid | Can be used with PKG Service for looking up metadata about this entity at fulfillment/GenX time. | CopleySubreferenceResolution | Represents a resolution that may be part of a larger compound reference. For example, “my brother’s birthday” will have a subreference that may have resolutions for “my brother”. | String |
| name | Name of the entity represented by this resolution. | CopleySubreferenceResolution | Represents a resolution that may be part of a larger compound reference. For example, “my brother’s birthday” will have a subreference that may have resolutions for “my brother”. | String |
| resolutionScore | A resolution score of 0 indicates that it did not resolve to a real entity. | CopleySubreferenceResolution | Represents a resolution that may be part of a larger compound reference. For example, “my brother’s birthday” will have a subreference that may have resolutions for “my brother”. | number |
| corpus | CorpusSelectionInfo | String | ||
| corpusScore | Corpus specific score for an image | CorpusSelectionInfo | number | |
| isSelectedForIndexing | Whether an image was selected for indexing. | CorpusSelectionInfo | boolean | |
| referrerDocid | Set of referrers indexed with the image. | CorpusSelectionInfo | list(String) | |
| referrerUrls | Set of referrer urls indexed with the image. | CorpusSelectionInfo | list(String) | |
| confidence | To store confidence in the distribution in cases when total is not set. | CountryClickDistribution | float | |
| item | CountryClickDistribution | list(CountryClickDistributionItem) | ||
| total | To store total clicks on this page/domain. | CountryClickDistribution | float | |
| doubleValue | CountryClickDistributionItem | float | ||
| name | CountryClickDistributionItem | String | ||
| value | CountryClickDistributionItem | integer | ||
| debug | A non critical field to store debug info for a country attachment. Used in experiments and for debugging. | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | String |
| salientCountrySet | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | QualitySalientCountriesSalientCountrySet | |
| provinceGeotokenList | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | list(CountryProvinceGeotoken) | |
| countryidFromUgc | Is true if the country attachment was computed through the UGC pipeline. | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | boolean |
| fromUrlPattern | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | boolean | |
| weightAboveIdealForLocalness | If result is global, store weight above ideal, as a confidence signal. Used in query localness, cleared in production CountryAttachment. | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | float |
| existNextLevel | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | boolean | |
| global | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | boolean | |
| urlPatternBasedCountry | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | integer | |
| fromLanguageFallback | Booleans to keep track of where the country-id of the page came from. These are used for debugging and/or unittests, and cleared in production. | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | boolean |
| salientCountries | [Experimental]: Top salient countries for a doc. If a country can not be found on this field it can be considered that this doc is not relevant to it. | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | list(CountrySalientCountry) |
| fromRestricts | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | boolean | |
| relatedCountries | two-letter(lower-case) countrycode, e.g. us countries that is related to, but not local to | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | list(String) |
| relatedCountryCodes | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | list(integer) | |
| sitename | Domain name of keys in filtering metro reducer class, used only by the intermediate mapreduces to produce filtered data. | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | String |
| fromUgc | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | boolean | |
| localCountryCodes | Fields that actually store the country id in docjoins. The format of this data is defined in //i18n/identifiers/stableinternalregionconverter.cc. Converter defined there can be used to convert it to RegionCode format. | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | list(integer) |
| clickDistribution | Store weighted click distribution for page level country-id classification. | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | CountryClickDistribution |
| localCountries | two-letter(lower-case) countrycode, e.g. us countries that is local to | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | list(String) |
| geoLocations | New MetroID: Now called GeoLocations since the locations could be sublocalities, cities or states. GeoLocations are always more fine grained than country. TODO (jayeshv): Once new MetroID/GeoLocations is launched everywhere, deleted old MetroID related fields. | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | CountryGeoLocations |
| superGlobal | Super global pages get lesser demotion than global pages. A document can only be either global or super_global but not both. | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | boolean |
| isValidForCountryRestrict | Set to true if the local_countries field can be used for country restricts as well. | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | boolean |
| documentLocationSource | Specifies the origin of `geo_locations`. Right now, it can either come from deprecated Docloc system or the new Brainloc system when Docloc doesn’t have sufficient evidence. | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | String |
| fromSgDomains | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | boolean | |
| fromWmx | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | boolean | |
| userVisibleCountryFromLogs | This is used to store the visible country id computed from logs data | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | String |
| fromTld | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | boolean | |
| metroIdList | Metro locations: list of NavBoost feature V2 associated with a doc, along with the enclosing province. Metro locations with new tags. | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | list(CountryMetroNBFeature) |
| restrictCountries | List of two-letter(lower-case) countrycodes(e.g. us) valid for restricts. Typically cloned out of local_countries if is_valid_for_country_restrict is set to true. | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | list(String) |
| debugSourceUrl | Set to the signal source URLs when merging country signals in Alexandria during sitemoves. Essentially if sites A and B move to C, and we merge A and B’s signal to C, in the countryattachment signal C will have URL A and B as source_url. Only used for debugging and it doesn’t show up in docjoins. | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | list(String) |
| wmxCountry | Country specified for a web-site through webmaster console. | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | String |
| metroNavboost | Metro navboost: list of (NavBoost feature V2, navboost float) pairs. | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | list(CountryMetroNBFeature) |
| urlPatternBasedLanguage | Language and country extracted using the URL pattern map. | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | integer |
| metroLocationId | Metro level data. metro_location_id stores geotokens for metro restricts. | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | list(String) |
| userVisibleLocalCountry | This is the country id we show to users on the result page. This is kept different from country demotion country id because we dont want to expose our backoff and url based detection algorithm – also we want to be ultra conservative in showing this. | CountryCountryAttachment | If you add new fields to this message, do not use any tag value less than the “Next free tag” below. The lower tag values might be missing in this file, but they were used in past for some field, so cannot be used again. Next free tag: 44 | integer |
| clickRadius50Percent | The radius (in miles) around the assigned location that the document gets 50% of its clicks. | CountryGeoLocation | Stores one location and all meta-data associated with that location. | integer |
| confidence | Confidence on the location. Ranges in [0.0, 1.0]. Cleared during index creation. | CountryGeoLocation | Stores one location and all meta-data associated with that location. | number |
| confidencePercent | Confidence mapped to [0, 100]. Converted to integer for efficient storage. Populated during index creation. | CountryGeoLocation | Stores one location and all meta-data associated with that location. | integer |
| internalId | Used for compressed docloc data. In compressed data, instead of location_info, only an integer ID for that LocationInfo is stored. A separate lookup table is used to get full LocationInfo from the internal ID. | CountryGeoLocation | Stores one location and all meta-data associated with that location. | integer |
| locationInfo | CountryGeoLocation | Stores one location and all meta-data associated with that location. | CountryLocationInfo | |
| propagatedFromASubpage | True if this location is assigned to one of the subpages, and not to the page itself. If the total number of locations assigned to all the subpages of a page is small (usually up to 5), then that page also gets assigned those locations, and this flag is set for those locations. | CountryGeoLocation | Stores one location and all meta-data associated with that location. | boolean |
| geoLocation | CountryGeoLocations | List of locations assigned to a document. | list(CountryGeoLocation) | |
| isNonLocationSpecific | This will be set to true for documents which receive several clicks but are not assigned any location because the click distribution is flat. Typical examples are global sites like facebook.com, chains like walmart.com, informational sites like wikipedia.org etc. This flag is not propagated to deeper pages since this signal is meant to indicate that a website or a part of website is conclusively non-local, so propagating this information to deeper pages does not make sense. If this flag is set, then the only possible geo_location will be the ones which are propagated_from_a_subpage. | CountryGeoLocations | List of locations assigned to a document. | boolean |
| propagationDepthFromParent | Depth of the URL from it’s nearest parent in GeoLocation data. Webpages inherhit locations from their parent pages. For example, if foo.com/a is assigned location L1, and foo.com/a/b is not assigned any location, then http://www.foo.com/a/b inherits location L1 from it’s nearest parent foo.com/a in GeoLocation data. This attribute is the distance from the nearest parent which is present in GeoLocation data. In this particular case, it will be 1. | CountryGeoLocations | List of locations assigned to a document. | integer |
| center | The latitude and longitude of the conceptual center of the location. For cities, this would be the center of the downtown, or maybe the location of city hall. For states and countries it might be the capital city. But there are no guarantees and this may be any random point inside the location. | CountryLocationInfo | This represents one location. | GeostorePointProto |
| city | CountryLocationInfo | This represents one location. | String | |
| country | Human readable name hierarchy. Only the relevant fields will be present. For example for city GeoLocations, sub_locality field will not be present. Cleared during index creation. | CountryLocationInfo | This represents one location. | String |
| county | CountryLocationInfo | This represents one location. | String | |
| enclosingStateFeatureId | Oyster feature ID of the enclosing state. Cleared during index creation. | CountryLocationInfo | This represents one location. | GeostoreFeatureIdProto |
| featureId | Oyster feature ID of the location. Cleared during index creation. | CountryLocationInfo | This represents one location. | GeostoreFeatureIdProto |
| state | CountryLocationInfo | This represents one location. | String | |
| stateIdFprint | 32 bit fingerprint of the feature id of the state of this location. For cities and sub-localities it will be the enclosing state. For state locations, it will be fingerprint of the feture-id of the location itself. Populated during index creation. | CountryLocationInfo | This represents one location. | integer |
| subLocality | CountryLocationInfo | This represents one location. | String | |
| type | Type of the location (sub-locality, city, state etc). | CountryLocationInfo | This represents one location. | String |
| enclosingProvinceGeotoken | The enclosing_province_geotoken is a 32 bit fingerprint of the state encosing the (metro) id. MetroId’s can span multiple states. Enclosing geotoken is filled in with the state name for disambiguation. ProvinceGeotoken field is different as it indicates an “interest”. Format: 32 bit fingerprint(__state__country). | CountryMetroNBFeature | A metro feature, keyed by NavBoost feature id V2. This can be a metro id, a boost, or extended in the future to add probabilities or weights. | integer |
| id | A 32 bit navboost v2 feature id encoding (country, language, metro). NavBoosterUtils class (google3/quality/navboost/nav_booster_utils.h) provides functions to decode this feature. | CountryMetroNBFeature | A metro feature, keyed by NavBoost feature id V2. This can be a metro id, a boost, or extended in the future to add probabilities or weights. | integer |
| navboost | This is the multiplier to apply to the result for this locale & query. NOTE: This is for serving purposes only and should not be populated in the index. | CountryMetroNBFeature | A metro feature, keyed by NavBoost feature id V2. This can be a metro id, a boost, or extended in the future to add probabilities or weights. | number |
| geotoken | CountryProvinceGeotoken | A 32 bit fingerprint of a state level geotoken. The geotoken is in the following format: __state__country. These indicate a page is of interest to these states/regions of a country. The use of message is to enable easy additions of probabilities or weights per metro id in the future. | integer | |
| compressedSalience | CountrySalientCountry | Salient Countries is an estimated probability (salience) of a doc to be relevant to a country. On this message, countries are represented as int32 (the format of this data is defined in i18n/identifiers/stableinternalregionconverter.cc). Salience is a value in range [0.0 – 1.0] in which 1.0 represents a high likelihood to be relevant to the country | integer | |
| countryCode | CountrySalientCountry | Salient Countries is an estimated probability (salience) of a doc to be relevant to a country. On this message, countries are represented as int32 (the format of this data is defined in i18n/identifiers/stableinternalregionconverter.cc). Salience is a value in range [0.0 – 1.0] in which 1.0 represents a high likelihood to be relevant to the country | integer | |
| salience | CountrySalientCountry | Salient Countries is an estimated probability (salience) of a doc to be relevant to a country. On this message, countries are represented as int32 (the format of this data is defined in i18n/identifiers/stableinternalregionconverter.cc). Salience is a value in range [0.0 – 1.0] in which 1.0 represents a high likelihood to be relevant to the country | number | |
| components | CrawlerChangerateMultipleComponentDistribution | Proto contains parameters for a multiple component distributions, where each component has non-negative weight and the sum of component weights is 1. | list(CrawlerChangerateSingleComponentDistribution) | |
| logScaling | Scaling factor to ensure the approximated posterior to have the same scale as the product of prior and likelihood. This value is used to compute posterior weights. Uses log scale to provide a wider range. This field is for internal use only. | CrawlerChangerateSingleComponentDistribution | Proto contains parameters of a single component distribution. | number |
| type | The type indicates the type of the distribution. | CrawlerChangerateSingleComponentDistribution | Proto contains parameters of a single component distribution. | String |
| weight | The weight is only used in multiple component scenarios. | CrawlerChangerateSingleComponentDistribution | Proto contains parameters of a single component distribution. | number |
| additionalChangesMerged | Duplicate UrlChanges crawled within a specified time range will be merged together. UrlChanges are considered duplicates if the simhash, simhash_is_trusted, simhash_v2, simhash_v2_is_trusted, and shingle_simhash are the same. additional_changes_merged indiciates the number of duplicate UrlChanges merged into this UrlChange. | CrawlerChangerateUrlChange | NEXT_TAG: 13 | integer |
| fractionalTileChange | Deprecated fields. The fraction of tiles (0 to 1) that changed. | CrawlerChangerateUrlChange | NEXT_TAG: 13 | float |
| interval | The length in seconds of the change. | CrawlerChangerateUrlChange | NEXT_TAG: 13 | integer |
| offDomainLinksChange | Whether the content of the off-domain links changed. | CrawlerChangerateUrlChange | NEXT_TAG: 13 | boolean |
| offDomainLinksCount | The new count of off-domain links, if they changed. | CrawlerChangerateUrlChange | NEXT_TAG: 13 | integer |
| onDomainLinksCount | The new count of on-domain links, if the count changed. | CrawlerChangerateUrlChange | NEXT_TAG: 13 | integer |
| onDomainLinksCountChange | Whether the number of on-domain links changed. | CrawlerChangerateUrlChange | NEXT_TAG: 13 | boolean |
| shingleSimhash | The old simhash value obtained from shingles. | CrawlerChangerateUrlChange | NEXT_TAG: 13 | IndexingConverterShingleFingerprint |
| simhash | The simhash-v1 value. Use of simhash-v1 is deprecated, and newer UrlChange should only contain simhash-v2. During this transition period, UrlChange can contain either simhash or simhash_v2. It is possible that previous UrlChange only contain simhash-v1 and the next UrlChange only contain simhash-v2. In this case, we skip that interval in our changerate computation. [go/changerate-simhash-v2-migration] | CrawlerChangerateUrlChange | NEXT_TAG: 13 | String |
| simhashIsTrusted | Whether the simhash-v1 should be trusted. | CrawlerChangerateUrlChange | NEXT_TAG: 13 | boolean |
| simhashV2 | The simhash-v2 value. | CrawlerChangerateUrlChange | NEXT_TAG: 13 | String |
| simhashV2IsTrusted | Whether the simhash-v2 value should be trusted. | CrawlerChangerateUrlChange | NEXT_TAG: 13 | boolean |
| approximatedPosterior | The approximated posterior distribution. | CrawlerChangerateUrlChangerate | The next available field number is 22. To access the best estimate of change period, please use GetChangePeriod in predict-change-rate.h to select between this and other change period estimates below. | CrawlerChangerateMultipleComponentDistribution |
| averageChangeSignificance | The “significance” of the average change we saw of this document (from 0 to 1). Influenced by content changes. This can be used for prioritizing the crawl (higher significance first). | CrawlerChangerateUrlChangerate | The next available field number is 22. To access the best estimate of change period, please use GetChangePeriod in predict-change-rate.h to select between this and other change period estimates below. | float |
| changeperiod | //////////////////////////////////////////////////////////////////////////// The classic changerate estimation. //////////////////////////////////////////////////////////////////////////// The classic estimate of change period (in seconds). It is computed by inserted a “fake” change and no-change interval as a prior distribution. This field is generally not used and should NOT be accessed directly. See above for correct method for determining the change period estimate. | CrawlerChangerateUrlChangerate | The next available field number is 22. To access the best estimate of change period, please use GetChangePeriod in predict-change-rate.h to select between this and other change period estimates below. | integer |
| confidence | The confidence (between 0 and 1) in the changeperiod guess. | CrawlerChangerateUrlChangerate | The next available field number is 22. To access the best estimate of change period, please use GetChangePeriod in predict-change-rate.h to select between this and other change period estimates below. | float |
| globalBasedChangePeriod | //////////////////////////////////////////////////////////////////////////// The changerate estimation based on the global prior. //////////////////////////////////////////////////////////////////////////// The global-based changeperiod. This is our estimate (in seconds) for the average time between changes. It is computed using the new prior method based on global_based_prior_period and the global_based_prior_strength specified below. This is used for computing pattern priors. Use pattern_based_change_period or changeperiod fields for all other purposes. | CrawlerChangerateUrlChangerate | The next available field number is 22. To access the best estimate of change period, please use GetChangePeriod in predict-change-rate.h to select between this and other change period estimates below. | integer |
| globalBasedChangePeriodConfidence | The ‘confidence’ of the global-based changeperiod. This is the n-th root of the posterior evaluated at MAP point, where n is the number of history intervals. For now, it is hard to interpret the meaning of the absolute values of ‘average’ posterior cross different sets of data. | CrawlerChangerateUrlChangerate | The next available field number is 22. To access the best estimate of change period, please use GetChangePeriod in predict-change-rate.h to select between this and other change period estimates below. | float |
| globalBasedPriorPeriod | The 2 parameters below specify the prior employed in calculating the global_based_change_period. These values are precomputed through an offline analysis and specified via flags. | CrawlerChangerateUrlChangerate | The next available field number is 22. To access the best estimate of change period, please use GetChangePeriod in predict-change-rate.h to select between this and other change period estimates below. | float |
| globalBasedPriorStrength | CrawlerChangerateUrlChangerate | The next available field number is 22. To access the best estimate of change period, please use GetChangePeriod in predict-change-rate.h to select between this and other change period estimates below. | float | |
| lastChangeSignificance | The “significance” of the last change we saw of this document (from 0 to 1). Influenced by content changes, etc. This can be used for prioritizing the crawl (higher significance first). | CrawlerChangerateUrlChangerate | The next available field number is 22. To access the best estimate of change period, please use GetChangePeriod in predict-change-rate.h to select between this and other change period estimates below. | float |
| lastChanged | The last time (unix timestamp) we saw a changed copy of the document. Provided iff we have seen the page change. | CrawlerChangerateUrlChangerate | The next available field number is 22. To access the best estimate of change period, please use GetChangePeriod in predict-change-rate.h to select between this and other change period estimates below. | integer |
| lastFetched | The last time (unix timestamp) we saw a fetched copy of the document. | CrawlerChangerateUrlChangerate | The next available field number is 22. To access the best estimate of change period, please use GetChangePeriod in predict-change-rate.h to select between this and other change period estimates below. | integer |
| numIntervals | The number of intervals we’ve seen for this document (where an interval is two different versions). | CrawlerChangerateUrlChangerate | The next available field number is 22. To access the best estimate of change period, please use GetChangePeriod in predict-change-rate.h to select between this and other change period estimates below. | integer |
| patternBasedChangePeriod | //////////////////////////////////////////////////////////////////////////// The changerate estimation based on the pattern prior. //////////////////////////////////////////////////////////////////////////// The pattern-based changeperiod. This is our estimate (in seconds) for the average time between changes. It is calculated based on the pattern_based_prior_period and pattern_based_prior_strength below. This quantity will eventually replace the old changeperiod calculation. | CrawlerChangerateUrlChangerate | The next available field number is 22. To access the best estimate of change period, please use GetChangePeriod in predict-change-rate.h to select between this and other change period estimates below. | integer |
| patternBasedChangePeriodConfidence | The same as global_based_change_period_confidence, except it is computed using pattern based priors. | CrawlerChangerateUrlChangerate | The next available field number is 22. To access the best estimate of change period, please use GetChangePeriod in predict-change-rate.h to select between this and other change period estimates below. | float |
| patternBasedLowerChangePeriod | The lower edge of a confidence interval for the pattern-based change period. | CrawlerChangerateUrlChangerate | The next available field number is 22. To access the best estimate of change period, please use GetChangePeriod in predict-change-rate.h to select between this and other change period estimates below. | integer |
| patternBasedPriorPeriod | The 2 parameters below specify the prior employed in calculating the pattern_based_change_period. These values are calculated in a separate process and looked up based on the URL pattern. | CrawlerChangerateUrlChangerate | The next available field number is 22. To access the best estimate of change period, please use GetChangePeriod in predict-change-rate.h to select between this and other change period estimates below. | float |
| patternBasedPriorStrength | CrawlerChangerateUrlChangerate | The next available field number is 22. To access the best estimate of change period, please use GetChangePeriod in predict-change-rate.h to select between this and other change period estimates below. | float | |
| patternChangePeriodVersion | The version number of the algorithm, refer to ChangePeriodVersion for more information. | CrawlerChangerateUrlChangerate | The next available field number is 22. To access the best estimate of change period, please use GetChangePeriod in predict-change-rate.h to select between this and other change period estimates below. | integer |
| type | //////////////////////////////////////////////////////////////////////////// Basic information of a document. //////////////////////////////////////////////////////////////////////////// The type of the document determined by crawl histories, refer to TYPE for more information. | CrawlerChangerateUrlChangerate | The next available field number is 22. To access the best estimate of change period, please use GetChangePeriod in predict-change-rate.h to select between this and other change period estimates below. | integer |
| ugcChangePeriod | //////////////////////////////////////////////////////////////////////////// The UGC changerate estimation. //////////////////////////////////////////////////////////////////////////// Information on change period generated from user generated content (UGC) change history. | CrawlerChangerateUrlChangerate | The next available field number is 22. To access the best estimate of change period, please use GetChangePeriod in predict-change-rate.h to select between this and other change period estimates below. | integer |
| ugcChangePeriodConfidence | CrawlerChangerateUrlChangerate | The next available field number is 22. To access the best estimate of change period, please use GetChangePeriod in predict-change-rate.h to select between this and other change period estimates below. | float | |
| change | All the changes we’ve seen for this URL. | CrawlerChangerateUrlHistory | list(CrawlerChangerateUrlChange) | |
| latestVersion | The latest version we’ve seen. | CrawlerChangerateUrlHistory | CrawlerChangerateUrlVersion | |
| url | This field in only set in ‘url_history’ column of Union repository to avoid having to read CompositeDocs. | CrawlerChangerateUrlHistory | String | |
| additionalChangesMerged | Same as the field in UrlChange. This allows us to merge identical UrlVersions into a single UrlVersion. | CrawlerChangerateUrlVersion | NEXT_TAG: 15 | integer |
| contentType | The content type of the page. | CrawlerChangerateUrlVersion | NEXT_TAG: 15 | integer |
| isImsNotModified | Whether this is an IMS response (a 304, not modified). | CrawlerChangerateUrlVersion | NEXT_TAG: 15 | boolean |
| lastModified | The date from the LastModified header, if present. | CrawlerChangerateUrlVersion | NEXT_TAG: 15 | integer |
| shingleSimhash | The simhash value obtained from shingles. | CrawlerChangerateUrlVersion | NEXT_TAG: 15 | IndexingConverterShingleFingerprint |
| simhash | The simhash-v1 value. The simhash-v1 is now deprecated and new UrlVersions should only populate simhash-v2. During migration phase from using simhash-v1 to simhash-v2, it is possible that previous UrlChange only contain simhash-v1 and the next UrlChange / UrlVersion could only contain simhash-v2. In this case, we skip that interval in our changerate computation. [go/changerate-simhash-v2-migration] | CrawlerChangerateUrlVersion | NEXT_TAG: 15 | String |
| simhashIsTrusted | Whether the simhash-v1 should be trusted. | CrawlerChangerateUrlVersion | NEXT_TAG: 15 | boolean |
| simhashV2 | The simhash-v2 value. | CrawlerChangerateUrlVersion | NEXT_TAG: 15 | String |
| simhashV2IsTrusted | Whether the simhash-v2 value should be trusted. | CrawlerChangerateUrlVersion | NEXT_TAG: 15 | boolean |
| timestamp | The timestamp we crawled the page. | CrawlerChangerateUrlVersion | NEXT_TAG: 15 | integer |
| newscluster | CrowdingPerDocData | list(CrowdingPerDocDataNewsCluster) | ||
| ClusterId | Fingerprint combination of all urls in a cluster | CrowdingPerDocDataNewsCluster | For crowding in news we need to keep data about the last X clustering iterations around. | String |
| ClusterSize | This is the X in the “and X related >>” link on headlines and search results | CrowdingPerDocDataNewsCluster | For crowding in news we need to keep data about the last X clustering iterations around. | integer |
| ClusterTimeStamp | When was this clustered (needed for keeping last X iterations around and discarding earlier ones) | CrowdingPerDocDataNewsCluster | For crowding in news we need to keep data about the last X clustering iterations around. | integer |
| cropBytes | Compact representation for indexing, see creatism::CropBitmap for details on the packing format. | DeepCropIndexing | String | |
| x0 | Pixels version of the DeepCropIndexing bytes, this corresponds to the crop box for a given image (based input image size and desired aspect ratio). | DeepCropPixels | integer | |
| x1 | DeepCropPixels | integer | ||
| y0 | DeepCropPixels | integer | ||
| y1 | DeepCropPixels | integer | ||
| avgTermWeight | The average weighted font size of a term in the doc body | DocProperties | NOTE: In segindexer, the docproperties of a document may be reused from a previous cycle if its content is not changed. If you add a new field to DocProperties, make sure it is taken care (i.e., gets copied from a previous cycle to the current document) in CDocProperties::EndDocument(). | integer |
| badTitle | Missing or meaningless title | DocProperties | NOTE: In segindexer, the docproperties of a document may be reused from a previous cycle if its content is not changed. If you add a new field to DocProperties, make sure it is taken care (i.e., gets copied from a previous cycle to the current document) in CDocProperties::EndDocument(). | boolean |
| badtitleinfo | DocProperties | NOTE: In segindexer, the docproperties of a document may be reused from a previous cycle if its content is not changed. If you add a new field to DocProperties, make sure it is taken care (i.e., gets copied from a previous cycle to the current document) in CDocProperties::EndDocument(). | list(DocPropertiesBadTitleInfo) | |
| languages | A Language enum value. See: go/language-enum | DocProperties | NOTE: In segindexer, the docproperties of a document may be reused from a previous cycle if its content is not changed. If you add a new field to DocProperties, make sure it is taken care (i.e., gets copied from a previous cycle to the current document) in CDocProperties::EndDocument(). | list(integer) |
| leadingtext | Leading text information generated by google3/quality/snippets/leadingtext/leadingtext-detector.cc | DocProperties | NOTE: In segindexer, the docproperties of a document may be reused from a previous cycle if its content is not changed. If you add a new field to DocProperties, make sure it is taken care (i.e., gets copied from a previous cycle to the current document) in CDocProperties::EndDocument(). | SnippetsLeadingtextLeadingTextInfo |
| numPunctuations | DocProperties | NOTE: In segindexer, the docproperties of a document may be reused from a previous cycle if its content is not changed. If you add a new field to DocProperties, make sure it is taken care (i.e., gets copied from a previous cycle to the current document) in CDocProperties::EndDocument(). | integer | |
| numTags | DocProperties | NOTE: In segindexer, the docproperties of a document may be reused from a previous cycle if its content is not changed. If you add a new field to DocProperties, make sure it is taken care (i.e., gets copied from a previous cycle to the current document) in CDocProperties::EndDocument(). | integer | |
| numTokens | The number of tokens, tags and punctuations in the tokenized contents. This is an approximation of the number of tokens, tags and punctuations we end up with in mustang, but is inexact since we drop some tokens in mustang and also truncate docs at a max cap. | DocProperties | NOTE: In segindexer, the docproperties of a document may be reused from a previous cycle if its content is not changed. If you add a new field to DocProperties, make sure it is taken care (i.e., gets copied from a previous cycle to the current document) in CDocProperties::EndDocument(). | integer |
| proseRestrict | The restricts for CSE structured search. | DocProperties | NOTE: In segindexer, the docproperties of a document may be reused from a previous cycle if its content is not changed. If you add a new field to DocProperties, make sure it is taken care (i.e., gets copied from a previous cycle to the current document) in CDocProperties::EndDocument(). | list(String) |
| restricts | DocProperties | NOTE: In segindexer, the docproperties of a document may be reused from a previous cycle if its content is not changed. If you add a new field to DocProperties, make sure it is taken care (i.e., gets copied from a previous cycle to the current document) in CDocProperties::EndDocument(). | list(String) | |
| timestamp | The time CDocProperties::StartDocument() is called, encoded as seconds past the epoch (Jan 1, 1970). This value is always refreshed and not reused. | DocProperties | NOTE: In segindexer, the docproperties of a document may be reused from a previous cycle if its content is not changed. If you add a new field to DocProperties, make sure it is taken care (i.e., gets copied from a previous cycle to the current document) in CDocProperties::EndDocument(). | String |
| title | Extracted from the title tag of the content. This is typically extracted by TitleMetaCollector defined at google3/segindexer/title-meta-collector.h. Please see its documentation for the format and other caveats. | DocProperties | NOTE: In segindexer, the docproperties of a document may be reused from a previous cycle if its content is not changed. If you add a new field to DocProperties, make sure it is taken care (i.e., gets copied from a previous cycle to the current document) in CDocProperties::EndDocument(). | String |
| score | DocPropertiesBadTitleInfo | Bad title information. | number | |
| type | DocPropertiesBadTitleInfo | Bad title information. | String | |
| featureName | DrishtiCompressedFeature | Protocol buffer for storing compressed feature. | String | |
| inRangeBitstream | in_range_bitstream is the string produced by range coder, while out_of_range_bitstream corresponds to the overflow stream, which is used whenever a quantized value is out of range. See https://cs.corp.google.com/piper///depot/google3/research/vision/piedpiper/brain/python/layers/entropy_models.py?l=225&cl=234825412 | DrishtiCompressedFeature | Protocol buffer for storing compressed feature. | String |
| outOfRangeBitstream | DrishtiCompressedFeature | Protocol buffer for storing compressed feature. | String | |
| extra | If extra is present it must be of the same length as value. | DrishtiDenseFeatureData | list(DrishtiFeatureExtra) | |
| generalExtra | DrishtiDenseFeatureData | DrishtiFeatureExtra | ||
| value | Dense data. | DrishtiDenseFeatureData | list(number) | |
| extra | If extra is present it must be of the same length as value. | DrishtiDenseTokenData | Protocol buffer for storing dense token data. | list(DrishtiFeatureExtra) |
| generalExtra | DrishtiDenseTokenData | Protocol buffer for storing dense token data. | DrishtiFeatureExtra | |
| value | DrishtiDenseTokenData | Protocol buffer for storing dense token data. | list(integer) | |
| extra | Extra information for this particular FeatureSetData (example timestamp of this frame in the video). (Almost never used). | DrishtiFeatureSetData | list(DrishtiFeatureExtra) | |
| feature | The following can have multiple FeatureSetElement(s) Each of these FeatureSetElement correspond to the various feature groups. One concrete example is the way these features are generated – example audio, video or OCR. | DrishtiFeatureSetData | list(DrishtiFeatureSetDataFeatureSetElement) | |
| label | Labels for this particular FeatureSetData. (Almost never used). Only interesting when you have (for example) frame level labels. | DrishtiFeatureSetData | list(DrishtiLabelSetElement) | |
| compressed | DrishtiFeatureSetDataFeatureSetElement | A FeatureSetElement stores the features coming from a single group. | DrishtiCompressedFeature | |
| dense | DrishtiFeatureSetDataFeatureSetElement | A FeatureSetElement stores the features coming from a single group. | DrishtiDenseFeatureData | |
| indexed | DrishtiFeatureSetDataFeatureSetElement | A FeatureSetElement stores the features coming from a single group. | DrishtiIndexedFeatureData | |
| name | A name for the feature group: example “AUDIO”, “VIDEO”, “OCR”, etc. | DrishtiFeatureSetDataFeatureSetElement | A FeatureSetElement stores the features coming from a single group. | String |
| quantized | DrishtiFeatureSetDataFeatureSetElement | A FeatureSetElement stores the features coming from a single group. | DrishtiQuantizedDenseFeatureData | |
| quantizedByteDense | DrishtiFeatureSetDataFeatureSetElement | A FeatureSetElement stores the features coming from a single group. | DrishtiQuantizedByteDenseFeatureData | |
| quantizedByteIndexed | DrishtiFeatureSetDataFeatureSetElement | A FeatureSetElement stores the features coming from a single group. | DrishtiQuantizedByteIndexedFeatureData | |
| sparse | DrishtiFeatureSetDataFeatureSetElement | A FeatureSetElement stores the features coming from a single group. | DrishtiSparseFeatureData | |
| token | DrishtiFeatureSetDataFeatureSetElement | A FeatureSetElement stores the features coming from a single group. | DrishtiDenseTokenData | |
| element | FeatureSetData contains the features. In most scenarios, you only have one element. However, multiple elements are appropriate in case of videos where each element may correspond to a frame in the video. | DrishtiFeatureSetDataSequence | This represents a sequence (ordered) of FeatureSetData elements. | list(DrishtiFeatureSetData) |
| extra | Some extra information about this FeatureSetDataSequence. (Almost never used). | DrishtiFeatureSetDataSequence | This represents a sequence (ordered) of FeatureSetData elements. | list(DrishtiFeatureExtra) |
| label | Global (video-level) labels. In most cases, you only have one LabelSetElement. All the labels will be stored in this single LabelSetElement. Scenarios where you may have multiple LabelSetElement(s) is (for example) when you want to differentiate the labels into various sub-groups – eg, central vs relevant, kg-ids vs queries, etc. | DrishtiFeatureSetDataSequence | This represents a sequence (ordered) of FeatureSetData elements. | list(DrishtiLabelSetElement) |
| timestamp | If set, must be same length as element. Each entry is the timestamp in microseconds where the FeatureSetData element was extracted. | DrishtiFeatureSetDataSequence | This represents a sequence (ordered) of FeatureSetData elements. | list(String) |
| extra | If extra is present it must be of the same length as index and value. | DrishtiIndexedFeatureData | list(DrishtiFeatureExtra) | |
| generalExtra | DrishtiIndexedFeatureData | DrishtiFeatureExtra | ||
| index | Indexed data. index and value must be of the same length. | DrishtiIndexedFeatureData | list(String) | |
| value | DrishtiIndexedFeatureData | list(number) | ||
| extra | DrishtiLabelSetData | list(DrishtiFeatureExtra) | ||
| generalExtra | DrishtiLabelSetData | DrishtiFeatureExtra | ||
| targetClass | DrishtiLabelSetData | list(String) | ||
| targetClassName | DrishtiLabelSetData | list(String) | ||
| targetValue | DrishtiLabelSetData | list(number) | ||
| targetWeight | DrishtiLabelSetData | list(number) | ||
| weight | Weight assigned to this set of labels. | DrishtiLabelSetData | number | |
| label | DrishtiLabelSetElement | DrishtiLabelSetData | ||
| name | DrishtiLabelSetElement | String | ||
| extra | If extra is present it must be of the same length as value. | DrishtiQuantizedByteDenseFeatureData | Proto message to store quantized dense feature data. | list(DrishtiFeatureExtra) |
| generalExtra | DrishtiQuantizedByteDenseFeatureData | Proto message to store quantized dense feature data. | DrishtiFeatureExtra | |
| value | Quantized values for the feature. | DrishtiQuantizedByteDenseFeatureData | Proto message to store quantized dense feature data. | String |
| extra | If extra is present it must be of the same length as value. | DrishtiQuantizedByteIndexedFeatureData | Proto message to store quantized indexed feature data. | list(DrishtiFeatureExtra) |
| generalExtra | DrishtiQuantizedByteIndexedFeatureData | Proto message to store quantized indexed feature data. | DrishtiFeatureExtra | |
| index | DrishtiQuantizedByteIndexedFeatureData | Proto message to store quantized indexed feature data. | list(String) | |
| value | Quantized values for the feature. | DrishtiQuantizedByteIndexedFeatureData | Proto message to store quantized indexed feature data. | String |
| extra | If extra is present it must be of the same length as value. | DrishtiQuantizedDenseFeatureData | list(DrishtiFeatureExtra) | |
| generalExtra | DrishtiQuantizedDenseFeatureData | DrishtiFeatureExtra | ||
| value | Quantized Dense data. | DrishtiQuantizedDenseFeatureData | list(String) | |
| extra | If extra is present it must be of the same length as label and value. | DrishtiSparseFeatureData | list(DrishtiFeatureExtra) | |
| generalExtra | DrishtiSparseFeatureData | DrishtiFeatureExtra | ||
| label | Indexed data. label and value must be of the same length. | DrishtiSparseFeatureData | list(String) | |
| value | DrishtiSparseFeatureData | list(number) | ||
| byteSize | Image size in bytes. Meaningful when contents are not stored inline (e.g., via `image_blob_id`). | DrishtiVesperEncodedThumbnail | The attributes of encoded thumbnail images. Next id: 10. | String |
| crc32c | CRC-32 checksum of the image bytes. Can be used for data integrity check. | DrishtiVesperEncodedThumbnail | The attributes of encoded thumbnail images. Next id: 10. | integer |
| encodingQuality | JPEG/WEBP quality factor in range [0,100]. | DrishtiVesperEncodedThumbnail | The attributes of encoded thumbnail images. Next id: 10. | integer |
| encodingType | Image encoding type. | DrishtiVesperEncodedThumbnail | The attributes of encoded thumbnail images. Next id: 10. | String |
| height | DrishtiVesperEncodedThumbnail | The attributes of encoded thumbnail images. Next id: 10. | integer | |
| imageBlobId | The Blob ID of the thumbnail image in the Blobstore. We recommend absolute IDs with universe prefix if this field is passed across systems. The owner of this blob is also responsible for data Wipeout compliance. | DrishtiVesperEncodedThumbnail | The attributes of encoded thumbnail images. Next id: 10. | String |
| imageBytes | Encoded thumbnail bytes. Prefer this over `image_string` as we are not supposed to store image bytes in a proto string field. | DrishtiVesperEncodedThumbnail | The attributes of encoded thumbnail images. Next id: 10. | String |
| imageString | Please migrate to `image_bytes`. | DrishtiVesperEncodedThumbnail | The attributes of encoded thumbnail images. Next id: 10. | String |
| width | Thumbnail resolution. | DrishtiVesperEncodedThumbnail | The attributes of encoded thumbnail images. Next id: 10. | integer |
| beginTimestampMs | The begin timestamp in milliseconds. | DrishtiVesperMovingThumbnail | LINT: LEGACY_NAMES MovingThumbnail is defined as a short video clip that represents the whole video content. Next id: 17. | integer |
| durationMs | The duration of the moving thumbnail in milliseconds. Note that the duration may not be the difference between begin_timestamp_ms and end_timestamp_ms, esp when the moving thumbnail covers multiple clips from the video. | DrishtiVesperMovingThumbnail | LINT: LEGACY_NAMES MovingThumbnail is defined as a short video clip that represents the whole video content. Next id: 17. | integer |
| encodedGifAnimation | DrishtiVesperMovingThumbnail | LINT: LEGACY_NAMES MovingThumbnail is defined as a short video clip that represents the whole video content. Next id: 17. | String | |
| encodedVideoString | The encoded video string. | DrishtiVesperMovingThumbnail | LINT: LEGACY_NAMES MovingThumbnail is defined as a short video clip that represents the whole video content. Next id: 17. | String |
| encodedWebpAnimation | The encoded WebP animation. | DrishtiVesperMovingThumbnail | LINT: LEGACY_NAMES MovingThumbnail is defined as a short video clip that represents the whole video content. Next id: 17. | String |
| endTimestampMs | The end timestamp in milliseconds. | DrishtiVesperMovingThumbnail | LINT: LEGACY_NAMES MovingThumbnail is defined as a short video clip that represents the whole video content. Next id: 17. | integer |
| height | Pixel height of the moving thumbnail. | DrishtiVesperMovingThumbnail | LINT: LEGACY_NAMES MovingThumbnail is defined as a short video clip that represents the whole video content. Next id: 17. | integer |
| id | MovingThumbnail id (e.g., the video id). | DrishtiVesperMovingThumbnail | LINT: LEGACY_NAMES MovingThumbnail is defined as a short video clip that represents the whole video content. Next id: 17. | String |
| movingThumbnailerVersion | If set, this is the algorithm version used to generate this moving thumbnail. | DrishtiVesperMovingThumbnail | LINT: LEGACY_NAMES MovingThumbnail is defined as a short video clip that represents the whole video content. Next id: 17. | String |
| name | MovingThumbnail name. | DrishtiVesperMovingThumbnail | LINT: LEGACY_NAMES MovingThumbnail is defined as a short video clip that represents the whole video content. Next id: 17. | String |
| score | The score of the moving thumbnail. | DrishtiVesperMovingThumbnail | LINT: LEGACY_NAMES MovingThumbnail is defined as a short video clip that represents the whole video content. Next id: 17. | number |
| scoreComponents | DrishtiVesperMovingThumbnail | LINT: LEGACY_NAMES MovingThumbnail is defined as a short video clip that represents the whole video content. Next id: 17. | DrishtiVesperMovingThumbnailScoreComponents | |
| thumbnails | A set of single frame thumbnails in the MovingThumbnail. | DrishtiVesperMovingThumbnail | LINT: LEGACY_NAMES MovingThumbnail is defined as a short video clip that represents the whole video content. Next id: 17. | list(DrishtiVesperThumbnail) |
| type | MovingThumbnail type. | DrishtiVesperMovingThumbnail | LINT: LEGACY_NAMES MovingThumbnail is defined as a short video clip that represents the whole video content. Next id: 17. | String |
| webpQualityLevel | The actual quality of the Webp animation. Note this value may not be equal to the quality value requested in the animation creator’s options. This is because other requirements, such as the max file size, may force the creator to lower the actual quality value. | DrishtiVesperMovingThumbnail | LINT: LEGACY_NAMES MovingThumbnail is defined as a short video clip that represents the whole video content. Next id: 17. | number |
| width | Pixel width of the moving thumbnail. | DrishtiVesperMovingThumbnail | LINT: LEGACY_NAMES MovingThumbnail is defined as a short video clip that represents the whole video content. Next id: 17. | integer |
| audienceRewindRatioScore | DrishtiVesperMovingThumbnailScoreComponents | Sum of individual score components within a moving thumbnail. Used as input for weight fitting. | number | |
| iconicFaceScore | DrishtiVesperMovingThumbnailScoreComponents | Sum of individual score components within a moving thumbnail. Used as input for weight fitting. | number | |
| matchingScore | DrishtiVesperMovingThumbnailScoreComponents | Sum of individual score components within a moving thumbnail. Used as input for weight fitting. | number | |
| motionScore | DrishtiVesperMovingThumbnailScoreComponents | Sum of individual score components within a moving thumbnail. Used as input for weight fitting. | number | |
| titleMatchingScore | DrishtiVesperMovingThumbnailScoreComponents | Sum of individual score components within a moving thumbnail. Used as input for weight fitting. | number | |
| videoThumbQualityScore | DrishtiVesperMovingThumbnailScoreComponents | Sum of individual score components within a moving thumbnail. Used as input for weight fitting. | number | |
| denseFeatures | Thumbnail dense features | DrishtiVesperThumbnail | The attributes of a video thumbnail. | list(number) |
| encodedImageString | Thumbnail image as an encoded image. Deprecated, use encoded_thumbnails instead. | DrishtiVesperThumbnail | The attributes of a video thumbnail. | String |
| encodedImageStringSmall | Thumbnail image as an encoded image with smaller resolution. Deprecated, use encoded_thumbnails instead. | DrishtiVesperThumbnail | The attributes of a video thumbnail. | String |
| encodedThumbnails | Encoded thumbnail images. | DrishtiVesperThumbnail | The attributes of a video thumbnail. | list(DrishtiVesperEncodedThumbnail) |
| id | Thumbnail id. | DrishtiVesperThumbnail | The attributes of a video thumbnail. | String |
| ocrText | Text in video thumbnails that was detected by OCR. | DrishtiVesperThumbnail | The attributes of a video thumbnail. | String |
| qualityScores | Thumbnail quality scores. | DrishtiVesperThumbnail | The attributes of a video thumbnail. | list(DrishtiVesperThumbnailQualityScore) |
| shouldUpdateDefaultThumbnail | If true, this thumbnail should update default thumbnail. | DrishtiVesperThumbnail | The attributes of a video thumbnail. | boolean |
| thumbnailerModelVersion | Thumbnailer Version. | DrishtiVesperThumbnail | The attributes of a video thumbnail. | String |
| timestampMs | Thumbnail timestamp in milliseconds. | DrishtiVesperThumbnail | The attributes of a video thumbnail. | integer |
| type | Thumbnail type. | DrishtiVesperThumbnail | The attributes of a video thumbnail. | String |
| userReportedThumbnail | DrishtiVesperThumbnail | The attributes of a video thumbnail. | DrishtiVesperUserReportUserReportedThumbnail | |
| userReportedThumbnails | All user reported thumbnails of interest. | DrishtiVesperThumbnail | The attributes of a video thumbnail. | list(DrishtiVesperUserReportUserReportedThumbnail) |
| version | Thumbnail version, i.e., the unix time in seconds when the thumbnail was created. | DrishtiVesperThumbnail | The attributes of a video thumbnail. | integer |
| score | DrishtiVesperThumbnailQualityScore | number | ||
| type | DrishtiVesperThumbnailQualityScore | String | ||
| racyLevel | DrishtiVesperUserReportHumanLabel | Proto holding values for details about human labels. | String | |
| modelName | DrishtiVesperUserReportModelScore | Proto holding values for details about score and the source model. | String | |
| score | DrishtiVesperUserReportModelScore | Proto holding values for details about score and the source model. | number | |
| denseFeatures | DrishtiVesperUserReportUserReportedThumbnail | Proto holding values for user reported thumbnails. Next id: 12 | list(number) | |
| duration | Number of days in which volume is calculated. | DrishtiVesperUserReportUserReportedThumbnail | Proto holding values for user reported thumbnails. Next id: 12 | integer |
| humanLabel | DrishtiVesperUserReportUserReportedThumbnail | Proto holding values for user reported thumbnails. Next id: 12 | DrishtiVesperUserReportHumanLabel | |
| impressions | Daily aggregared impressions for the reported video. | DrishtiVesperUserReportUserReportedThumbnail | Proto holding values for user reported thumbnails. Next id: 12 | integer |
| needHumanLabel | Whether the thumbnail needs a human label. | DrishtiVesperUserReportUserReportedThumbnail | Proto holding values for user reported thumbnails. Next id: 12 | boolean |
| rawHumanLabels | DrishtiVesperUserReportUserReportedThumbnail | Proto holding values for user reported thumbnails. Next id: 12 | list(DrishtiVesperUserReportHumanLabel) | |
| reportScore | DrishtiVesperUserReportUserReportedThumbnail | Proto holding values for user reported thumbnails. Next id: 12 | DrishtiVesperUserReportModelScore | |
| reportType | DrishtiVesperUserReportUserReportedThumbnail | Proto holding values for user reported thumbnails. Next id: 12 | String | |
| score | DrishtiVesperUserReportUserReportedThumbnail | Proto holding values for user reported thumbnails. Next id: 12 | DrishtiVesperUserReportModelScore | |
| useCase | DrishtiVesperUserReportUserReportedThumbnail | Proto holding values for user reported thumbnails. Next id: 12 | String | |
| volume | Number of reports. | DrishtiVesperUserReportUserReportedThumbnail | Proto holding values for user reported thumbnails. Next id: 12 | integer |
| id | Video id. | DrishtiVesperVideoThumbnail | Video level container for thumbnail with its attributes, e.g., timestamp, id, quality scores, annotations, or features. | String |
| movingThumbnails | DrishtiVesperVideoThumbnail | Video level container for thumbnail with its attributes, e.g., timestamp, id, quality scores, annotations, or features. | list(DrishtiVesperMovingThumbnail) | |
| thumbnails | DrishtiVesperVideoThumbnail | Video level container for thumbnail with its attributes, e.g., timestamp, id, quality scores, annotations, or features. | list(DrishtiVesperThumbnail) | |
| appId | Application ID (or project ID) from Google API Console. | EmbedsDeepLinkData | Deep-linking data is used to construct a deep-link URI for an activity or frame’s embed, such that on click, the user is taken to the right place in a mobile app. If the app is not installed, the user is taken to the app store. If not on mobile, an analogous web uri is used. | String |
| client | The data for a Google API Console client is entered by a developer during client registration and is stored in PackagingService. | EmbedsDeepLinkData | Deep-linking data is used to construct a deep-link URI for an activity or frame’s embed, such that on click, the user is taken to the right place in a mobile app. If the app is not installed, the user is taken to the app store. If not on mobile, an analogous web uri is used. | list(EmbedsPackagingServiceClient) |
| deepLinkId | The ID for non-URL content. Embeds may either have no analogous web presence or prefer a native mobile experience if supported. In the case of no web presence, instead of setting the “url” field of an embed, such developers will set this field and other content fields, e.g. thumbnail, title, description. If set, this field is used to construct the deep-link URI. Note that the native experience is preferred over the web link and the web link is used as a fallback. | EmbedsDeepLinkData | Deep-linking data is used to construct a deep-link URI for an activity or frame’s embed, such that on click, the user is taken to the right place in a mobile app. If the app is not installed, the user is taken to the app store. If not on mobile, an analogous web uri is used. | String |
| url | Analogous web presence. Used as desktop fallback or when no native link data is present. | EmbedsDeepLinkData | Deep-linking data is used to construct a deep-link URI for an activity or frame’s embed, such that on click, the user is taken to the right place in a mobile app. If the app is not installed, the user is taken to the app store. If not on mobile, an analogous web uri is used. | String |
| canonicalId | The canonical ID of the embed. If absent, the canonical ID is equal to the ID; if present, then the canonical ID represents an “equivalence class” of embeds which really refer to the same object. (For example, the URLs http://www.foo.com/ and http://foo.com/ refer to the same object) This field may be updated periodically by background processes. | EmbedsEmbedClientItem | Represents an embedded object in an update. This is a wrapper class that can contain a single specific item proto in an extension field. Think of it as a base class like `Message` in Java. Each item proto must declare that it extends this proto: message ExampleObject { option (item_type) = EXAMPLE_OBJECT; extend EmbedClientItem { optional ExampleObject example_object = ; } } See go/es-embeds for details. | String |
| deepLinkData | Deep-linking data to take the user to the right place in a mobile app. This is only used for preview and attribution. Links that are specific to a given embed type should live on that specific embed’s proto by using Link. See http://goto.google.com/mariana-design. | EmbedsEmbedClientItem | Represents an embedded object in an update. This is a wrapper class that can contain a single specific item proto in an extension field. Think of it as a base class like `Message` in Java. Each item proto must declare that it extends this proto: message ExampleObject { option (item_type) = EXAMPLE_OBJECT; extend EmbedClientItem { optional ExampleObject example_object = ; } } See go/es-embeds for details. | EmbedsDeepLinkData |
| id | The ID of the embed. This corresponds to the schema.org ID, as represented in the ItemScope.id field. | EmbedsEmbedClientItem | Represents an embedded object in an update. This is a wrapper class that can contain a single specific item proto in an extension field. Think of it as a base class like `Message` in Java. Each item proto must declare that it extends this proto: message ExampleObject { option (item_type) = EXAMPLE_OBJECT; extend EmbedClientItem { optional ExampleObject example_object = ; } } See go/es-embeds for details. | String |
| provenance | The provenance of the embed, populated when the embed originated from a web fetch. The provenance captures information about the web page the embed had originated, like the URL that was retrieved and the retrieved URL’s canonical form. This is useful in the case where the URL shared by the URL redirects (e.g., in the case of a shortened URL). | EmbedsEmbedClientItem | Represents an embedded object in an update. This is a wrapper class that can contain a single specific item proto in an extension field. Think of it as a base class like `Message` in Java. Each item proto must declare that it extends this proto: message ExampleObject { option (item_type) = EXAMPLE_OBJECT; extend EmbedClientItem { optional ExampleObject example_object = ; } } See go/es-embeds for details. | EmbedsProvenance |
| renderId | The ID used to identify the embed during rendering. This field will match ID, if set, otherwise it will be the ID of the parent activity. This field is only populated on the server for client use and is not persisted to storage. | EmbedsEmbedClientItem | Represents an embedded object in an update. This is a wrapper class that can contain a single specific item proto in an extension field. Think of it as a base class like `Message` in Java. Each item proto must declare that it extends this proto: message ExampleObject { option (item_type) = EXAMPLE_OBJECT; extend EmbedClientItem { optional ExampleObject example_object = ; } } See go/es-embeds for details. | String |
| signature | Signature of the embed, used for verification. | EmbedsEmbedClientItem | Represents an embedded object in an update. This is a wrapper class that can contain a single specific item proto in an extension field. Think of it as a base class like `Message` in Java. Each item proto must declare that it extends this proto: message ExampleObject { option (item_type) = EXAMPLE_OBJECT; extend EmbedClientItem { optional ExampleObject example_object = ; } } See go/es-embeds for details. | String |
| transientData | Transient generic data that will not be saved on the server. | EmbedsEmbedClientItem | Represents an embedded object in an update. This is a wrapper class that can contain a single specific item proto in an extension field. Think of it as a base class like `Message` in Java. Each item proto must declare that it extends this proto: message ExampleObject { option (item_type) = EXAMPLE_OBJECT; extend EmbedClientItem { optional ExampleObject example_object = ; } } See go/es-embeds for details. | EmbedsTransientData |
| type | The first value in `type` determines which extension field will be set. When creating an EmbedClientItem, you only need to set the first (primary) type in this field. When the server receives the item, it will populate the full type list using the parent annotations in the ItemType enum. | EmbedsEmbedClientItem | Represents an embedded object in an update. This is a wrapper class that can contain a single specific item proto in an extension field. Think of it as a base class like `Message` in Java. Each item proto must declare that it extends this proto: message ExampleObject { option (item_type) = EXAMPLE_OBJECT; extend EmbedClientItem { optional ExampleObject example_object = ; } } See go/es-embeds for details. | list(String) |
| androidPackageName | Android app’s package name to generate the deep-link URI. | EmbedsPackagingServiceClient | Developers register a client in Google API Console to get the deep-linking feature on Google+ posts or frames about their apps. The client data is stored in this proto. | String |
| iosAppStoreId | iOS app’s App Store ID to generate the App Store URL when app is not installed on device. | EmbedsPackagingServiceClient | Developers register a client in Google API Console to get the deep-linking feature on Google+ posts or frames about their apps. The client data is stored in this proto. | String |
| iosBundleId | iOS app’s bundle ID to generate the deep-link URI. | EmbedsPackagingServiceClient | Developers register a client in Google API Console to get the deep-linking feature on Google+ posts or frames about their apps. The client data is stored in this proto. | String |
| type | Type of Google API Console client. | EmbedsPackagingServiceClient | Developers register a client in Google API Console to get the deep-linking feature on Google+ posts or frames about their apps. The client data is stored in this proto. | String |
| annotationBlob | Annotation blob from Annotation Service. | EmbedsProvenance | This field records where the ItemScope was retrieved, if it was created via a web fetch. | String |
| canonicalUrl | Canonical url of the retrieved_url, if one was resolved during retrieval, for example, if a rel=”canonical” link tag was provided in the retrieved web page. | EmbedsProvenance | This field records where the ItemScope was retrieved, if it was created via a web fetch. | String |
| inputUrl | The url originally passed in the PRS request, which should be used to re-discover the content. Note that this URL may be a forwarding service or link shortener (bit.ly), so it should not be assumed to be canonical, but should be used for navigation back to the original source of the itemscope. | EmbedsProvenance | This field records where the ItemScope was retrieved, if it was created via a web fetch. | String |
| itemtype | Contains exact types as parsed, whether or not we recognized that type at parse time. If an itemscope is created by merging SchemaOrg markup and open graph markup then the first itemtype would be schemaorg type, the second would be open graph and so on. example: http://schema.org/VideoObject, og:video.movie Plain text; usually a URL | EmbedsProvenance | This field records where the ItemScope was retrieved, if it was created via a web fetch. | list(String) |
| retrievedTimestampMsec | The server retrieved timestamp (in msec). | EmbedsProvenance | This field records where the ItemScope was retrieved, if it was created via a web fetch. | String |
| retrievedUrl | The final URL that was the actual source of the itemscope, after any redirects. | EmbedsProvenance | This field records where the ItemScope was retrieved, if it was created via a web fetch. | String |
| processId | process_id is an integer that identifies the process on this machine that generated this event. This id is calculated once when the server generates its first event, and may change if the process is migrated to a different host. This field has a very specific format mandated by the logs collection infrastructure, which is subject to change WITHOUT NOTICE. As of 2013-01-09, this format is: uint32 process_id = (time(NULL) << 24) + (getpid() & 0xFFFFFF); If you are generating an extended_pid directly, you MUST use one of the maintained library implementations in order to generate it properly: C++ //borg/borgletlib:extended_pid; call borg::ExtendedPid() Python //borg/borgletlib/python:pyextendedpid; call ExtendedPid() Go //borg/borgletlib/go:extendedpid; call Get() Java //java/com/google/common/logging; call EventId.getPid() If you think that you need to parse the values of this field, please contact logs-collection-dev@ to discuss your requirement. | EventIdMessage | An EventId is a 128 bit identifier that uniquely identifies an event, such as a query. The event time recorded to the nearest microsecond, along with information about the process generating the event, ensures that all EventIds are unique. Details of this EventId are described in a design document: http://www/eng/designdocs/sawmill/adlogs.html | integer |
| serverIp | server_ip is the IPv4 address or http://go/ghostid of the machine running the server that created this event message. This allows us to distinguish between events that occur at the same time on different servers. Format: 10.1.2.3 is stored as 0x0a010203, and GHostId 1 as 0x00000001. | EventIdMessage | An EventId is a 128 bit identifier that uniquely identifies an event, such as a query. The event time recorded to the nearest microsecond, along with information about the process generating the event, ensures that all EventIds are unique. Details of this EventId are described in a design document: http://www/eng/designdocs/sawmill/adlogs.html | integer |
| timeUsec | time_usec is the number of microseconds since the epoch (i.e., since 1970-01-01 00:00:00 UTC) as an int64: 1e6 * (unix time) + microseconds. Applications must ensure that EventIdMessages have increasing times, artificially increasing time_usec to one greater than the previous value if necessary. Alternate implementations were considered: 1. storing unix time and microseconds separately would require a bit more storage, and the convenience of having a single value representing the time seemed more useful than having trivial access to a unix time. 2. storing unix time in the upper 32 bits would allow for more precision – up to 4G events/second, but it wouldn’t print nicely as a decimal value and it seems unlikely that any single server would ever sustain more than 1M events/second. 3. Java-compatible time uses millis – this would limit servers to 1000 events per second – too small. Other names for this field were considered, including time, time_stamp, and utime. We felt that including the units in the name would tend to produce more readable code. utime might be interpreted as user time. unix timestamp * 1e6 + microseconds | EventIdMessage | An EventId is a 128 bit identifier that uniquely identifies an event, such as a query. The event time recorded to the nearest microsecond, along with information about the process generating the event, ensures that all EventIds are unique. Details of this EventId are described in a design document: http://www/eng/designdocs/sawmill/adlogs.html | String |
| matchinfo | ExtraSnippetInfoResponse | the extra info response from ascorer used to build snippets in GWS experiments | ExtraSnippetInfoResponseMatchInfo | |
| querysubitem | ExtraSnippetInfoResponse | the extra info response from ascorer used to build snippets in GWS experiments | list(ExtraSnippetInfoResponseQuerySubitem) | |
| tidbit | ExtraSnippetInfoResponse | the extra info response from ascorer used to build snippets in GWS experiments | list(ExtraSnippetInfoResponseTidbit) | |
| titleMatches | bitvector of query items matching the title | ExtraSnippetInfoResponseMatchInfo | String | |
| urlMatches | bitvector of query items matching the url | ExtraSnippetInfoResponseMatchInfo | String | |
| weightedItems | bitvector of query items considered by chooser | ExtraSnippetInfoResponseMatchInfo | String | |
| isHighlighted | Additional information from the SnippetQuery. | ExtraSnippetInfoResponseQuerySubitem | A query term, phrase, or synonym. An original query term or phrase is called an “item”. Each item may have more than one “subitem” if there are synonyms. In rare cases a subitem may correspond to multiple items, such as the subitem “cia” in the query [central intelligence agency]. | boolean |
| isOptional | ExtraSnippetInfoResponseQuerySubitem | A query term, phrase, or synonym. An original query term or phrase is called an “item”. Each item may have more than one “subitem” if there are synonyms. In rare cases a subitem may correspond to multiple items, such as the subitem “cia” in the query [central intelligence agency]. | boolean | |
| isOriginal | true iff this subitem was an original query term or phrase. Can only be false if want_all_query_subitems == true in the request. | ExtraSnippetInfoResponseQuerySubitem | A query term, phrase, or synonym. An original query term or phrase is called an “item”. Each item may have more than one “subitem” if there are synonyms. In rare cases a subitem may correspond to multiple items, such as the subitem “cia” in the query [central intelligence agency]. | boolean |
| items | a bitvector of the query items corresponding to this subitem. Typically only one bit is set, but see comment above. | ExtraSnippetInfoResponseQuerySubitem | A query term, phrase, or synonym. An original query term or phrase is called an “item”. Each item may have more than one “subitem” if there are synonyms. In rare cases a subitem may correspond to multiple items, such as the subitem “cia” in the query [central intelligence agency]. | integer |
| text | text associated with this query item | ExtraSnippetInfoResponseQuerySubitem | A query term, phrase, or synonym. An original query term or phrase is called an “item”. Each item may have more than one “subitem” if there are synonyms. In rare cases a subitem may correspond to multiple items, such as the subitem “cia” in the query [central intelligence agency]. | String |
| weight | the weight of this query item, as calculated by SubitemWeight(): https://qwiki.corp.google.com/display/Q/SnippetWeights | ExtraSnippetInfoResponseQuerySubitem | A query term, phrase, or synonym. An original query term or phrase is called an “item”. Each item may have more than one “subitem” if there are synonyms. In rare cases a subitem may correspond to multiple items, such as the subitem “cia” in the query [central intelligence agency]. | integer |
| anchorinfo | ExtraSnippetInfoResponseTidbit | ExtraSnippetInfoResponseTidbitAnchorInfo | ||
| begin | For tidbits only: position of tidbit in the document. More specifically, tidbit is found at [begin, end) in the document’s tokens. | ExtraSnippetInfoResponseTidbit | integer | |
| end | ExtraSnippetInfoResponseTidbit | integer | ||
| items | a bitvector of each query term within this tidbit | ExtraSnippetInfoResponseTidbit | String | |
| score | the score for this tidbit if there was one this is returned for Snippets and Tidbits and is only meaningful for comparing between objects of the same type (snippet to snippet, tidbit to tidbit) | ExtraSnippetInfoResponseTidbit | number | |
| text | the tidbit text, with search terms already highlighted | ExtraSnippetInfoResponseTidbit | String | |
| type | ExtraSnippetInfoResponseTidbit | String | ||
| offdomainCount | ExtraSnippetInfoResponseTidbitAnchorInfo | this information is specific to anchors and is only returned if type == ANCHOR | integer | |
| ondomainCount | ExtraSnippetInfoResponseTidbitAnchorInfo | this information is specific to anchors and is only returned if type == ANCHOR | integer | |
| mustangBytes | Always use image/search/utils/face_proto_util.h for packing and unpacking these values. | FaceIndexing | String | |
| mustangBytesVersion | FaceIndexing | integer | ||
| binaryClassifier | Either binary_classifier will be set, using the enum above, or binary_classifier_name will be set, if it is not one of the classifiers in the enum – never both. | FatcatCompactBinaryClassification | String | |
| binaryClassifierName | FatcatCompactBinaryClassification | String | ||
| discreteFraction | A CompactDocClassification will not usually have a weight. For a CompactSiteClassification, this value will be 0…127 corresponding to 0.0…1.0, indicating fraction of the site that this label applies to | FatcatCompactBinaryClassification | integer | |
| binary | FatcatCompactDocClassification | The result of PetacatAnnotator. Each result contains: 1. RephilClusters; 2. At most 5 verticals from each taxonomy, sorted by the probabilities in descending order. 3. Binary classification results about page types and sensitive content. The types of taxonomies include: verticals4, geo, verticals4_geo, products_services, icm_im_audiences and icm_im_audiences_dev. | list(FatcatCompactBinaryClassification) | |
| clusters | FatcatCompactDocClassification | The result of PetacatAnnotator. Each result contains: 1. RephilClusters; 2. At most 5 verticals from each taxonomy, sorted by the probabilities in descending order. 3. Binary classification results about page types and sensitive content. The types of taxonomies include: verticals4, geo, verticals4_geo, products_services, icm_im_audiences and icm_im_audiences_dev. | FatcatCompactRephilClusters | |
| epoch | FatcatCompactDocClassification | The result of PetacatAnnotator. Each result contains: 1. RephilClusters; 2. At most 5 verticals from each taxonomy, sorted by the probabilities in descending order. 3. Binary classification results about page types and sensitive content. The types of taxonomies include: verticals4, geo, verticals4_geo, products_services, icm_im_audiences and icm_im_audiences_dev. | String | |
| langCode | FatcatCompactDocClassification | The result of PetacatAnnotator. Each result contains: 1. RephilClusters; 2. At most 5 verticals from each taxonomy, sorted by the probabilities in descending order. 3. Binary classification results about page types and sensitive content. The types of taxonomies include: verticals4, geo, verticals4_geo, products_services, icm_im_audiences and icm_im_audiences_dev. | String | |
| rephilModelId | The id of the Rephil model used to generate the Rephil clusters. If it is absent, Rephil 4 is assumed. | FatcatCompactDocClassification | The result of PetacatAnnotator. Each result contains: 1. RephilClusters; 2. At most 5 verticals from each taxonomy, sorted by the probabilities in descending order. 3. Binary classification results about page types and sensitive content. The types of taxonomies include: verticals4, geo, verticals4_geo, products_services, icm_im_audiences and icm_im_audiences_dev. | integer |
| taxonomic | FatcatCompactDocClassification | The result of PetacatAnnotator. Each result contains: 1. RephilClusters; 2. At most 5 verticals from each taxonomy, sorted by the probabilities in descending order. 3. Binary classification results about page types and sensitive content. The types of taxonomies include: verticals4, geo, verticals4_geo, products_services, icm_im_audiences and icm_im_audiences_dev. | list(FatcatCompactTaxonomicClassification) | |
| url | not needed if the url is the sstable / bigtable key used during intermediate processing only | FatcatCompactDocClassification | The result of PetacatAnnotator. Each result contains: 1. RephilClusters; 2. At most 5 verticals from each taxonomy, sorted by the probabilities in descending order. 3. Binary classification results about page types and sensitive content. The types of taxonomies include: verticals4, geo, verticals4_geo, products_services, icm_im_audiences and icm_im_audiences_dev. | String |
| weight | The relative weight of this doc within a site, typically something like pagerank or navboost impressions. May be a large number (like an actual pageviews estimate), not limited to a small range. | FatcatCompactDocClassification | The result of PetacatAnnotator. Each result contains: 1. RephilClusters; 2. At most 5 verticals from each taxonomy, sorted by the probabilities in descending order. 3. Binary classification results about page types and sensitive content. The types of taxonomies include: verticals4, geo, verticals4_geo, products_services, icm_im_audiences and icm_im_audiences_dev. | String |
| cluster | FatcatCompactRephilClusters | list(FatcatCompactRephilClustersCluster) | ||
| discreteWeight | 0…127 corresponds to 0.0 – 1.0 | FatcatCompactRephilClustersCluster | integer | |
| id | FatcatCompactRephilClustersCluster | integer | ||
| category | FatcatCompactTaxonomicClassification | A version of this proto for logging is available at cs/symbol:logged_fatcat.LoggedCompactTaxonomicClassification | list(FatcatCompactTaxonomicClassificationCategory) | |
| classifierVersion | FatcatCompactTaxonomicClassification | A version of this proto for logging is available at cs/symbol:logged_fatcat.LoggedCompactTaxonomicClassification | String | |
| taxonomy | Either taxonomy will be set, using the enum above, or taxonomy_name will be set (if the taxonomy is not one of the ones in the enum) – never both | FatcatCompactTaxonomicClassification | A version of this proto for logging is available at cs/symbol:logged_fatcat.LoggedCompactTaxonomicClassification | String |
| taxonomyName | FatcatCompactTaxonomicClassification | A version of this proto for logging is available at cs/symbol:logged_fatcat.LoggedCompactTaxonomicClassification | String | |
| discreteWeight | go/petacat-faq#how-should-i-interpret-classification-weights Discrete to reduce size. Range is [0,127], corresponding to [0.0,1.0]. | FatcatCompactTaxonomicClassificationCategory | A taxonomic category. A classification consists of weight (totalling 1.0) distributed among one or more categories. | integer |
| id | The category’s ID, e.g. 20 for /Sports in the go/verticals4 taxonomy. | FatcatCompactTaxonomicClassificationCategory | A taxonomic category. A classification consists of weight (totalling 1.0) distributed among one or more categories. | integer |
| type | FocusBackendContactDetailHash | http://go/contact-detail-hash. | String | |
| value | The hash here will be a 16-bit weak hash to avoid reverse engineering for decoding the actual contact detail. The hash value is computed by the fingerprint of the raw contact detail mod 2^16. | FocusBackendContactDetailHash | http://go/contact-detail-hash. | integer |
| annotationId | The annotation ID. Annotations are only allowed to point to annotations that do not themselves have a pointer (avoids any possibilty of loops). Cast this field to string in javascript to make it compile in js. | FocusBackendContactPointer | A contact pointer that represents a contact (http://go/assistant-contact-id). | String |
| deviceRawContactId | The raw contact ID from an active mobile device of the user. | FocusBackendContactPointer | A contact pointer that represents a contact (http://go/assistant-contact-id). | FocusBackendDeviceRawContactId |
| focusContactId | The contact ID from the Focus backend. Cast this field to string in javascript to make it compile in js. | FocusBackendContactPointer | A contact pointer that represents a contact (http://go/assistant-contact-id). | String |
| otherContactId | Additional contact ids that are not actively used to match contact pointers to contacts. | FocusBackendContactPointer | A contact pointer that represents a contact (http://go/assistant-contact-id). | FocusBackendOtherContactId |
| secondaryId | The secondary identifier of contact. It will be used when the primary ID doesn’t match any contact. | FocusBackendContactPointer | A contact pointer that represents a contact (http://go/assistant-contact-id). | FocusBackendSecondaryContactId |
| ContactId | DeviceContact Id. | FocusBackendDeviceContactId | //////////////////// DeviceContactId ////////////////////// Used by Device Contacts only. For more details see go/fbs-support-for-device-contacts. | String |
| DeviceId | Device Id. | FocusBackendDeviceContactId | //////////////////// DeviceContactId ////////////////////// Used by Device Contacts only. For more details see go/fbs-support-for-device-contacts. | FocusBackendDeviceId |
| AndroidDeviceId | The GServices id on Android. See go/android-id. | FocusBackendDeviceId | //////////////////// DeviceId ////////////////////// Used by Device Contacts only. For more details see go/fbs-support-for-device-contacts. | String |
| Hash | DeviceId.Hash is a SHA256 of some attribute of the user and device. For Android devices: Hash = SHA256(gaia_account_name + “:” + “1” + “:” + (android id – LSB)); For iOS devices: Hash = TOLOWER(HEX(GMCSComputeUserDeviceToken(userId, iOsDeviceId)) For more details see go/client-instance-id. | FocusBackendDeviceId | //////////////////// DeviceId ////////////////////// Used by Device Contacts only. For more details see go/fbs-support-for-device-contacts. | String |
| DeviceId | FocusBackendDeviceRawContactId | //////////////////// DeviceRawContactId ////////////////////// Used by Device Contacts Only. The Raw ID as assigned to the original contact on the device. For more details see go/fbs-support-for-device-contacts. | FocusBackendDeviceId | |
| RawContactId | Raw ID assigned by the device. Cast this field to string in javascript to make it compile in js. | FocusBackendDeviceRawContactId | //////////////////// DeviceRawContactId ////////////////////// Used by Device Contacts Only. The Raw ID as assigned to the original contact on the device. For more details see go/fbs-support-for-device-contacts. | String |
| deviceContactId | Device contact ID, when available: – The annotation points to a device contact, and the device contact id was correctly populated when the annotation was created. Note that the device contact id is populated once per device contact on a device. It is distinct from RawContactId – a single device contact may have multiple raw contact ids. – The annotation points to a Focus contact that was merged with device contact information in Starlight. When the annotation was created, a device contact id was available on the merged person object. – The contact annotation was created from April 2021 onwards. All prior annotations do not populate this field. ContactPointer creation relies on the client caller to correctly populate the device contact id, and does not enforce any assumptions on availability of this field. This field is repeated because in rare cases Starlight may merge device contact information across different devices into a single merged person object. WARNING: Use with extreme caution! This ID is not stable. For more details see go/fbs-support-for-device-contacts. | FocusBackendOtherContactId | Additional contact ids that are not actively used to match contact pointers to contacts. There may be overlap with primary or secondary contact ids. | list(FocusBackendDeviceContactId) |
| contactDetailHash | The hashes of the contact details (e.g. phone number and email address). | FocusBackendSecondaryContactId | The secondary ID of a contact. | list(FocusBackendContactDetailHash) |
| contactName | The contact’s full name, not hashed. | FocusBackendSecondaryContactId | The secondary ID of a contact. | String |
| contactNameHash | The hash of contact’s full name, generated using Fingerprint2011(). Cast this field to string in javascript to make it compile in js. | FocusBackendSecondaryContactId | The secondary ID of a contact. | String |
| dataset | Mid of the dataset. | FreebaseCitation | Citation contains the information needed to correctly attribute the source of data. | String |
| isAttributionRequired | If set to true, the citation is required to be displayed when the data is used. | FreebaseCitation | Citation contains the information needed to correctly attribute the source of data. | boolean |
| project | Name of the project of the data’s origin. | FreebaseCitation | Citation contains the information needed to correctly attribute the source of data. | String |
| provider | The name of the provider of this information. | FreebaseCitation | Citation contains the information needed to correctly attribute the source of data. | String |
| statement | A human readable statement of attribution. | FreebaseCitation | Citation contains the information needed to correctly attribute the source of data. | String |
| uri | Uri link associated with this data. | FreebaseCitation | Citation contains the information needed to correctly attribute the source of data. | String |
| id | “id” may be a human readable ID (HRID) or a MID. Originally it was intended to always be a human readable ID, but that convention was not always followed so clients should be wary. Not every topic has an id. | FreebaseId | An Id contains the identifiers used to reference this topic (entity) in the Knowledge Graph. The Knowledge Graph supports several forms of identifiers: – “mids” (machine ids) that are assigned at creation time, and support a resolution mechanism that tracks topics after they are merged (for more about mids, see go/kg-mid), – “ids” are human-readable ids (HRIDs) that are derived from a namespace hierarchy stored in Knowledge Graph, and a set of rules, – “guids” are low-level ids historically used in Freebase (pre-Knowledge Graph, deprecated). Only the mid and id are supplied here. Note that mids can be converted to guids or uint64s (see //metaweb/util/mid/mid.h). | String |
| mid | The “mid” should be used whenever a globally unique, primary key into the Knowledge Graph is needed. These keys are always prefixed with the “/m” and “/g”, (and more rarely the “/x” and “/t”) namespaces, and are alphanumeric strings consisting of lowercase letters excluding vowels, numbers and the underscore character. (Applications should not assume a constant length for these strings as Livegraph reserves the right to extend the number of characters to accommodate more topics.) | FreebaseId | An Id contains the identifiers used to reference this topic (entity) in the Knowledge Graph. The Knowledge Graph supports several forms of identifiers: – “mids” (machine ids) that are assigned at creation time, and support a resolution mechanism that tracks topics after they are merged (for more about mids, see go/kg-mid), – “ids” are human-readable ids (HRIDs) that are derived from a namespace hierarchy stored in Knowledge Graph, and a set of rules, – “guids” are low-level ids historically used in Freebase (pre-Knowledge Graph, deprecated). Only the mid and id are supplied here. Note that mids can be converted to guids or uint64s (see //metaweb/util/mid/mid.h). | String |
| latDeg | FreebaseLatLong | Represents a geopoint, which is one of the possible Value types. | number | |
| longDeg | FreebaseLatLong | Represents a geopoint, which is one of the possible Value types. | number | |
| magnitude | FreebaseMeasurement | Represents a measurements, which is one of the possible Value types. A measurement value like “5.2 meter^2 / second” would be represented as: magnitude: 5.2 unit { unit_mid: “/m/mid_for_meter” power: 2 } unit { unit_mid: “/m/mid_for_second” power: -1 } | number | |
| unit | Repeated units are interpreted as a product. i.e. (meter ^ 1) * (second ^ -2) | FreebaseMeasurement | Represents a measurements, which is one of the possible Value types. A measurement value like “5.2 meter^2 / second” would be represented as: magnitude: 5.2 unit { unit_mid: “/m/mid_for_meter” power: 2 } unit { unit_mid: “/m/mid_for_second” power: -1 } | list(FreebaseMeasurementUnit) |
| power | FreebaseMeasurementUnit | integer | ||
| unit | FreebaseMeasurementUnit | FreebaseId | ||
| unitMid | Deprecated fields. | FreebaseMeasurementUnit | String | |
| propertyValue | FreebaseNestedStruct | List of { predicate, { object } } to be processed as a Nested Struct. Nested Struct can be recursive. NestedStruct.property_value(i).value(j) may have nested_struct field. | list(FreebasePropertyValue) | |
| property | The id of the property. | FreebasePropertyValue | A PropertyValue associates properties with values in the context of a topic. | FreebaseId |
| totalValueCount | Indicates the total values that exist for this property, even if they aren’t all present in the value field, due to truncation. | FreebasePropertyValue | A PropertyValue associates properties with values in the context of a topic. | String |
| value | The value associated with the property for the containing topic. | FreebasePropertyValue | A PropertyValue associates properties with values in the context of a topic. | list(FreebaseValue) |
| valueStatus | If ValueStatus is not set at all, the implication is that there are well-known value(s), specified in the “value” field. (It should be considered malformed data to have value_status set when len(values) > 0.) | FreebasePropertyValue | A PropertyValue associates properties with values in the context of a topic. | String |
| id | The id (mid and human-readable id) of the topic. The id will always be present and will contain a mid value for topics in the topic sstable. | FreebaseTopic | A Topic represents a Knowledge Graph entity with its associated properties and their values. | FreebaseId |
| propertyValue | The property-value bindings associated with the topic. Note that in the case where a property is relevant to a topic based on its type, but no values of that property are present for the topic, the PropertyValue will simply not appear, rather than being present with a null value, or empty repeated value list. | FreebaseTopic | A Topic represents a Knowledge Graph entity with its associated properties and their values. | list(FreebasePropertyValue) |
| boolValue | Present when value is bool. | FreebaseValue | Values are effectively a union of several possible Knowledge Graph types: simple primitive datatypes such as booleans, integers and floats, references to other Knowledge Graph topics (by id), or “compound values” which are expressed as embedded topics with associated properties and values. Values occur in indexed order (if any). | boolean |
| citation | Citation data for this value. See: http://go/kg-clap | FreebaseValue | Values are effectively a union of several possible Knowledge Graph types: simple primitive datatypes such as booleans, integers and floats, references to other Knowledge Graph topics (by id), or “compound values” which are expressed as embedded topics with associated properties and values. Values occur in indexed order (if any). | FreebaseCitation |
| compoundValue | Compound values are those that contain either a number of simple valued facets (such as a latitude/longitude pair), or “mediator” topics representing multi-dimensional relationships between topics. In both cases we represent them here with an embedded topic, although the topic’s identity is somewhat secondary to the property/value pairs it contains. (The identity is still made available so that it can be used to perform updates to that mediator on the Knowledge Graph.) | FreebaseValue | Values are effectively a union of several possible Knowledge Graph types: simple primitive datatypes such as booleans, integers and floats, references to other Knowledge Graph topics (by id), or “compound values” which are expressed as embedded topics with associated properties and values. Values occur in indexed order (if any). | FreebaseTopic |
| deletionProvenance | Deletion provenance for this value. | FreebaseValue | Values are effectively a union of several possible Knowledge Graph types: simple primitive datatypes such as booleans, integers and floats, references to other Knowledge Graph topics (by id), or “compound values” which are expressed as embedded topics with associated properties and values. Values occur in indexed order (if any). | list(StorageGraphBfgTripleProvenance) |
| displayLang | The lang of the display_value field. | FreebaseValue | Values are effectively a union of several possible Knowledge Graph types: simple primitive datatypes such as booleans, integers and floats, references to other Knowledge Graph topics (by id), or “compound values” which are expressed as embedded topics with associated properties and values. Values occur in indexed order (if any). | String |
| displayValue | The display value of this value. This is a i18n-aware formatted value if present. | FreebaseValue | Values are effectively a union of several possible Knowledge Graph types: simple primitive datatypes such as booleans, integers and floats, references to other Knowledge Graph topics (by id), or “compound values” which are expressed as embedded topics with associated properties and values. Values occur in indexed order (if any). | String |
| expectedProto | An optional name for a proto field. | FreebaseValue | Values are effectively a union of several possible Knowledge Graph types: simple primitive datatypes such as booleans, integers and floats, references to other Knowledge Graph topics (by id), or “compound values” which are expressed as embedded topics with associated properties and values. Values occur in indexed order (if any). | String |
| floatValue | Present when value is float. | FreebaseValue | Values are effectively a union of several possible Knowledge Graph types: simple primitive datatypes such as booleans, integers and floats, references to other Knowledge Graph topics (by id), or “compound values” which are expressed as embedded topics with associated properties and values. Values occur in indexed order (if any). | float |
| idValue | Present when value is an id. | FreebaseValue | Values are effectively a union of several possible Knowledge Graph types: simple primitive datatypes such as booleans, integers and floats, references to other Knowledge Graph topics (by id), or “compound values” which are expressed as embedded topics with associated properties and values. Values occur in indexed order (if any). | FreebaseId |
| index | Index of the value relative to the containing property (if any). Knowledge Graph supports a loose notion of indexing: some non-unique properties may have indices, while others may not. Furthermore, for a single property, some values may have indices (such as the top 5 actors in a film), while others may not (the film’s supporting cast). Un-indexed values will appear at the end of the repeated value list. This field contains the index value only when is present in the Knowledge Graph. | FreebaseValue | Values are effectively a union of several possible Knowledge Graph types: simple primitive datatypes such as booleans, integers and floats, references to other Knowledge Graph topics (by id), or “compound values” which are expressed as embedded topics with associated properties and values. Values occur in indexed order (if any). | String |
| intValue | Present when value is int. | FreebaseValue | Values are effectively a union of several possible Knowledge Graph types: simple primitive datatypes such as booleans, integers and floats, references to other Knowledge Graph topics (by id), or “compound values” which are expressed as embedded topics with associated properties and values. Values occur in indexed order (if any). | String |
| lang | Whenever the value is text with TYPE_TEXT, the lang field is populated with the III LanguageCode associated with the string_value field. | FreebaseValue | Values are effectively a union of several possible Knowledge Graph types: simple primitive datatypes such as booleans, integers and floats, references to other Knowledge Graph topics (by id), or “compound values” which are expressed as embedded topics with associated properties and values. Values occur in indexed order (if any). | String |
| latLongValue | FreebaseValue | Values are effectively a union of several possible Knowledge Graph types: simple primitive datatypes such as booleans, integers and floats, references to other Knowledge Graph topics (by id), or “compound values” which are expressed as embedded topics with associated properties and values. Values occur in indexed order (if any). | FreebaseLatLong | |
| measurementValue | FreebaseValue | Values are effectively a union of several possible Knowledge Graph types: simple primitive datatypes such as booleans, integers and floats, references to other Knowledge Graph topics (by id), or “compound values” which are expressed as embedded topics with associated properties and values. Values occur in indexed order (if any). | FreebaseMeasurement | |
| nestedStruct | Populated if this value holds NestedStruct. ‘type’ field needs to be set to TYPE_NESTED_STRUCT. | FreebaseValue | Values are effectively a union of several possible Knowledge Graph types: simple primitive datatypes such as booleans, integers and floats, references to other Knowledge Graph topics (by id), or “compound values” which are expressed as embedded topics with associated properties and values. Values occur in indexed order (if any). | FreebaseNestedStruct |
| provenance | Provenance for this value. | FreebaseValue | Values are effectively a union of several possible Knowledge Graph types: simple primitive datatypes such as booleans, integers and floats, references to other Knowledge Graph topics (by id), or “compound values” which are expressed as embedded topics with associated properties and values. Values occur in indexed order (if any). | list(StorageGraphBfgTripleProvenance) |
| rawValue | Similar to string_value/etc but contains raw bytes. | FreebaseValue | Values are effectively a union of several possible Knowledge Graph types: simple primitive datatypes such as booleans, integers and floats, references to other Knowledge Graph topics (by id), or “compound values” which are expressed as embedded topics with associated properties and values. Values occur in indexed order (if any). | String |
| stringValue | Present when value is text, enum, | FreebaseValue | Values are effectively a union of several possible Knowledge Graph types: simple primitive datatypes such as booleans, integers and floats, references to other Knowledge Graph topics (by id), or “compound values” which are expressed as embedded topics with associated properties and values. Values occur in indexed order (if any). | String |
| subgraphId | FreebaseValue | Values are effectively a union of several possible Knowledge Graph types: simple primitive datatypes such as booleans, integers and floats, references to other Knowledge Graph topics (by id), or “compound values” which are expressed as embedded topics with associated properties and values. Values occur in indexed order (if any). | list(String) | |
| timestamp | The ISO-8601 timestamp corresponding to when this value was created (when it was written to the Knowledge Graph). Deprecated in favor of timestamp_usec. | FreebaseValue | Values are effectively a union of several possible Knowledge Graph types: simple primitive datatypes such as booleans, integers and floats, references to other Knowledge Graph topics (by id), or “compound values” which are expressed as embedded topics with associated properties and values. Values occur in indexed order (if any). | String |
| timestampUsec | The microsecond timestamp corresponding to when this value was created. | FreebaseValue | Values are effectively a union of several possible Knowledge Graph types: simple primitive datatypes such as booleans, integers and floats, references to other Knowledge Graph topics (by id), or “compound values” which are expressed as embedded topics with associated properties and values. Values occur in indexed order (if any). | String |
| type | FreebaseValue | Values are effectively a union of several possible Knowledge Graph types: simple primitive datatypes such as booleans, integers and floats, references to other Knowledge Graph topics (by id), or “compound values” which are expressed as embedded topics with associated properties and values. Values occur in indexed order (if any). | String | |
| ContentExpiryTime | unix secs from epoch | GDocumentBase | Next id: 127 | integer |
| DisplayUrl | Sometimes the URL displayed in search results should be different from what gets indexed (e.g. in enterprise, content management systems). If this value is not set, we default to the regular URL. | GDocumentBase | Next id: 127 | String |
| DocId | 64-bit docid of the document (usually fingerprint of URL, but not always). WARNING: This does NOT uniquely identify a document ANYMORE. For a unique identifier across all documents in production please refer to the field ‘id().key()’ listed above. | GDocumentBase | Next id: 127 | String |
| ExternalFeedMetadata | GDocumentBase | Next id: 127 | String | |
| ExternalHttpMetadata | Enterprise-specific external metadata. See http://engdoc/eng/designdocs/enterprise/enterprise_indexing_metadata.html | GDocumentBase | Next id: 127 | String |
| FilterForSafeSearch | Deprecated, do not use, this field is not populated since 2012. | GDocumentBase | Next id: 127 | integer |
| IPAddr | IP addr in binary (allows for IPv6) | GDocumentBase | Next id: 127 | String |
| NoArchiveReason | GDocumentBase | Next id: 127 | integer | |
| NoFollowReason | GDocumentBase | Next id: 127 | integer | |
| NoImageIndexReason | GDocumentBase | Next id: 127 | integer | |
| NoImageframeOverlayReason | GDocumentBase | Next id: 127 | integer | |
| NoIndexReason | When these reasons are set to a non zero value, the document should not be indexed, or show a snippet, or show a cache, etc. These reasons are bit maps of indexing.converter.RobotsInfo.RobotedReasons enum values reflecting the places where the restriction was found: //depot/google3/indexing/converter/proto/converter.proto | GDocumentBase | Next id: 127 | integer |
| NoPreviewReason | GDocumentBase | Next id: 127 | integer | |
| NoSnippetReason | GDocumentBase | Next id: 127 | integer | |
| NoTranslateReason | GDocumentBase | Next id: 127 | integer | |
| Pagerank | This field is long-deprecated in favour of Pagerank_NS, it is no longer maintained and can break at any moment. | GDocumentBase | Next id: 127 | integer |
| PagerankNS | Pagerank-NearestSeeds is a pagerank score for the doc, calculated using NearestSeeds method. This is the production PageRank value teams should use. | GDocumentBase | Next id: 127 | integer |
| Repid | is the webmirror representative id of the canonical url. Urls with the same repid are considered as dups in webmirror. WARNING: use this field with caution! The webmirror duprules change frequently, so this value only reflects the duprules at the time when the canonical’s docjoin is built. | GDocumentBase | Next id: 127 | String |
| ScienceMetadata | Citation data for science articles. | GDocumentBase | Next id: 127 | ScienceCitation |
| URL | WARNING: the URL does NOT uniquely identify a document ANYMORE. For a unique identifier across all documents in production please refer to the field ‘id().key()’ listed above. Reason: foo.bar:/http and foo.bar:/http:SMARTPHONE share the same URL, but the body of the two documents might differ because of different crawl-context (desktop vs. smartphone in this example). | GDocumentBase | Next id: 127 | String |
| URLAfterRedirects | GDocumentBase | Next id: 127 | String | |
| URLEncoding | See webutil/urlencoding | GDocumentBase | Next id: 127 | integer |
| content | GDocumentBase | Next id: 127 | GDocumentBaseContent | |
| directory | GDocumentBase | Next id: 127 | list(GDocumentBaseDirectory) | |
| ecnFp | 96-bit fingerprint of the canonical url’s webmirror equivalence class name as of when this cdoc was exported. | GDocumentBase | Next id: 127 | String |
| id | The primary identifier of a production document is the document key given in the ServingDocumentIdentifier, which is the same as the row-key in Alexandria, and represents a URL and its crawling context. In your production code, please always assume that the document key is the only way to uniquely identify a document. ## Recommended way of reading: const string& doc_key = cdoc.doc().id().key(); ## CHECK(!doc_key.empty()); More background information can be found in google3/indexing/crawler_id/servingdocumentidentifier.proto The ServingDocumentIdentifier uniquely identifies a document in serving and also distinguishes between experimental vs. production documents. The SDI is also used as an input for the union/muppet key generation in serving. | GDocumentBase | Next id: 127 | IndexingCrawlerIdServingDocumentIdentifier |
| localsearchDocInfo | Localsearch-specific data. | GDocumentBase | Next id: 127 | LocalsearchDocInfo |
| oceanDocInfo | Ocean-specific data. | GDocumentBase | Next id: 127 | OceanDocInfo |
| originalcontent | GDocumentBase | Next id: 127 | GDocumentBaseOriginalContent | |
| userAgentName | The user agent name used to crawl the URL. See //crawler/engine/webmirror_user_agents.h for the list of user-agents (e.g. crawler::WebmirrorUserAgents::kGoogleBot). NOTE: This field is copied from the first WEBMIRROR FetchReplyClientInfo in trawler_fetch_info column. We leave this field unpopulated if no WEBMIRROR FecthReplyClientInfo is found. As the submission of cl/51488336, Alexandria starts to populate this field. However, docjoins from freshdocs (or any other source), won’t have this field populated, because we believe no one needs to read this field from freshdocs docjoins. | GDocumentBase | Next id: 127 | String |
| AuthMethod | GDocumentBaseContent | Main content section | integer | |
| ContentLength | The actual length of the content: If Representation is compressed, this equals to Content.UncompressedLength; otherwise it is the length of the representation string. | GDocumentBaseContent | Main content section | integer |
| ContentType | See enum ContentType in //depot/google3/webutil/http/content-type.proto. | GDocumentBaseContent | Main content section | integer |
| CrawlTime | Seconds since Unix epoch. | GDocumentBaseContent | Main content section | String |
| Encoding | See //depot/google3/i18n/encodings/public/encodings.h Encoding of representation | GDocumentBaseContent | Main content section | integer |
| HasHttpHeader | Set to false if Representation does not contain HTTP headers. | GDocumentBaseContent | Main content section | boolean |
| Language | A Language enum value. See: go/language-enum Default is english | GDocumentBaseContent | Main content section | integer |
| OriginalEncoding | If OriginalEncoding is present, the body part of the Representation was converted to UTF-8, Encoding was set to UTF8, and OriginalEncoding was set to the original encoding before conversion. However, the HTTP headers part of the content might not be valid UTF-8. -1=an invalid value | GDocumentBaseContent | Main content section | integer |
| Representation | Possibly compressed for old documents. It is not compressed for docjoins produced by Raffia after ~2012. | GDocumentBaseContent | Main content section | String |
| UncompressedLength | Historically present if Representation is compressed. | GDocumentBaseContent | Main content section | integer |
| VisualType | Whether the content was visual right-to-left, and if so, what type of visual document it is. Must be one of the values in enum VisualType from google3/repository/rtl/visualtype.h Default is NOT_VISUAL_DOCUMENT. See http://wiki/Main/RtlLanguages for background. | GDocumentBaseContent | Main content section | integer |
| crawledFileSize | Crawled file size of the original document. | GDocumentBaseContent | Main content section | integer |
| encodedGeometryAnnotations | GeometryAnnotations, encoded with GeometryUtil::DeltaEncode() to reduce disk space usage. Use GeometryUtil::DeltaDecode() to decode this field. | GDocumentBaseContent | Main content section | String |
| Category | encoded in UTF8 | GDocumentBaseDirectory | The Directory proto group holds snippet and title metadata which is made available to the snippet code. The proto group was originally created for metadata coming from the Google Web Directory (gwd) project. It has since come to be used to hold metadata from gwd and other sources. | String |
| Description | encoded in UTF8 | GDocumentBaseDirectory | The Directory proto group holds snippet and title metadata which is made available to the snippet code. The proto group was originally created for metadata coming from the Google Web Directory (gwd) project. It has since come to be used to hold metadata from gwd and other sources. | String |
| DescriptionScore | GDocumentBaseDirectory | The Directory proto group holds snippet and title metadata which is made available to the snippet code. The proto group was originally created for metadata coming from the Google Web Directory (gwd) project. It has since come to be used to hold metadata from gwd and other sources. | number | |
| Identifier | “gwd”, etc. | GDocumentBaseDirectory | The Directory proto group holds snippet and title metadata which is made available to the snippet code. The proto group was originally created for metadata coming from the Google Web Directory (gwd) project. It has since come to be used to hold metadata from gwd and other sources. | String |
| Language | go/language-enum | GDocumentBaseDirectory | The Directory proto group holds snippet and title metadata which is made available to the snippet code. The proto group was originally created for metadata coming from the Google Web Directory (gwd) project. It has since come to be used to hold metadata from gwd and other sources. | integer |
| Title | encoded in UTF8 | GDocumentBaseDirectory | The Directory proto group holds snippet and title metadata which is made available to the snippet code. The proto group was originally created for metadata coming from the Google Web Directory (gwd) project. It has since come to be used to hold metadata from gwd and other sources. | String |
| TitleScore | Deprecated; do not use. There is no code populating these fields as of Oct 2017. | GDocumentBaseDirectory | The Directory proto group holds snippet and title metadata which is made available to the snippet code. The proto group was originally created for metadata coming from the Google Web Directory (gwd) project. It has since come to be used to hold metadata from gwd and other sources. | number |
| URL | GDocumentBaseDirectory | The Directory proto group holds snippet and title metadata which is made available to the snippet code. The proto group was originally created for metadata coming from the Google Web Directory (gwd) project. It has since come to be used to hold metadata from gwd and other sources. | String | |
| Representation | GDocumentBaseOriginalContent | The original, unconverted document, typically PDF or Word. Copied from OriginalDoc field of doclogs. Unlike “Content”, this does not contain any HTTP headers. The content may be compressed using the same method as “Content”. In practice it is only compressed in the Teragoogle index. It is never compressed in docjoins because those are compressed at the sstable level. In doclogs content will only be compressed if the Trawler fetchreply is also compressed–which is currently never and unlikely to change for performance reasons. | String | |
| UncompressedLength | present iff rep is compressed | GDocumentBaseOriginalContent | The original, unconverted document, typically PDF or Word. Copied from OriginalDoc field of doclogs. Unlike “Content”, this does not contain any HTTP headers. The content may be compressed using the same method as “Content”. In practice it is only compressed in the Teragoogle index. It is never compressed in docjoins because those are compressed at the sstable level. In doclogs content will only be compressed if the Trawler fetchreply is also compressed–which is currently never and unlikely to change for performance reasons. | integer |
| debugInfo | Per-doc debug information. | GenericSnippetResponse | The generic version of a snippet response | list(String) |
| info | Servlet-specific response info. | GenericSnippetResponse | The generic version of a snippet response | Proto2BridgeMessageSet |
| rankingSnippet | The experimental ranking snippet field. This will be populated only when `fastwa_want_ranking_snippet` is set in the request. | GenericSnippetResponse | The generic version of a snippet response | String |
| snippet | Lines of the snippet HTML. Typically gws concatenates these and lets the browser wrap. The values include trailing spaces, so inserting additional spaces is not necessary. However, for very old browsers, gws may insert break tags after each snippet line. This field is confusing and poorly named; “snippet_line” would be better. In particular, note that this does not return multiple snippets for a result. Nor are these fields the individual tidbits of the snippet. | GenericSnippetResponse | The generic version of a snippet response | list(String) |
| title | The title HTML. It may contain tags to denote query term matches. It may be already truncated and “…” is put instead (note that truncation does not always happen at the very end of the title text). However the existence of “…” does not guarantee that the snippet generation algorithm truncated it; e.g. webmasters themselves can write “…”. | GenericSnippetResponse | The generic version of a snippet response | String |
| wwwSnippetResponse | Snippet-specific members (tag ids 16+, must be optional!) Example: optional NewContentResponse new_response; | GenericSnippetResponse | The generic version of a snippet response | WWWSnippetResponse |
| allowsGuestCheckout | Whether this local entity allows guest checkout for reservations. | GeoOndemandAssistantSupportedActions | Actions supported by Madden for a local entity. | boolean |
| isAsynchronousRestaurantReservation | Whether or not this local entity supports asynchronous restaurant reservations, through the above restaurant_reservation_url. | GeoOndemandAssistantSupportedActions | Actions supported by Madden for a local entity. | boolean |
| restaurantReservationUrl | URL for the Madden restaurant reservation flow, e.g. for display in a WebView. Not populated if restaurant reservations are not supported for the local entity. | GeoOndemandAssistantSupportedActions | Actions supported by Madden for a local entity. | String |
| canEnter | RESERVED | GeostoreAccessPointProto | This class holds information about a single access point. An access point establishes a relationship between a feature (like a POI or building) and some other feature. For example, consider a TYPE_LOCALITY feature like Seattle. An access point might be the TYPE_AIRPORT feature for Seattle-Tacoma International Airport. The airport feature defines the access point to gain airplane-based access to Seattle. A feature like Seattle will typically have multiple access points. You can get to Seattle using airplanes, various forms of public transit, or by driving a car. Thus Seattle would have multiple access points. You may be able to get to Seattle by flying into SeaTac, or you might be able to fly into Boeing Field, or Paine Field in Everett. You could drive in from the North/South using I-5, or you could drive in from the East using I-90. Many access points are from the road network. Thus the access point for some building at 123 Main Street would likely be a segment that defines the 100-200 block of “Main Street”. A feature at the corner of “Hollywood” and “Vine” streets might have access points from both named streets. Access points are an optional field. Data editors may ignore them when creating features or editing other fields. In these cases, other quality teams will synthesize and update them. Several fields are also optional, as they are derivable from other fields. Access points to non-TYPE_SEGMENT features should always have the following fields set: – feature_type – feature_id – point Location and reference fields: BASIC vs DERIVABLE Access points to TYPE_SEGMENT features must have all the following BASIC fields: – feature_type (of the segment, e.g. TYPE_ROAD or TYPE_VIRTUAL_SEGMENT) – point_off_segment (or point; see “fuzzy point” note below) – unsuitable_travel_mode (may be empty) – level (indoor access points only) The following are DERIVABLE fields, which should only be added if the supplier is confident about their accuracy: – feature_id – point_on_segment – segment_position Editing clients are encouraged to set all fields, but they may set only the BASIC fields, in which case quality teams may use the BASIC fields to snap to an appropriate segment and derive the remaining fields. Example: The segment is split, so that the portion that the access point is on has a new feature ID. Quality teams notice that the point_on_segment is no longer on the segment with feature_id, finds the new nearest segment based on feature_type and existing point_on_segment, and re-derives a new feature_id, point_on_segment, and segment_position, keeping other fields consistent. Fuzzy point special case If the editor does not have side-of-road information for access points or is otherwise unsure of the precise placement of the access point, it may supply the point field (and not point_off_segment) as basic data instead, in which case quality teams may generate the point_off_segment. Identity Access points are considered semantically equivalent if they have the same geometry, including derived fields, and the same references to other features (feature_id, level_feature_id). For the exact definition, see cs/symbol:geostore::AreAccessPointsEquivalent. Field definitions | boolean |
| canExit | RESERVED | GeostoreAccessPointProto | This class holds information about a single access point. An access point establishes a relationship between a feature (like a POI or building) and some other feature. For example, consider a TYPE_LOCALITY feature like Seattle. An access point might be the TYPE_AIRPORT feature for Seattle-Tacoma International Airport. The airport feature defines the access point to gain airplane-based access to Seattle. A feature like Seattle will typically have multiple access points. You can get to Seattle using airplanes, various forms of public transit, or by driving a car. Thus Seattle would have multiple access points. You may be able to get to Seattle by flying into SeaTac, or you might be able to fly into Boeing Field, or Paine Field in Everett. You could drive in from the North/South using I-5, or you could drive in from the East using I-90. Many access points are from the road network. Thus the access point for some building at 123 Main Street would likely be a segment that defines the 100-200 block of “Main Street”. A feature at the corner of “Hollywood” and “Vine” streets might have access points from both named streets. Access points are an optional field. Data editors may ignore them when creating features or editing other fields. In these cases, other quality teams will synthesize and update them. Several fields are also optional, as they are derivable from other fields. Access points to non-TYPE_SEGMENT features should always have the following fields set: – feature_type – feature_id – point Location and reference fields: BASIC vs DERIVABLE Access points to TYPE_SEGMENT features must have all the following BASIC fields: – feature_type (of the segment, e.g. TYPE_ROAD or TYPE_VIRTUAL_SEGMENT) – point_off_segment (or point; see “fuzzy point” note below) – unsuitable_travel_mode (may be empty) – level (indoor access points only) The following are DERIVABLE fields, which should only be added if the supplier is confident about their accuracy: – feature_id – point_on_segment – segment_position Editing clients are encouraged to set all fields, but they may set only the BASIC fields, in which case quality teams may use the BASIC fields to snap to an appropriate segment and derive the remaining fields. Example: The segment is split, so that the portion that the access point is on has a new feature ID. Quality teams notice that the point_on_segment is no longer on the segment with feature_id, finds the new nearest segment based on feature_type and existing point_on_segment, and re-derives a new feature_id, point_on_segment, and segment_position, keeping other fields consistent. Fuzzy point special case If the editor does not have side-of-road information for access points or is otherwise unsure of the precise placement of the access point, it may supply the point field (and not point_off_segment) as basic data instead, in which case quality teams may generate the point_off_segment. Identity Access points are considered semantically equivalent if they have the same geometry, including derived fields, and the same references to other features (feature_id, level_feature_id). For the exact definition, see cs/symbol:geostore::AreAccessPointsEquivalent. Field definitions | boolean |
| featureId | The ID of the feature that defines the access point. The bounding box of the feature is expanded to include the bounding box of the feature with the access point in accordance with the standard practice for bucketing map/reduce operations. See the wiki page at http://wiki/Main/OysterBucketingMapReduce for more information. For access points to TYPE_SEGMENT features, this may be re-derived if necessary by looking up the nearest segment to existing geometry. | GeostoreAccessPointProto | This class holds information about a single access point. An access point establishes a relationship between a feature (like a POI or building) and some other feature. For example, consider a TYPE_LOCALITY feature like Seattle. An access point might be the TYPE_AIRPORT feature for Seattle-Tacoma International Airport. The airport feature defines the access point to gain airplane-based access to Seattle. A feature like Seattle will typically have multiple access points. You can get to Seattle using airplanes, various forms of public transit, or by driving a car. Thus Seattle would have multiple access points. You may be able to get to Seattle by flying into SeaTac, or you might be able to fly into Boeing Field, or Paine Field in Everett. You could drive in from the North/South using I-5, or you could drive in from the East using I-90. Many access points are from the road network. Thus the access point for some building at 123 Main Street would likely be a segment that defines the 100-200 block of “Main Street”. A feature at the corner of “Hollywood” and “Vine” streets might have access points from both named streets. Access points are an optional field. Data editors may ignore them when creating features or editing other fields. In these cases, other quality teams will synthesize and update them. Several fields are also optional, as they are derivable from other fields. Access points to non-TYPE_SEGMENT features should always have the following fields set: – feature_type – feature_id – point Location and reference fields: BASIC vs DERIVABLE Access points to TYPE_SEGMENT features must have all the following BASIC fields: – feature_type (of the segment, e.g. TYPE_ROAD or TYPE_VIRTUAL_SEGMENT) – point_off_segment (or point; see “fuzzy point” note below) – unsuitable_travel_mode (may be empty) – level (indoor access points only) The following are DERIVABLE fields, which should only be added if the supplier is confident about their accuracy: – feature_id – point_on_segment – segment_position Editing clients are encouraged to set all fields, but they may set only the BASIC fields, in which case quality teams may use the BASIC fields to snap to an appropriate segment and derive the remaining fields. Example: The segment is split, so that the portion that the access point is on has a new feature ID. Quality teams notice that the point_on_segment is no longer on the segment with feature_id, finds the new nearest segment based on feature_type and existing point_on_segment, and re-derives a new feature_id, point_on_segment, and segment_position, keeping other fields consistent. Fuzzy point special case If the editor does not have side-of-road information for access points or is otherwise unsure of the precise placement of the access point, it may supply the point field (and not point_off_segment) as basic data instead, in which case quality teams may generate the point_off_segment. Identity Access points are considered semantically equivalent if they have the same geometry, including derived fields, and the same references to other features (feature_id, level_feature_id). For the exact definition, see cs/symbol:geostore::AreAccessPointsEquivalent. Field definitions | GeostoreFeatureIdProto |
| featureType | The type of the feature. Required, to allow handling the access point differently based on feature type. For access points to non-TYPE_SEGMENT features, this cached type also makes things easier for clients that aren’t running a bucketing map-reduce. For access points to TYPE_SEGMENT features, this is used to find to find the nearest segment of the given type. | GeostoreAccessPointProto | This class holds information about a single access point. An access point establishes a relationship between a feature (like a POI or building) and some other feature. For example, consider a TYPE_LOCALITY feature like Seattle. An access point might be the TYPE_AIRPORT feature for Seattle-Tacoma International Airport. The airport feature defines the access point to gain airplane-based access to Seattle. A feature like Seattle will typically have multiple access points. You can get to Seattle using airplanes, various forms of public transit, or by driving a car. Thus Seattle would have multiple access points. You may be able to get to Seattle by flying into SeaTac, or you might be able to fly into Boeing Field, or Paine Field in Everett. You could drive in from the North/South using I-5, or you could drive in from the East using I-90. Many access points are from the road network. Thus the access point for some building at 123 Main Street would likely be a segment that defines the 100-200 block of “Main Street”. A feature at the corner of “Hollywood” and “Vine” streets might have access points from both named streets. Access points are an optional field. Data editors may ignore them when creating features or editing other fields. In these cases, other quality teams will synthesize and update them. Several fields are also optional, as they are derivable from other fields. Access points to non-TYPE_SEGMENT features should always have the following fields set: – feature_type – feature_id – point Location and reference fields: BASIC vs DERIVABLE Access points to TYPE_SEGMENT features must have all the following BASIC fields: – feature_type (of the segment, e.g. TYPE_ROAD or TYPE_VIRTUAL_SEGMENT) – point_off_segment (or point; see “fuzzy point” note below) – unsuitable_travel_mode (may be empty) – level (indoor access points only) The following are DERIVABLE fields, which should only be added if the supplier is confident about their accuracy: – feature_id – point_on_segment – segment_position Editing clients are encouraged to set all fields, but they may set only the BASIC fields, in which case quality teams may use the BASIC fields to snap to an appropriate segment and derive the remaining fields. Example: The segment is split, so that the portion that the access point is on has a new feature ID. Quality teams notice that the point_on_segment is no longer on the segment with feature_id, finds the new nearest segment based on feature_type and existing point_on_segment, and re-derives a new feature_id, point_on_segment, and segment_position, keeping other fields consistent. Fuzzy point special case If the editor does not have side-of-road information for access points or is otherwise unsure of the precise placement of the access point, it may supply the point field (and not point_off_segment) as basic data instead, in which case quality teams may generate the point_off_segment. Identity Access points are considered semantically equivalent if they have the same geometry, including derived fields, and the same references to other features (feature_id, level_feature_id). For the exact definition, see cs/symbol:geostore::AreAccessPointsEquivalent. Field definitions | integer |
| levelFeatureId | For indoor access points, this should be set to the level that the access point is on. The feature_id should point to the indoor segment, but when it is missing or invalid, and we need to derive it from geometry, only segments on this level will be considered. For non-indoor access points, level should remain unset, and when we derive feature_id from geometry, only segments not on any level (non-indoor segments) will be considered. The bounding box of the level feature is expanded to include the bounding box of the feature with the access point in accordance with the standard practice for bucketing map/reduce operations. See the wiki page at http://wiki/Main/OysterBucketingMapReduce for more information. (Though in general the feature should reside on the level already anyway..) | GeostoreAccessPointProto | This class holds information about a single access point. An access point establishes a relationship between a feature (like a POI or building) and some other feature. For example, consider a TYPE_LOCALITY feature like Seattle. An access point might be the TYPE_AIRPORT feature for Seattle-Tacoma International Airport. The airport feature defines the access point to gain airplane-based access to Seattle. A feature like Seattle will typically have multiple access points. You can get to Seattle using airplanes, various forms of public transit, or by driving a car. Thus Seattle would have multiple access points. You may be able to get to Seattle by flying into SeaTac, or you might be able to fly into Boeing Field, or Paine Field in Everett. You could drive in from the North/South using I-5, or you could drive in from the East using I-90. Many access points are from the road network. Thus the access point for some building at 123 Main Street would likely be a segment that defines the 100-200 block of “Main Street”. A feature at the corner of “Hollywood” and “Vine” streets might have access points from both named streets. Access points are an optional field. Data editors may ignore them when creating features or editing other fields. In these cases, other quality teams will synthesize and update them. Several fields are also optional, as they are derivable from other fields. Access points to non-TYPE_SEGMENT features should always have the following fields set: – feature_type – feature_id – point Location and reference fields: BASIC vs DERIVABLE Access points to TYPE_SEGMENT features must have all the following BASIC fields: – feature_type (of the segment, e.g. TYPE_ROAD or TYPE_VIRTUAL_SEGMENT) – point_off_segment (or point; see “fuzzy point” note below) – unsuitable_travel_mode (may be empty) – level (indoor access points only) The following are DERIVABLE fields, which should only be added if the supplier is confident about their accuracy: – feature_id – point_on_segment – segment_position Editing clients are encouraged to set all fields, but they may set only the BASIC fields, in which case quality teams may use the BASIC fields to snap to an appropriate segment and derive the remaining fields. Example: The segment is split, so that the portion that the access point is on has a new feature ID. Quality teams notice that the point_on_segment is no longer on the segment with feature_id, finds the new nearest segment based on feature_type and existing point_on_segment, and re-derives a new feature_id, point_on_segment, and segment_position, keeping other fields consistent. Fuzzy point special case If the editor does not have side-of-road information for access points or is otherwise unsure of the precise placement of the access point, it may supply the point field (and not point_off_segment) as basic data instead, in which case quality teams may generate the point_off_segment. Identity Access points are considered semantically equivalent if they have the same geometry, including derived fields, and the same references to other features (feature_id, level_feature_id). For the exact definition, see cs/symbol:geostore::AreAccessPointsEquivalent. Field definitions | GeostoreFeatureIdProto |
| metadata | Field-level metadata for this access point. | GeostoreAccessPointProto | This class holds information about a single access point. An access point establishes a relationship between a feature (like a POI or building) and some other feature. For example, consider a TYPE_LOCALITY feature like Seattle. An access point might be the TYPE_AIRPORT feature for Seattle-Tacoma International Airport. The airport feature defines the access point to gain airplane-based access to Seattle. A feature like Seattle will typically have multiple access points. You can get to Seattle using airplanes, various forms of public transit, or by driving a car. Thus Seattle would have multiple access points. You may be able to get to Seattle by flying into SeaTac, or you might be able to fly into Boeing Field, or Paine Field in Everett. You could drive in from the North/South using I-5, or you could drive in from the East using I-90. Many access points are from the road network. Thus the access point for some building at 123 Main Street would likely be a segment that defines the 100-200 block of “Main Street”. A feature at the corner of “Hollywood” and “Vine” streets might have access points from both named streets. Access points are an optional field. Data editors may ignore them when creating features or editing other fields. In these cases, other quality teams will synthesize and update them. Several fields are also optional, as they are derivable from other fields. Access points to non-TYPE_SEGMENT features should always have the following fields set: – feature_type – feature_id – point Location and reference fields: BASIC vs DERIVABLE Access points to TYPE_SEGMENT features must have all the following BASIC fields: – feature_type (of the segment, e.g. TYPE_ROAD or TYPE_VIRTUAL_SEGMENT) – point_off_segment (or point; see “fuzzy point” note below) – unsuitable_travel_mode (may be empty) – level (indoor access points only) The following are DERIVABLE fields, which should only be added if the supplier is confident about their accuracy: – feature_id – point_on_segment – segment_position Editing clients are encouraged to set all fields, but they may set only the BASIC fields, in which case quality teams may use the BASIC fields to snap to an appropriate segment and derive the remaining fields. Example: The segment is split, so that the portion that the access point is on has a new feature ID. Quality teams notice that the point_on_segment is no longer on the segment with feature_id, finds the new nearest segment based on feature_type and existing point_on_segment, and re-derives a new feature_id, point_on_segment, and segment_position, keeping other fields consistent. Fuzzy point special case If the editor does not have side-of-road information for access points or is otherwise unsure of the precise placement of the access point, it may supply the point field (and not point_off_segment) as basic data instead, in which case quality teams may generate the point_off_segment. Identity Access points are considered semantically equivalent if they have the same geometry, including derived fields, and the same references to other features (feature_id, level_feature_id). For the exact definition, see cs/symbol:geostore::AreAccessPointsEquivalent. Field definitions | GeostoreFieldMetadataProto |
| point | For access points to non-TYPE_SEGMENT features, the location of the access point. For access points to TYPE_SEGMENT features, this can be supplied as a fuzzy access point that is not guaranteed to be on the correct side of road. It should not be used by end clients in case of TYPE_SEGMENT access points. | GeostoreAccessPointProto | This class holds information about a single access point. An access point establishes a relationship between a feature (like a POI or building) and some other feature. For example, consider a TYPE_LOCALITY feature like Seattle. An access point might be the TYPE_AIRPORT feature for Seattle-Tacoma International Airport. The airport feature defines the access point to gain airplane-based access to Seattle. A feature like Seattle will typically have multiple access points. You can get to Seattle using airplanes, various forms of public transit, or by driving a car. Thus Seattle would have multiple access points. You may be able to get to Seattle by flying into SeaTac, or you might be able to fly into Boeing Field, or Paine Field in Everett. You could drive in from the North/South using I-5, or you could drive in from the East using I-90. Many access points are from the road network. Thus the access point for some building at 123 Main Street would likely be a segment that defines the 100-200 block of “Main Street”. A feature at the corner of “Hollywood” and “Vine” streets might have access points from both named streets. Access points are an optional field. Data editors may ignore them when creating features or editing other fields. In these cases, other quality teams will synthesize and update them. Several fields are also optional, as they are derivable from other fields. Access points to non-TYPE_SEGMENT features should always have the following fields set: – feature_type – feature_id – point Location and reference fields: BASIC vs DERIVABLE Access points to TYPE_SEGMENT features must have all the following BASIC fields: – feature_type (of the segment, e.g. TYPE_ROAD or TYPE_VIRTUAL_SEGMENT) – point_off_segment (or point; see “fuzzy point” note below) – unsuitable_travel_mode (may be empty) – level (indoor access points only) The following are DERIVABLE fields, which should only be added if the supplier is confident about their accuracy: – feature_id – point_on_segment – segment_position Editing clients are encouraged to set all fields, but they may set only the BASIC fields, in which case quality teams may use the BASIC fields to snap to an appropriate segment and derive the remaining fields. Example: The segment is split, so that the portion that the access point is on has a new feature ID. Quality teams notice that the point_on_segment is no longer on the segment with feature_id, finds the new nearest segment based on feature_type and existing point_on_segment, and re-derives a new feature_id, point_on_segment, and segment_position, keeping other fields consistent. Fuzzy point special case If the editor does not have side-of-road information for access points or is otherwise unsure of the precise placement of the access point, it may supply the point field (and not point_off_segment) as basic data instead, in which case quality teams may generate the point_off_segment. Identity Access points are considered semantically equivalent if they have the same geometry, including derived fields, and the same references to other features (feature_id, level_feature_id). For the exact definition, see cs/symbol:geostore::AreAccessPointsEquivalent. Field definitions | GeostorePointProto |
| pointOffSegment | If the access point is defined by a TYPE_SEGMENT feature, this is the location of the access point displaced slightly to the correct side of the segment. This offset is in a direction perpendicular to the direction of travel along the segment. The actual offset distance is unspecified. It would typically be relatively small (approximately 1 meter). You can subtract the “off segment” point from the “on segment” point to get a vector of unknown length pointing from “on segment” point to the “off segment” point. You can then scale that vector to whatever length you want. Note that extending this displacement vector a large distance (10s of meters) may result in a new point that is in the middle of some other feature (park, street, intersection). This is the preferred basic geometry field for incoming data from editing clients and importers, if side-of-road is well-established. | GeostoreAccessPointProto | This class holds information about a single access point. An access point establishes a relationship between a feature (like a POI or building) and some other feature. For example, consider a TYPE_LOCALITY feature like Seattle. An access point might be the TYPE_AIRPORT feature for Seattle-Tacoma International Airport. The airport feature defines the access point to gain airplane-based access to Seattle. A feature like Seattle will typically have multiple access points. You can get to Seattle using airplanes, various forms of public transit, or by driving a car. Thus Seattle would have multiple access points. You may be able to get to Seattle by flying into SeaTac, or you might be able to fly into Boeing Field, or Paine Field in Everett. You could drive in from the North/South using I-5, or you could drive in from the East using I-90. Many access points are from the road network. Thus the access point for some building at 123 Main Street would likely be a segment that defines the 100-200 block of “Main Street”. A feature at the corner of “Hollywood” and “Vine” streets might have access points from both named streets. Access points are an optional field. Data editors may ignore them when creating features or editing other fields. In these cases, other quality teams will synthesize and update them. Several fields are also optional, as they are derivable from other fields. Access points to non-TYPE_SEGMENT features should always have the following fields set: – feature_type – feature_id – point Location and reference fields: BASIC vs DERIVABLE Access points to TYPE_SEGMENT features must have all the following BASIC fields: – feature_type (of the segment, e.g. TYPE_ROAD or TYPE_VIRTUAL_SEGMENT) – point_off_segment (or point; see “fuzzy point” note below) – unsuitable_travel_mode (may be empty) – level (indoor access points only) The following are DERIVABLE fields, which should only be added if the supplier is confident about their accuracy: – feature_id – point_on_segment – segment_position Editing clients are encouraged to set all fields, but they may set only the BASIC fields, in which case quality teams may use the BASIC fields to snap to an appropriate segment and derive the remaining fields. Example: The segment is split, so that the portion that the access point is on has a new feature ID. Quality teams notice that the point_on_segment is no longer on the segment with feature_id, finds the new nearest segment based on feature_type and existing point_on_segment, and re-derives a new feature_id, point_on_segment, and segment_position, keeping other fields consistent. Fuzzy point special case If the editor does not have side-of-road information for access points or is otherwise unsure of the precise placement of the access point, it may supply the point field (and not point_off_segment) as basic data instead, in which case quality teams may generate the point_off_segment. Identity Access points are considered semantically equivalent if they have the same geometry, including derived fields, and the same references to other features (feature_id, level_feature_id). For the exact definition, see cs/symbol:geostore::AreAccessPointsEquivalent. Field definitions | GeostorePointProto |
| pointOnSegment | If the access point is defined by a TYPE_SEGMENT feature, this is the point on the centerline of the segment that is closest to the actual access point. May be re-derived if necessary to maintain precise placement on segment. | GeostoreAccessPointProto | This class holds information about a single access point. An access point establishes a relationship between a feature (like a POI or building) and some other feature. For example, consider a TYPE_LOCALITY feature like Seattle. An access point might be the TYPE_AIRPORT feature for Seattle-Tacoma International Airport. The airport feature defines the access point to gain airplane-based access to Seattle. A feature like Seattle will typically have multiple access points. You can get to Seattle using airplanes, various forms of public transit, or by driving a car. Thus Seattle would have multiple access points. You may be able to get to Seattle by flying into SeaTac, or you might be able to fly into Boeing Field, or Paine Field in Everett. You could drive in from the North/South using I-5, or you could drive in from the East using I-90. Many access points are from the road network. Thus the access point for some building at 123 Main Street would likely be a segment that defines the 100-200 block of “Main Street”. A feature at the corner of “Hollywood” and “Vine” streets might have access points from both named streets. Access points are an optional field. Data editors may ignore them when creating features or editing other fields. In these cases, other quality teams will synthesize and update them. Several fields are also optional, as they are derivable from other fields. Access points to non-TYPE_SEGMENT features should always have the following fields set: – feature_type – feature_id – point Location and reference fields: BASIC vs DERIVABLE Access points to TYPE_SEGMENT features must have all the following BASIC fields: – feature_type (of the segment, e.g. TYPE_ROAD or TYPE_VIRTUAL_SEGMENT) – point_off_segment (or point; see “fuzzy point” note below) – unsuitable_travel_mode (may be empty) – level (indoor access points only) The following are DERIVABLE fields, which should only be added if the supplier is confident about their accuracy: – feature_id – point_on_segment – segment_position Editing clients are encouraged to set all fields, but they may set only the BASIC fields, in which case quality teams may use the BASIC fields to snap to an appropriate segment and derive the remaining fields. Example: The segment is split, so that the portion that the access point is on has a new feature ID. Quality teams notice that the point_on_segment is no longer on the segment with feature_id, finds the new nearest segment based on feature_type and existing point_on_segment, and re-derives a new feature_id, point_on_segment, and segment_position, keeping other fields consistent. Fuzzy point special case If the editor does not have side-of-road information for access points or is otherwise unsure of the precise placement of the access point, it may supply the point field (and not point_off_segment) as basic data instead, in which case quality teams may generate the point_off_segment. Identity Access points are considered semantically equivalent if they have the same geometry, including derived fields, and the same references to other features (feature_id, level_feature_id). For the exact definition, see cs/symbol:geostore::AreAccessPointsEquivalent. Field definitions | GeostorePointProto |
| priority | LINT.ThenChange(//depot/google3/geostore/cleanup/callbacks/\\ ID_DUPLICATE_ACCESS_POINT.cc) | GeostoreAccessPointProto | This class holds information about a single access point. An access point establishes a relationship between a feature (like a POI or building) and some other feature. For example, consider a TYPE_LOCALITY feature like Seattle. An access point might be the TYPE_AIRPORT feature for Seattle-Tacoma International Airport. The airport feature defines the access point to gain airplane-based access to Seattle. A feature like Seattle will typically have multiple access points. You can get to Seattle using airplanes, various forms of public transit, or by driving a car. Thus Seattle would have multiple access points. You may be able to get to Seattle by flying into SeaTac, or you might be able to fly into Boeing Field, or Paine Field in Everett. You could drive in from the North/South using I-5, or you could drive in from the East using I-90. Many access points are from the road network. Thus the access point for some building at 123 Main Street would likely be a segment that defines the 100-200 block of “Main Street”. A feature at the corner of “Hollywood” and “Vine” streets might have access points from both named streets. Access points are an optional field. Data editors may ignore them when creating features or editing other fields. In these cases, other quality teams will synthesize and update them. Several fields are also optional, as they are derivable from other fields. Access points to non-TYPE_SEGMENT features should always have the following fields set: – feature_type – feature_id – point Location and reference fields: BASIC vs DERIVABLE Access points to TYPE_SEGMENT features must have all the following BASIC fields: – feature_type (of the segment, e.g. TYPE_ROAD or TYPE_VIRTUAL_SEGMENT) – point_off_segment (or point; see “fuzzy point” note below) – unsuitable_travel_mode (may be empty) – level (indoor access points only) The following are DERIVABLE fields, which should only be added if the supplier is confident about their accuracy: – feature_id – point_on_segment – segment_position Editing clients are encouraged to set all fields, but they may set only the BASIC fields, in which case quality teams may use the BASIC fields to snap to an appropriate segment and derive the remaining fields. Example: The segment is split, so that the portion that the access point is on has a new feature ID. Quality teams notice that the point_on_segment is no longer on the segment with feature_id, finds the new nearest segment based on feature_type and existing point_on_segment, and re-derives a new feature_id, point_on_segment, and segment_position, keeping other fields consistent. Fuzzy point special case If the editor does not have side-of-road information for access points or is otherwise unsure of the precise placement of the access point, it may supply the point field (and not point_off_segment) as basic data instead, in which case quality teams may generate the point_off_segment. Identity Access points are considered semantically equivalent if they have the same geometry, including derived fields, and the same references to other features (feature_id, level_feature_id). For the exact definition, see cs/symbol:geostore::AreAccessPointsEquivalent. Field definitions | String |
| segmentPosition | If the access point is defined by a TYPE_SEGMENT feature, this is the location of the access point expressed as a fractional distance along the segment. The value runs from 0 to 1 inclusive. May be re-derived if necessary to maintain precise placement on segment. | GeostoreAccessPointProto | This class holds information about a single access point. An access point establishes a relationship between a feature (like a POI or building) and some other feature. For example, consider a TYPE_LOCALITY feature like Seattle. An access point might be the TYPE_AIRPORT feature for Seattle-Tacoma International Airport. The airport feature defines the access point to gain airplane-based access to Seattle. A feature like Seattle will typically have multiple access points. You can get to Seattle using airplanes, various forms of public transit, or by driving a car. Thus Seattle would have multiple access points. You may be able to get to Seattle by flying into SeaTac, or you might be able to fly into Boeing Field, or Paine Field in Everett. You could drive in from the North/South using I-5, or you could drive in from the East using I-90. Many access points are from the road network. Thus the access point for some building at 123 Main Street would likely be a segment that defines the 100-200 block of “Main Street”. A feature at the corner of “Hollywood” and “Vine” streets might have access points from both named streets. Access points are an optional field. Data editors may ignore them when creating features or editing other fields. In these cases, other quality teams will synthesize and update them. Several fields are also optional, as they are derivable from other fields. Access points to non-TYPE_SEGMENT features should always have the following fields set: – feature_type – feature_id – point Location and reference fields: BASIC vs DERIVABLE Access points to TYPE_SEGMENT features must have all the following BASIC fields: – feature_type (of the segment, e.g. TYPE_ROAD or TYPE_VIRTUAL_SEGMENT) – point_off_segment (or point; see “fuzzy point” note below) – unsuitable_travel_mode (may be empty) – level (indoor access points only) The following are DERIVABLE fields, which should only be added if the supplier is confident about their accuracy: – feature_id – point_on_segment – segment_position Editing clients are encouraged to set all fields, but they may set only the BASIC fields, in which case quality teams may use the BASIC fields to snap to an appropriate segment and derive the remaining fields. Example: The segment is split, so that the portion that the access point is on has a new feature ID. Quality teams notice that the point_on_segment is no longer on the segment with feature_id, finds the new nearest segment based on feature_type and existing point_on_segment, and re-derives a new feature_id, point_on_segment, and segment_position, keeping other fields consistent. Fuzzy point special case If the editor does not have side-of-road information for access points or is otherwise unsure of the precise placement of the access point, it may supply the point field (and not point_off_segment) as basic data instead, in which case quality teams may generate the point_off_segment. Identity Access points are considered semantically equivalent if they have the same geometry, including derived fields, and the same references to other features (feature_id, level_feature_id). For the exact definition, see cs/symbol:geostore::AreAccessPointsEquivalent. Field definitions | number |
| unsuitableTravelMode | This list represents the travel modes for which this access-point should be avoided. If this list is empty, the access-point is suitable for any travel mode. If all access points are unsuitable for the current travel mode, client should revert to other heuristics (e.g. feature center). This is only used for access points to TYPE_SEGMENT features; access points to non-TYPE_SEGMENT features, e.g. TYPE_ESTABLISHMENT_POI features with gcid:transit_station GConcepts are just identified by feature_type and feature_id. | GeostoreAccessPointProto | This class holds information about a single access point. An access point establishes a relationship between a feature (like a POI or building) and some other feature. For example, consider a TYPE_LOCALITY feature like Seattle. An access point might be the TYPE_AIRPORT feature for Seattle-Tacoma International Airport. The airport feature defines the access point to gain airplane-based access to Seattle. A feature like Seattle will typically have multiple access points. You can get to Seattle using airplanes, various forms of public transit, or by driving a car. Thus Seattle would have multiple access points. You may be able to get to Seattle by flying into SeaTac, or you might be able to fly into Boeing Field, or Paine Field in Everett. You could drive in from the North/South using I-5, or you could drive in from the East using I-90. Many access points are from the road network. Thus the access point for some building at 123 Main Street would likely be a segment that defines the 100-200 block of “Main Street”. A feature at the corner of “Hollywood” and “Vine” streets might have access points from both named streets. Access points are an optional field. Data editors may ignore them when creating features or editing other fields. In these cases, other quality teams will synthesize and update them. Several fields are also optional, as they are derivable from other fields. Access points to non-TYPE_SEGMENT features should always have the following fields set: – feature_type – feature_id – point Location and reference fields: BASIC vs DERIVABLE Access points to TYPE_SEGMENT features must have all the following BASIC fields: – feature_type (of the segment, e.g. TYPE_ROAD or TYPE_VIRTUAL_SEGMENT) – point_off_segment (or point; see “fuzzy point” note below) – unsuitable_travel_mode (may be empty) – level (indoor access points only) The following are DERIVABLE fields, which should only be added if the supplier is confident about their accuracy: – feature_id – point_on_segment – segment_position Editing clients are encouraged to set all fields, but they may set only the BASIC fields, in which case quality teams may use the BASIC fields to snap to an appropriate segment and derive the remaining fields. Example: The segment is split, so that the portion that the access point is on has a new feature ID. Quality teams notice that the point_on_segment is no longer on the segment with feature_id, finds the new nearest segment based on feature_type and existing point_on_segment, and re-derives a new feature_id, point_on_segment, and segment_position, keeping other fields consistent. Fuzzy point special case If the editor does not have side-of-road information for access points or is otherwise unsure of the precise placement of the access point, it may supply the point field (and not point_off_segment) as basic data instead, in which case quality teams may generate the point_off_segment. Identity Access points are considered semantically equivalent if they have the same geometry, including derived fields, and the same references to other features (feature_id, level_feature_id). For the exact definition, see cs/symbol:geostore::AreAccessPointsEquivalent. Field definitions | list(String) |
| featureId | The id of the corresponding Feature, if such a feature is defined. As discussed above for feature_type, components of TYPE_FEATURE or TYPE_LANDMARK may have a corresponding feature id. | GeostoreAddressComponentProto | This class represents a parsed field within an address. NOTE: if you add a field to this proto, please update the AreAddressComponentsEquivalent() function in google3/geostore/base/internal/addresscomponent.cc | GeostoreFeatureIdProto |
| featureType | For components of TYPE_FEATURE or TYPE_LANDMARK, this is the feature type (TYPE_COUNTRY, TYPE_LOCALITY, TYPE_ESTABLISHMENT_POI etc.). Note that some features may not actually exist in the geostore (e.g. a village that we’ve never heard of), in which case the feature_id will be missing but the feature_type is still specified. Please refer to IsValidAddressComponentFeatureType() in google3/geostore/base/public/addresscomponent.h for the definitive list of feature types allowed for the type (either TYPE_FEATURE or TYPE_LANDMARK) of components. | GeostoreAddressComponentProto | This class represents a parsed field within an address. NOTE: if you add a field to this proto, please update the AreAddressComponentsEquivalent() function in google3/geostore/base/internal/addresscomponent.cc | integer |
| index | The order of this address component relative to the ones that share the same feature_type in the AddressProto. For now, the primary use of this index field is to handle ordering issue of multiple occurrences of AddressComponentProto with feature_type of TYPE_ROUTE (and subtypes), or TYPE_POLITICAL, where the order of the address components matters as there are dependences. 0 is the smallest valid index value, representing the most specific address component. Index value of 1 represents a relatively less specific address component of the same feature_type on which the 0-indexed address component depends. | GeostoreAddressComponentProto | This class represents a parsed field within an address. NOTE: if you add a field to this proto, please update the AreAddressComponentsEquivalent() function in google3/geostore/base/internal/addresscomponent.cc | integer |
| parsedName | The parsed_name field contains one or more names of an address component. Its actual contents depends on where in the Geo/Google stack you are reading a feature: 1. When an address is initially parsed via a feed or other raw input and structured as an AddressProto, parsed_name should contain the set of names that corresponds to the (possibly normalized) raw text from the raw input. 2. In MapFacts, the address component may be linked to an actual feature via feature_id. Any address formatting directly from MapFacts should follow links to retrieve names when possible. The parsed_name contents may be formatted directly if the address component is unlinked following the same rules as selecting and formatting the name of a feature. The cached parsed_name is regularly refreshed from the linked feature with the minimal set of names for address components (usually just a single, preferred name, in the local language, plus a Latin-script name: go/story-of-ac-names). 3. In serving systems, the names of linked features may be denormalized into the parsed_name field to facilitate quicker address formatting or for simple data filtering (e.g. finding all geocodes in California by name). If reading a feature from such a system, the parsed_name field could contain multiple names in multiple languages that reflect a cached copy of the names associated with the linked features. Formatting of such names should follow the same rules as selecting and formatting the name of a feature itself. | GeostoreAddressComponentProto | This class represents a parsed field within an address. NOTE: if you add a field to this proto, please update the AreAddressComponentsEquivalent() function in google3/geostore/base/internal/addresscomponent.cc | list(GeostoreNameProto) |
| range | Any numerical address component may optionally be specified as a range. For example if a component of TYPE_STREET_NUMBER has the optional “range” attribute, then it represents a range of addresses rather than a single address (see AddressRangeProto for details). | GeostoreAddressComponentProto | This class represents a parsed field within an address. NOTE: if you add a field to this proto, please update the AreAddressComponentsEquivalent() function in google3/geostore/base/internal/addresscomponent.cc | GeostoreAddressRangeProto |
| temporaryData | A place for clients to attach arbitrary data to an address component. Never set in MapFacts. | GeostoreAddressComponentProto | This class represents a parsed field within an address. NOTE: if you add a field to this proto, please update the AreAddressComponentsEquivalent() function in google3/geostore/base/internal/addresscomponent.cc | Proto2BridgeMessageSet |
| textAffix | Additional text to append before and/or after the parsed_name, when the address is formatted. Multiple instance should represent translations. Currently, this is only permitted on TYPE_LANDMARK components, and only one instance is permitted. | GeostoreAddressComponentProto | This class represents a parsed field within an address. NOTE: if you add a field to this proto, please update the AreAddressComponentsEquivalent() function in google3/geostore/base/internal/addresscomponent.cc | list(GeostoreTextAffixProto) |
| type | Every address component has a type. Most address components correspond to one of the feature types defined in FeatureProto, so rather than defining a separate category system here, instead we mark them as TYPE_FEATURE and store the FeatureProto type in the feature_type() field. This is how we handle countries, cities, streets, etc. However, there are a few types of address components that do not have a corresponding feature type (e.g. PO boxes). These components have their type defined here. An address component of TYPE_STREET_NUMBER may correspond to a physical entity that defines a street number, such as a geocoded address or a land parcel. In this case, the address component may have a link to the corresponding feature. A good reference for what types of address components are possible is the xAL standard, which is a published XML schema: http://www.oasis-open.org/committees/ciq/download.shtml. This standard is the basis of the PostalAddress protocol message. | GeostoreAddressComponentProto | This class represents a parsed field within an address. NOTE: if you add a field to this proto, please update the AreAddressComponentsEquivalent() function in google3/geostore/base/internal/addresscomponent.cc | String |
| language | The external form of a Google International Identifiers Initiative (III) LanguageCode object. See google3/i18n/identifiers/languagecode.h for details. We place extra restrictions on languages in addition to what the III library requires. See http://go/geo-schema-reference/feature-properties/languages.md | GeostoreAddressLinesProto | Represents the unparsed portion of an address with an associated language. | String |
| line | These lines are in display order. | GeostoreAddressLinesProto | Represents the unparsed portion of an address with an associated language. | list(String) |
| addressLines | The unparsed portion (lines) of the address. An address can have multiple unparsed portions. Multiple unparsed portions sharing the same language should be modeled as one address_lines instance having multiple lines. Historically, we also supported unparsed portions in different languages, but we no longer do. Consequently, only one value is allowed for this field despite the fact that it is repeated. See go/address-lines-multi-language for information about why we made this change. If any components are filled in, this is supplemental to (i.e. disjoint from) them. Furthermore, this must be the most specific portion of the address (except for the portion, if any, stored in the name field of feature.proto). Unparsed lines are always formatted together in a block. Other address components are never formatted between the address lines. This doesn’t imply that the address lines are always either the first or the last part of the formatted output. | GeostoreAddressProto | This class represents an address, partial address, or address range. It is intended to be attached to features to identify their address(es). Some important points about addresses: – The addresses in the Geo Schema do *not* include a component for the name of the feature, i.e. they are not self-referential. For example, the name of a feature might be “Zack’s Pizza” and its address would be “123 Main Street”. Similarly, streets, cities, and counties do not include themselves as part of their address. The address of “Seattle” is “King County, Washington, USA”. If want to construct an address that *does* include the feature name, you can simply prepend it to the other address components. – Lakes, mountains, and other natural features do not normally have addresses. Countries also do not have addresses because they are at the top of the political hierarchy. – Address components in the Geo Schema are listed in a particular order, independent of the conventions used by the country in which they occur. The basic order is “smallest to largest” starting with street numbers and routes, then political features, and ending with postal features. The exact rules are defined by the implementation of the AddressComponentOrdering::IsLessThan() function. – Some types of address components may occur more than once in an address. For example, a UK address with a “dependent thoroughfare” would have two components of TYPE_ROUTE (i.e. street names). These are listed in the order they are normally written. | list(GeostoreAddressLinesProto) |
| component | A list of parsed address components, e.g. the street, city, etc. An address range is one type of component. | GeostoreAddressProto | This class represents an address, partial address, or address range. It is intended to be attached to features to identify their address(es). Some important points about addresses: – The addresses in the Geo Schema do *not* include a component for the name of the feature, i.e. they are not self-referential. For example, the name of a feature might be “Zack’s Pizza” and its address would be “123 Main Street”. Similarly, streets, cities, and counties do not include themselves as part of their address. The address of “Seattle” is “King County, Washington, USA”. If want to construct an address that *does* include the feature name, you can simply prepend it to the other address components. – Lakes, mountains, and other natural features do not normally have addresses. Countries also do not have addresses because they are at the top of the political hierarchy. – Address components in the Geo Schema are listed in a particular order, independent of the conventions used by the country in which they occur. The basic order is “smallest to largest” starting with street numbers and routes, then political features, and ending with postal features. The exact rules are defined by the implementation of the AddressComponentOrdering::IsLessThan() function. – Some types of address components may occur more than once in an address. For example, a UK address with a “dependent thoroughfare” would have two components of TYPE_ROUTE (i.e. street names). These are listed in the order they are normally written. | list(GeostoreAddressComponentProto) |
| crossStreet | ** DEPRECATED ** This field is now deprecated (see b/33268032). If you want to store cross street information as part of an address, use the address_lines field. | GeostoreAddressProto | This class represents an address, partial address, or address range. It is intended to be attached to features to identify their address(es). Some important points about addresses: – The addresses in the Geo Schema do *not* include a component for the name of the feature, i.e. they are not self-referential. For example, the name of a feature might be “Zack’s Pizza” and its address would be “123 Main Street”. Similarly, streets, cities, and counties do not include themselves as part of their address. The address of “Seattle” is “King County, Washington, USA”. If want to construct an address that *does* include the feature name, you can simply prepend it to the other address components. – Lakes, mountains, and other natural features do not normally have addresses. Countries also do not have addresses because they are at the top of the political hierarchy. – Address components in the Geo Schema are listed in a particular order, independent of the conventions used by the country in which they occur. The basic order is “smallest to largest” starting with street numbers and routes, then political features, and ending with postal features. The exact rules are defined by the implementation of the AddressComponentOrdering::IsLessThan() function. – Some types of address components may occur more than once in an address. For example, a UK address with a “dependent thoroughfare” would have two components of TYPE_ROUTE (i.e. street names). These are listed in the order they are normally written. | list(GeostoreAddressComponentProto) |
| metadata | Field-level metadata for this address. | GeostoreAddressProto | This class represents an address, partial address, or address range. It is intended to be attached to features to identify their address(es). Some important points about addresses: – The addresses in the Geo Schema do *not* include a component for the name of the feature, i.e. they are not self-referential. For example, the name of a feature might be “Zack’s Pizza” and its address would be “123 Main Street”. Similarly, streets, cities, and counties do not include themselves as part of their address. The address of “Seattle” is “King County, Washington, USA”. If want to construct an address that *does* include the feature name, you can simply prepend it to the other address components. – Lakes, mountains, and other natural features do not normally have addresses. Countries also do not have addresses because they are at the top of the political hierarchy. – Address components in the Geo Schema are listed in a particular order, independent of the conventions used by the country in which they occur. The basic order is “smallest to largest” starting with street numbers and routes, then political features, and ending with postal features. The exact rules are defined by the implementation of the AddressComponentOrdering::IsLessThan() function. – Some types of address components may occur more than once in an address. For example, a UK address with a “dependent thoroughfare” would have two components of TYPE_ROUTE (i.e. street names). These are listed in the order they are normally written. | GeostoreFieldMetadataProto |
| partialDenormalization | reserved | GeostoreAddressProto | This class represents an address, partial address, or address range. It is intended to be attached to features to identify their address(es). Some important points about addresses: – The addresses in the Geo Schema do *not* include a component for the name of the feature, i.e. they are not self-referential. For example, the name of a feature might be “Zack’s Pizza” and its address would be “123 Main Street”. Similarly, streets, cities, and counties do not include themselves as part of their address. The address of “Seattle” is “King County, Washington, USA”. If want to construct an address that *does* include the feature name, you can simply prepend it to the other address components. – Lakes, mountains, and other natural features do not normally have addresses. Countries also do not have addresses because they are at the top of the political hierarchy. – Address components in the Geo Schema are listed in a particular order, independent of the conventions used by the country in which they occur. The basic order is “smallest to largest” starting with street numbers and routes, then political features, and ending with postal features. The exact rules are defined by the implementation of the AddressComponentOrdering::IsLessThan() function. – Some types of address components may occur more than once in an address. For example, a UK address with a “dependent thoroughfare” would have two components of TYPE_ROUTE (i.e. street names). These are listed in the order they are normally written. | GeostoreAddressProto |
| templateId | The opaque ID of the address template that contains rules for structuring this address. The id of the address template can be retrieved using google3/geostore/address_templates/public/address_templates.h | GeostoreAddressProto | This class represents an address, partial address, or address range. It is intended to be attached to features to identify their address(es). Some important points about addresses: – The addresses in the Geo Schema do *not* include a component for the name of the feature, i.e. they are not self-referential. For example, the name of a feature might be “Zack’s Pizza” and its address would be “123 Main Street”. Similarly, streets, cities, and counties do not include themselves as part of their address. The address of “Seattle” is “King County, Washington, USA”. If want to construct an address that *does* include the feature name, you can simply prepend it to the other address components. – Lakes, mountains, and other natural features do not normally have addresses. Countries also do not have addresses because they are at the top of the political hierarchy. – Address components in the Geo Schema are listed in a particular order, independent of the conventions used by the country in which they occur. The basic order is “smallest to largest” starting with street numbers and routes, then political features, and ending with postal features. The exact rules are defined by the implementation of the AddressComponentOrdering::IsLessThan() function. – Some types of address components may occur more than once in an address. For example, a UK address with a “dependent thoroughfare” would have two components of TYPE_ROUTE (i.e. street names). These are listed in the order they are normally written. | String |
| temporaryData | A place for clients to attach arbitrary data to an address. Never set in MapFacts. | GeostoreAddressProto | This class represents an address, partial address, or address range. It is intended to be attached to features to identify their address(es). Some important points about addresses: – The addresses in the Geo Schema do *not* include a component for the name of the feature, i.e. they are not self-referential. For example, the name of a feature might be “Zack’s Pizza” and its address would be “123 Main Street”. Similarly, streets, cities, and counties do not include themselves as part of their address. The address of “Seattle” is “King County, Washington, USA”. If want to construct an address that *does* include the feature name, you can simply prepend it to the other address components. – Lakes, mountains, and other natural features do not normally have addresses. Countries also do not have addresses because they are at the top of the political hierarchy. – Address components in the Geo Schema are listed in a particular order, independent of the conventions used by the country in which they occur. The basic order is “smallest to largest” starting with street numbers and routes, then political features, and ending with postal features. The exact rules are defined by the implementation of the AddressComponentOrdering::IsLessThan() function. – Some types of address components may occur more than once in an address. For example, a UK address with a “dependent thoroughfare” would have two components of TYPE_ROUTE (i.e. street names). These are listed in the order they are normally written. | Proto2BridgeMessageSet |
| number | Two or more address numbers. Each number represents an address that was mentioned by the data provider. | GeostoreAddressRangeProto | This class represents a range of numbers in an address. It is an optional additional field in the ‘AddressComponentProto’ message. This structure can be used to model both single addresses and address ranges. There are two primary use-cases for address ranges: definitions and references. Ranges are being defined when they are present on the addresses of segment features. Ranges are being referenced when they are present on non-segment features. NOTE: If you add fields in this proto, consider updating the AreAddressRangesEquivalent() function in google3/geostore/base/internal/addressrange.cc | list(integer) |
| parameter | For address range definitions: Two or more interpolation parameter values. The length of this array must match the length of the number array, and each parameter number specifies the position of the corresponding address number. Each value is an interpolation between 0.0 and 1.0 inclusive. The value is proportional to the distance traveled along the segment’s polyline starting at its origin. The parameters must be provided in increasing order and the values in the number array must be in strictly increasing or decreasing order. We make an exception for singleton addresses, which are represented as two copies of a (number, parameter) pair, for backwards compatibility. For address range references: This array must be empty. | GeostoreAddressRangeProto | This class represents a range of numbers in an address. It is an optional additional field in the ‘AddressComponentProto’ message. This structure can be used to model both single addresses and address ranges. There are two primary use-cases for address ranges: definitions and references. Ranges are being defined when they are present on the addresses of segment features. Ranges are being referenced when they are present on non-segment features. NOTE: If you add fields in this proto, consider updating the AreAddressRangesEquivalent() function in google3/geostore/base/internal/addressrange.cc | list(number) |
| prefix | If specified, the prefix or suffix is applied to all numbers in the range. For example, this can be used to indicate that addresses B1 through B99 are on one side of the street, while A1 through A99 are on the other side of the street. | GeostoreAddressRangeProto | This class represents a range of numbers in an address. It is an optional additional field in the ‘AddressComponentProto’ message. This structure can be used to model both single addresses and address ranges. There are two primary use-cases for address ranges: definitions and references. Ranges are being defined when they are present on the addresses of segment features. Ranges are being referenced when they are present on non-segment features. NOTE: If you add fields in this proto, consider updating the AreAddressRangesEquivalent() function in google3/geostore/base/internal/addressrange.cc | String |
| sameParity | If ‘same_parity’ is true, then all ‘number’ values must have the same parity (even or odd), and this address range only includes addresses whose parity is the same as the given ‘number’ values. | GeostoreAddressRangeProto | This class represents a range of numbers in an address. It is an optional additional field in the ‘AddressComponentProto’ message. This structure can be used to model both single addresses and address ranges. There are two primary use-cases for address ranges: definitions and references. Ranges are being defined when they are present on the addresses of segment features. Ranges are being referenced when they are present on non-segment features. NOTE: If you add fields in this proto, consider updating the AreAddressRangesEquivalent() function in google3/geostore/base/internal/addressrange.cc | boolean |
| suffix | GeostoreAddressRangeProto | This class represents a range of numbers in an address. It is an optional additional field in the ‘AddressComponentProto’ message. This structure can be used to model both single addresses and address ranges. There are two primary use-cases for address ranges: definitions and references. Ranges are being defined when they are present on the addresses of segment features. Ranges are being referenced when they are present on non-segment features. NOTE: If you add fields in this proto, consider updating the AreAddressRangesEquivalent() function in google3/geostore/base/internal/addressrange.cc | String | |
| temporaryData | A place for clients to attach arbitrary data to an address range. Never set in MapFacts. Here are some examples: Example #1: Single non-numeric address (e.g., “Twelve”) At the moment this can only be represented as a street number (with the value in the parsed_name field of the AddressComponentProto). We have future plans to make other changes so we can handle this case. Example #2: Single semi-numeric address (e.g., “12bis”) The number array contains two copies of the single numeric value (12). The prefix is empty and the suffix contains “bis”. The parameter array has two identical values specifying the position of the single address. Example #3: Simple address range (e.g., “100 to 198, even numbers only”) The number array contains the two values “100” and “198”. The prefix and suffix strings are empty in this example. The parameter array has two values, one for each number. The same_parity flag is set in this example. | GeostoreAddressRangeProto | This class represents a range of numbers in an address. It is an optional additional field in the ‘AddressComponentProto’ message. This structure can be used to model both single addresses and address ranges. There are two primary use-cases for address ranges: definitions and references. Ranges are being defined when they are present on the addresses of segment features. Ranges are being referenced when they are present on non-segment features. NOTE: If you add fields in this proto, consider updating the AreAddressRangesEquivalent() function in google3/geostore/base/internal/addressrange.cc | Proto2BridgeMessageSet |
| geometryId | The ID to be used to fetch the feature’s geometry from the 3D Geometry Store. | GeostoreAnchoredGeometryProto | A feature’s geometry that is populated from the 3D Geometry Store. Please see go/a3d-and-mapfacts for design details. | String |
| speedLimit | The actual speed limit value. | GeostoreAppliedSpeedLimitProto | A container for speed limits that allows tagging with a correctness trust level. | GeostoreSpeedLimitProto |
| trustLevel | The level of trust we have in this speed limit value. | GeostoreAppliedSpeedLimitProto | A container for speed limits that allows tagging with a correctness trust level. | String |
| attachmentId | attachment_id distinguishes messages of the same type_id associated with the same feature. It can not be set to 0x0. | GeostoreAttachmentsAttachmentProto | An AttachmentProto contains structured data of a client-specified type. An attachment is uniquely identified by the combination of its attachment_id and client_name_space fields. | String |
| clientNameSpace | This field specifies a namespace identifier that can be used to track the sources of attachments in a human friendly format. Name spaces must be at most 64 characters long and must be composed entirely of alphanumeric characters, hyphens, and underscores. No other characters are allowed. | GeostoreAttachmentsAttachmentProto | An AttachmentProto contains structured data of a client-specified type. An attachment is uniquely identified by the combination of its attachment_id and client_name_space fields. | String |
| comment | comment is a human-readable string that is logged whenever this attachment is processed by the framework. | GeostoreAttachmentsAttachmentProto | An AttachmentProto contains structured data of a client-specified type. An attachment is uniquely identified by the combination of its attachment_id and client_name_space fields. | String |
| messages | messages contains the structured data for this attachment. It should contain a single message with a type ID matching the value of the type_id field below. | GeostoreAttachmentsAttachmentProto | An AttachmentProto contains structured data of a client-specified type. An attachment is uniquely identified by the combination of its attachment_id and client_name_space fields. | Proto2BridgeMessageSet |
| typeId | type_id determines the type of the actual attachment that should be set in the messages MessageSet. It can not be set to 0x0. | GeostoreAttachmentsAttachmentProto | An AttachmentProto contains structured data of a client-specified type. An attachment is uniquely identified by the combination of its attachment_id and client_name_space fields. | String |
| id | The id of the attribute. Stored as a stripped format of the gcid (e.g. “foo” instead of “gcid:att_foo”). | GeostoreAttributeIdProto | Used to represent the unique id of an attribute. | String |
| providerId | Set because it’s required, but not really meaningful in geostore (always set to “Geo”). | GeostoreAttributeIdProto | Used to represent the unique id of an attribute. | String |
| type | GeostoreAttributeIdProto | Used to represent the unique id of an attribute. | String | |
| applicationData | GeostoreAttributeProto | Protocol buffer for attaching attributes and values to instances. This is for assigning a particular attribute and value to a repository item, not for metadata. For protocol buffers that represents metadata about attributes and values, see CanonicalAttribute in itemclass.proto and ValueSpace in valuespace.proto. | Proto2BridgeMessageSet | |
| attributeDisplay | GeostoreAttributeProto | Protocol buffer for attaching attributes and values to instances. This is for assigning a particular attribute and value to a repository item, not for metadata. For protocol buffers that represents metadata about attributes and values, see CanonicalAttribute in itemclass.proto and ValueSpace in valuespace.proto. | list(GeostoreAttributeValueDisplayProto) | |
| booleanValue | GeostoreAttributeProto | Protocol buffer for attaching attributes and values to instances. This is for assigning a particular attribute and value to a repository item, not for metadata. For protocol buffers that represents metadata about attributes and values, see CanonicalAttribute in itemclass.proto and ValueSpace in valuespace.proto. | boolean | |
| canonicalAttributeId | The canonical attribute for this attribute instance. | GeostoreAttributeProto | Protocol buffer for attaching attributes and values to instances. This is for assigning a particular attribute and value to a repository item, not for metadata. For protocol buffers that represents metadata about attributes and values, see CanonicalAttribute in itemclass.proto and ValueSpace in valuespace.proto. | GeostoreAttributeIdProto |
| doubleValue | GeostoreAttributeProto | Protocol buffer for attaching attributes and values to instances. This is for assigning a particular attribute and value to a repository item, not for metadata. For protocol buffers that represents metadata about attributes and values, see CanonicalAttribute in itemclass.proto and ValueSpace in valuespace.proto. | float | |
| enumIdValue | For those attribute ids that expect their values to be taken from an enumeration-style set of values, that value’s gcid should be stored here, e.g. “gcid:attval_yes”. | GeostoreAttributeProto | Protocol buffer for attaching attributes and values to instances. This is for assigning a particular attribute and value to a repository item, not for metadata. For protocol buffers that represents metadata about attributes and values, see CanonicalAttribute in itemclass.proto and ValueSpace in valuespace.proto. | String |
| floatValue | GeostoreAttributeProto | Protocol buffer for attaching attributes and values to instances. This is for assigning a particular attribute and value to a repository item, not for metadata. For protocol buffers that represents metadata about attributes and values, see CanonicalAttribute in itemclass.proto and ValueSpace in valuespace.proto. | number | |
| int64Value | GeostoreAttributeProto | Protocol buffer for attaching attributes and values to instances. This is for assigning a particular attribute and value to a repository item, not for metadata. For protocol buffers that represents metadata about attributes and values, see CanonicalAttribute in itemclass.proto and ValueSpace in valuespace.proto. | String | |
| integerValue | GeostoreAttributeProto | Protocol buffer for attaching attributes and values to instances. This is for assigning a particular attribute and value to a repository item, not for metadata. For protocol buffers that represents metadata about attributes and values, see CanonicalAttribute in itemclass.proto and ValueSpace in valuespace.proto. | integer | |
| itemClassId | GeostoreAttributeProto | Protocol buffer for attaching attributes and values to instances. This is for assigning a particular attribute and value to a repository item, not for metadata. For protocol buffers that represents metadata about attributes and values, see CanonicalAttribute in itemclass.proto and ValueSpace in valuespace.proto. | GeostoreAttributeIdProto | |
| metadata | Field-level metadata for this attribute | GeostoreAttributeProto | Protocol buffer for attaching attributes and values to instances. This is for assigning a particular attribute and value to a repository item, not for metadata. For protocol buffers that represents metadata about attributes and values, see CanonicalAttribute in itemclass.proto and ValueSpace in valuespace.proto. | GeostoreFieldMetadataProto |
| protoValue | Fully qualified package name because genprotohdf uses genproto for this proto2 syntax: https://wiki.corp.google.com/twiki/bin/view/Main/Proto2WithGenproto | GeostoreAttributeProto | Protocol buffer for attaching attributes and values to instances. This is for assigning a particular attribute and value to a repository item, not for metadata. For protocol buffers that represents metadata about attributes and values, see CanonicalAttribute in itemclass.proto and ValueSpace in valuespace.proto. | Proto2BridgeMessageSet |
| stringValue | The attribute value falls into one of these fields, based on value_type: | GeostoreAttributeProto | Protocol buffer for attaching attributes and values to instances. This is for assigning a particular attribute and value to a repository item, not for metadata. For protocol buffers that represents metadata about attributes and values, see CanonicalAttribute in itemclass.proto and ValueSpace in valuespace.proto. | String |
| uint32Value | GeostoreAttributeProto | Protocol buffer for attaching attributes and values to instances. This is for assigning a particular attribute and value to a repository item, not for metadata. For protocol buffers that represents metadata about attributes and values, see CanonicalAttribute in itemclass.proto and ValueSpace in valuespace.proto. | integer | |
| valueDisplay | Used to store language-specific names of this attribute’s value (e.g. a translation into another language). | GeostoreAttributeProto | Protocol buffer for attaching attributes and values to instances. This is for assigning a particular attribute and value to a repository item, not for metadata. For protocol buffers that represents metadata about attributes and values, see CanonicalAttribute in itemclass.proto and ValueSpace in valuespace.proto. | list(GeostoreAttributeValueDisplayProto) |
| valueSpaceId | GeostoreAttributeProto | Protocol buffer for attaching attributes and values to instances. This is for assigning a particular attribute and value to a repository item, not for metadata. For protocol buffers that represents metadata about attributes and values, see CanonicalAttribute in itemclass.proto and ValueSpace in valuespace.proto. | GeostoreAttributeIdProto | |
| valueType | GeostoreAttributeProto | Protocol buffer for attaching attributes and values to instances. This is for assigning a particular attribute and value to a repository item, not for metadata. For protocol buffers that represents metadata about attributes and values, see CanonicalAttribute in itemclass.proto and ValueSpace in valuespace.proto. | String | |
| language | GeostoreAttributeValueDisplayProto | Used to help display language-specific names of attributes. | String | |
| synonym | GeostoreAttributeValueDisplayProto | Used to help display language-specific names of attributes. | String | |
| material | GeostoreBarrierLogicalMaterialProto | list(String) | ||
| locale | The ID of the best-match TYPE_LOCALE feature for this feature. | GeostoreBestLocaleProto | A BestLocaleProto holds information about the best-match locale for a feature. Clients may use this information to determine the appropriate local name of a feature. | GeostoreFeatureIdProto |
| localizationPolicyId | The ID of the localization policy to apply when selecting a name for a feature. This field should always be set. If feature_id is also defined, this field should have the same localization policy ID as the referenced locale feature. Localization policy IDs are arbitrary identifiers (up to some number of bytes; see geostore/base/public/constants.h) that uniquely distinguish a set of language-selection rules. | GeostoreBestLocaleProto | A BestLocaleProto holds information about the best-match locale for a feature. Clients may use this information to determine the appropriate local name of a feature. | String |
| metadata | Field-level metadata for this best locale. | GeostoreBestLocaleProto | A BestLocaleProto holds information about the best-match locale for a feature. Clients may use this information to determine the appropriate local name of a feature. | GeostoreFieldMetadataProto |
| id | Listing id. Used in queries to BizBuilder backend for listing access. | GeostoreBizBuilderReferenceProto | The reference to a BizBuilder listing. For details on BizBuilder see http://g3doc/commerce/bizbuilder/backend/g3doc/index.md | String |
| featureIdLeft | The ids of the area features to the left and right of the border, relative to the start and end of this borders’ polyline geometry. These features should have the same type as the “type” attribute above. These ids are not required because the corresponding features may be nonexistent or difficult to obtain. | GeostoreBorderProto | A border represents a line of division between two features of the same type (i.e. United States and Mexico, but not California and Mexico). Borders are only used for features that tile an area. For example, country features have borders with one another because they tile an area of land. Country features do not have borders with province features because those two types of features may intersect with each other. The geometry of a border will often be similar (or derived from) the geometry of the two features that it separates. However, it is useful to have borders represented by stand-alone features for map-styling purposes. Ideally, the geometry in a border feature would be exactly the same as the common edges of the polygonal geometry of the two features. This may not always be true in practice. At some point in the future we would like to build a network of borders for features that are supposed to tile with each other. The network would be composed of different border types meeting at endpoint intersections. In the process of building this network, we would perform small geometry corrections to ensure that the borders align properly at all zoom levels. Border features are intended primarily for map drawing, and they would rarely be useful for geocoding. One exception would be for famous borders like the “Mason Dixon Line” or the “Berlin Wall.” The standard feature properties have the following interpretations: name – Borders rarely have names unless they notable in their own right (e.g. “Mason Dixon Line”, “Berlin Wall”). point – A border should not have point geometry. polyline – A border should have a single polyline that represents the division between the two features. polygon – A border should not have polygon geometry. | GeostoreFeatureIdProto |
| featureIdRight | GeostoreBorderProto | A border represents a line of division between two features of the same type (i.e. United States and Mexico, but not California and Mexico). Borders are only used for features that tile an area. For example, country features have borders with one another because they tile an area of land. Country features do not have borders with province features because those two types of features may intersect with each other. The geometry of a border will often be similar (or derived from) the geometry of the two features that it separates. However, it is useful to have borders represented by stand-alone features for map-styling purposes. Ideally, the geometry in a border feature would be exactly the same as the common edges of the polygonal geometry of the two features. This may not always be true in practice. At some point in the future we would like to build a network of borders for features that are supposed to tile with each other. The network would be composed of different border types meeting at endpoint intersections. In the process of building this network, we would perform small geometry corrections to ensure that the borders align properly at all zoom levels. Border features are intended primarily for map drawing, and they would rarely be useful for geocoding. One exception would be for famous borders like the “Mason Dixon Line” or the “Berlin Wall.” The standard feature properties have the following interpretations: name – Borders rarely have names unless they notable in their own right (e.g. “Mason Dixon Line”, “Berlin Wall”). point – A border should not have point geometry. polyline – A border should have a single polyline that represents the division between the two features. polygon – A border should not have polygon geometry. | GeostoreFeatureIdProto | |
| logicalBorder | The logical borders which this border is a part of. | GeostoreBorderProto | A border represents a line of division between two features of the same type (i.e. United States and Mexico, but not California and Mexico). Borders are only used for features that tile an area. For example, country features have borders with one another because they tile an area of land. Country features do not have borders with province features because those two types of features may intersect with each other. The geometry of a border will often be similar (or derived from) the geometry of the two features that it separates. However, it is useful to have borders represented by stand-alone features for map-styling purposes. Ideally, the geometry in a border feature would be exactly the same as the common edges of the polygonal geometry of the two features. This may not always be true in practice. At some point in the future we would like to build a network of borders for features that are supposed to tile with each other. The network would be composed of different border types meeting at endpoint intersections. In the process of building this network, we would perform small geometry corrections to ensure that the borders align properly at all zoom levels. Border features are intended primarily for map drawing, and they would rarely be useful for geocoding. One exception would be for famous borders like the “Mason Dixon Line” or the “Berlin Wall.” The standard feature properties have the following interpretations: name – Borders rarely have names unless they notable in their own right (e.g. “Mason Dixon Line”, “Berlin Wall”). point – A border should not have point geometry. polyline – A border should have a single polyline that represents the division between the two features. polygon – A border should not have polygon geometry. | list(GeostoreFeatureIdProto) |
| overrideStatus | List of border status overrides. Due to legal reasons, we may be required to display some borders differently on some domains for instance. | GeostoreBorderProto | A border represents a line of division between two features of the same type (i.e. United States and Mexico, but not California and Mexico). Borders are only used for features that tile an area. For example, country features have borders with one another because they tile an area of land. Country features do not have borders with province features because those two types of features may intersect with each other. The geometry of a border will often be similar (or derived from) the geometry of the two features that it separates. However, it is useful to have borders represented by stand-alone features for map-styling purposes. Ideally, the geometry in a border feature would be exactly the same as the common edges of the polygonal geometry of the two features. This may not always be true in practice. At some point in the future we would like to build a network of borders for features that are supposed to tile with each other. The network would be composed of different border types meeting at endpoint intersections. In the process of building this network, we would perform small geometry corrections to ensure that the borders align properly at all zoom levels. Border features are intended primarily for map drawing, and they would rarely be useful for geocoding. One exception would be for famous borders like the “Mason Dixon Line” or the “Berlin Wall.” The standard feature properties have the following interpretations: name – Borders rarely have names unless they notable in their own right (e.g. “Mason Dixon Line”, “Berlin Wall”). point – A border should not have point geometry. polyline – A border should have a single polyline that represents the division between the two features. polygon – A border should not have polygon geometry. | list(GeostoreOverrideBorderStatusProto) |
| status | The border status identifies the legal status of the border line. | GeostoreBorderProto | A border represents a line of division between two features of the same type (i.e. United States and Mexico, but not California and Mexico). Borders are only used for features that tile an area. For example, country features have borders with one another because they tile an area of land. Country features do not have borders with province features because those two types of features may intersect with each other. The geometry of a border will often be similar (or derived from) the geometry of the two features that it separates. However, it is useful to have borders represented by stand-alone features for map-styling purposes. Ideally, the geometry in a border feature would be exactly the same as the common edges of the polygonal geometry of the two features. This may not always be true in practice. At some point in the future we would like to build a network of borders for features that are supposed to tile with each other. The network would be composed of different border types meeting at endpoint intersections. In the process of building this network, we would perform small geometry corrections to ensure that the borders align properly at all zoom levels. Border features are intended primarily for map drawing, and they would rarely be useful for geocoding. One exception would be for famous borders like the “Mason Dixon Line” or the “Berlin Wall.” The standard feature properties have the following interpretations: name – Borders rarely have names unless they notable in their own right (e.g. “Mason Dixon Line”, “Berlin Wall”). point – A border should not have point geometry. polyline – A border should have a single polyline that represents the division between the two features. polygon – A border should not have polygon geometry. | String |
| type | The type of the features this border separates. Should always be a subtype of TYPE_POLITICAL. NOTE: as of December 2019, we currently require this to be equal to TYPE_COUNTRY or TYPE_ADMINISTRATIVE_AREA1. In the future, we may support TYPE_BORDER for lower types of political features. | GeostoreBorderProto | A border represents a line of division between two features of the same type (i.e. United States and Mexico, but not California and Mexico). Borders are only used for features that tile an area. For example, country features have borders with one another because they tile an area of land. Country features do not have borders with province features because those two types of features may intersect with each other. The geometry of a border will often be similar (or derived from) the geometry of the two features that it separates. However, it is useful to have borders represented by stand-alone features for map-styling purposes. Ideally, the geometry in a border feature would be exactly the same as the common edges of the polygonal geometry of the two features. This may not always be true in practice. At some point in the future we would like to build a network of borders for features that are supposed to tile with each other. The network would be composed of different border types meeting at endpoint intersections. In the process of building this network, we would perform small geometry corrections to ensure that the borders align properly at all zoom levels. Border features are intended primarily for map drawing, and they would rarely be useful for geocoding. One exception would be for famous borders like the “Mason Dixon Line” or the “Berlin Wall.” The standard feature properties have the following interpretations: name – Borders rarely have names unless they notable in their own right (e.g. “Mason Dixon Line”, “Berlin Wall”). point – A border should not have point geometry. polyline – A border should have a single polyline that represents the division between the two features. polygon – A border should not have polygon geometry. | integer |
| boundingMarker | References to any gcid:physical_lane_marker features that bound this lane or lane connection. | GeostoreBoundingMarkerProto | NOTE: BoundingMarkerProto could be compared against one another by canonicalizing them via GetCanonicalBoundingMarker() in google3/geostore/base/internal/lane.cc. Any fields that don’t contribute to the definition of a bounding marker in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalBoundingMarker(). LINT.IfChange | GeostoreFeatureIdProto |
| boundingMarkerToken | A token that can be used to identify the version of the data about this bounding marker. | GeostoreBoundingMarkerProto | NOTE: BoundingMarkerProto could be compared against one another by canonicalizing them via GetCanonicalBoundingMarker() in google3/geostore/base/internal/lane.cc. Any fields that don’t contribute to the definition of a bounding marker in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalBoundingMarker(). LINT.IfChange | String |
| flowlineAdjacencyBeginFraction | Which part of the flowline does this association refer to? These should be between 0 and 1. These are optionally set, but can be approximated geometrically if they aren’t set. NOTE: These refer to the geometry of this feature. | GeostoreBoundingMarkerProto | NOTE: BoundingMarkerProto could be compared against one another by canonicalizing them via GetCanonicalBoundingMarker() in google3/geostore/base/internal/lane.cc. Any fields that don’t contribute to the definition of a bounding marker in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalBoundingMarker(). LINT.IfChange | float |
| flowlineAdjacencyEndFraction | GeostoreBoundingMarkerProto | NOTE: BoundingMarkerProto could be compared against one another by canonicalizing them via GetCanonicalBoundingMarker() in google3/geostore/base/internal/lane.cc. Any fields that don’t contribute to the definition of a bounding marker in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalBoundingMarker(). LINT.IfChange | float | |
| markerAdjacencyBeginFraction | Which part of the marker track does this association refer to? These should be between 0 and 1. These are optionally set, but can be approximated geometrically if they aren’t set. NOTE: These refer to the geometry of the marker feature. | GeostoreBoundingMarkerProto | NOTE: BoundingMarkerProto could be compared against one another by canonicalizing them via GetCanonicalBoundingMarker() in google3/geostore/base/internal/lane.cc. Any fields that don’t contribute to the definition of a bounding marker in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalBoundingMarker(). LINT.IfChange | float |
| markerAdjacencyEndFraction | GeostoreBoundingMarkerProto | NOTE: BoundingMarkerProto could be compared against one another by canonicalizing them via GetCanonicalBoundingMarker() in google3/geostore/base/internal/lane.cc. Any fields that don’t contribute to the definition of a bounding marker in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalBoundingMarker(). LINT.IfChange | float | |
| side | Which side of the flowline does the marker occur on. | GeostoreBoundingMarkerProto | NOTE: BoundingMarkerProto could be compared against one another by canonicalizing them via GetCanonicalBoundingMarker() in google3/geostore/base/internal/lane.cc. Any fields that don’t contribute to the definition of a bounding marker in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalBoundingMarker(). LINT.IfChange | String |
| baseHeightMetersAgl | The height of the base of this building, in meters above ground-level, if known. | GeostoreBuildingProto | This protocol buffer holds the building-specific attributes for features of type TYPE_COMPOUND_BUILDING. | number |
| defaultDisplayLevel | The level in this building that should get displayed by default. If present, the default display level must be one of this building’s levels that are listed in the level[] field, and if a level is set as a default level of one building, all buildings sharing the level should have that same level as their default level. If not present, clients should not display any level by default for that building. | GeostoreBuildingProto | This protocol buffer holds the building-specific attributes for features of type TYPE_COMPOUND_BUILDING. | GeostoreFeatureIdProto |
| floors | The number of floors above the base of the building, if known. For example a regular 1-story building would set this to “1”. Use a value of GeostoreConstants::kDefaultHeightPerFloor when converting “floors” to “height_meters”. | GeostoreBuildingProto | This protocol buffer holds the building-specific attributes for features of type TYPE_COMPOUND_BUILDING. | integer |
| floorsMetadata | GeostoreBuildingProto | This protocol buffer holds the building-specific attributes for features of type TYPE_COMPOUND_BUILDING. | GeostoreFieldMetadataProto | |
| heightMeters | The height of the building above its base, in meters, if known. | GeostoreBuildingProto | This protocol buffer holds the building-specific attributes for features of type TYPE_COMPOUND_BUILDING. | number |
| heightMetersMetadata | GeostoreBuildingProto | This protocol buffer holds the building-specific attributes for features of type TYPE_COMPOUND_BUILDING. | GeostoreFieldMetadataProto | |
| level | The levels in this building, in no particular order. These levels refer back to the building via another strong reference (the LevelProto.building field). | GeostoreBuildingProto | This protocol buffer holds the building-specific attributes for features of type TYPE_COMPOUND_BUILDING. | list(GeostoreFeatureIdProto) |
| structure | “Structure” denotes a physical architecture of the building that is readily visible. This attribute is useful in that rarer structures can make good landmarks. | GeostoreBuildingProto | This protocol buffer holds the building-specific attributes for features of type TYPE_COMPOUND_BUILDING. | String |
| canonicalGconcepts | Canonical GConcepts describe the ideal state of the GConcepts of this business chain’s members. | GeostoreBusinessChainProto | This holds data specific to business chain features. | list(GeostoreCanonicalGConceptProto) |
| data | The actual hours represented by this BusinessHoursProto. | GeostoreBusinessHoursProto | A BusinessHoursProto stores a weekly schedule of opening hours for a business (represented as a BusinessHours message) together with other closely related information that is Geo-specific. | BusinessHours |
| metadata | Field-level metadata for these hours. | GeostoreBusinessHoursProto | A BusinessHoursProto stores a weekly schedule of opening hours for a business (represented as a BusinessHours message) together with other closely related information that is Geo-specific. | GeostoreFieldMetadataProto |
| ctaType | Required. | GeostoreCallToActionProto | Message containing calls to action specified by the business owner. | String |
| url | GeostoreCallToActionProto | Message containing calls to action specified by the business owner. | GeostoreUrlProto | |
| gconcept | GeostoreCanonicalGConceptProto | This proto represents a canonical gconcept of a business chain’s members. | GeostoreGConceptInstanceProto | |
| isRequired | Whether the gconcept must be on a member. This must be true for a primary gconcept. | GeostoreCanonicalGConceptProto | This proto represents a canonical gconcept of a business chain’s members. | boolean |
| cellId | Array of S2 cell ids that represent the covering. There is no preset limit on how many cells can be used. | GeostoreCellCoveringProto | This protocol buffer holds S2 cell covering for the feature. See util/geometry/s2cell_union.h for more information on S2 cells. See geostore/base/public/cellcovering.h for utility functions. | list(String) |
| appearance | Additional information that can be used to describe the appearance of CityObjects in this CityJsonProto. | GeostoreCityJsonProto | CityJsonProto is a custom proto representation of the portion of the CityJSON spec (https://www.cityjson.org/) relevant to internal projects. See go/cityjsonproto-design for more information about the modeling and design decisions implemented here. LINT.IfChange | GeostoreCityJsonProtoAppearance |
| cityObjects | City objects associated with this CityJsonProto. | GeostoreCityJsonProto | CityJsonProto is a custom proto representation of the portion of the CityJSON spec (https://www.cityjson.org/) relevant to internal projects. See go/cityjsonproto-design for more information about the modeling and design decisions implemented here. LINT.IfChange | list(GeostoreCityJsonProtoCityObject) |
| flattenedVertices | Vertices as local coordinates represented as a flattened list: [x1,y1,z1,x2,y2,z2,x3,y3,z3]. Vertices are relative to a local coordinate system and rounded to their nearest integer value. See `transform` for how vertices can be transformed from a local coordinate system into an Earth-centered, Earth-fixed coordinate system. Vertices are flattened for space efficiency, memory locality, and processing performance. To access the x,y,z coordinates of vertex N, read the values at indices 3N, 3N+1, and 3N+2. | GeostoreCityJsonProto | CityJsonProto is a custom proto representation of the portion of the CityJSON spec (https://www.cityjson.org/) relevant to internal projects. See go/cityjsonproto-design for more information about the modeling and design decisions implemented here. LINT.IfChange | list(integer) |
| transform | Spec for converting vertices from a local coordinate system in arbitrary units to ECEF coordinates in meters (https://en.wikipedia.org/wiki/Earth-centered,_Earth-fixed_coordinate_system). | GeostoreCityJsonProto | CityJsonProto is a custom proto representation of the portion of the CityJSON spec (https://www.cityjson.org/) relevant to internal projects. See go/cityjsonproto-design for more information about the modeling and design decisions implemented here. LINT.IfChange | GeostoreCityJsonProtoTransform |
| materials | Predefined materials that may be referenced from geometric primitives. | GeostoreCityJsonProtoAppearance | Contains additional ways to describe the appearance of a CityObject, e.g. definitions of materials and textures that can apply to geometry surfaces. | list(GeostoreCityJsonProtoAppearanceMaterial) |
| diffuseColor | The color that this material shows under pure white light when incoming light is reflected in all directions equally. | GeostoreCityJsonProtoAppearanceMaterial | Representation of a single material that can describe a geometry surface. See technical definitions of these fields via the description and link at https://www.cityjson.org/specs/2.0.0/#material-object. | GeostoreCityJsonProtoAppearanceMaterialRgbColor |
| isNull | is_null=true is used to represent ‘null’ material references. There may only be one is_null=true Material per CityJsonProto, and it must not have any other fields set. | GeostoreCityJsonProtoAppearanceMaterial | Representation of a single material that can describe a geometry surface. See technical definitions of these fields via the description and link at https://www.cityjson.org/specs/2.0.0/#material-object. | boolean |
| isSmooth | Whether this material has an even, regular surface or consistency. | GeostoreCityJsonProtoAppearanceMaterial | Representation of a single material that can describe a geometry surface. See technical definitions of these fields via the description and link at https://www.cityjson.org/specs/2.0.0/#material-object. | boolean |
| name | The name of this material. | GeostoreCityJsonProtoAppearanceMaterial | Representation of a single material that can describe a geometry surface. See technical definitions of these fields via the description and link at https://www.cityjson.org/specs/2.0.0/#material-object. | String |
| shininess | The degree to which this material reflects light; value is [0,1]. | GeostoreCityJsonProtoAppearanceMaterial | Representation of a single material that can describe a geometry surface. See technical definitions of these fields via the description and link at https://www.cityjson.org/specs/2.0.0/#material-object. | number |
| transparency | The degree to which this material allows light through; value is [0,1], with 1.0 being completely transparent. | GeostoreCityJsonProtoAppearanceMaterial | Representation of a single material that can describe a geometry surface. See technical definitions of these fields via the description and link at https://www.cityjson.org/specs/2.0.0/#material-object. | number |
| blue | GeostoreCityJsonProtoAppearanceMaterialRgbColor | RGB 0-1, where the range of each value is [0,1] instead of [0,255]. Values may be linear RGB or sRGB; RGB values are frequently stored as sRGB (https://stackoverflow.com/a/12894053 explains the difference). | number | |
| green | GeostoreCityJsonProtoAppearanceMaterialRgbColor | RGB 0-1, where the range of each value is [0,1] instead of [0,255]. Values may be linear RGB or sRGB; RGB values are frequently stored as sRGB (https://stackoverflow.com/a/12894053 explains the difference). | number | |
| red | GeostoreCityJsonProtoAppearanceMaterialRgbColor | RGB 0-1, where the range of each value is [0,1] instead of [0,255]. Values may be linear RGB or sRGB; RGB values are frequently stored as sRGB (https://stackoverflow.com/a/12894053 explains the difference). | number | |
| geometries | Geometries associated with this object. | GeostoreCityJsonProtoCityObject | Representation of an object with geometry. | list(GeostoreCityJsonProtoCityObjectGeometry) |
| id | The ID of this CityObject, which must be unique within this CityJsonProto. The ID does not have a meaning outside this CityJsonProto. | GeostoreCityJsonProtoCityObject | Representation of an object with geometry. | String |
| type | Type of object represented, e.g. building. | GeostoreCityJsonProtoCityObject | Representation of an object with geometry. | String |
| lod | Level-of-detail (LoD) indicates how intricate the geometric representation is. May be a single digit per CityGML standards or X.Y per TU Delft (visual depiction at https://3d.bk.tudelft.nl/lod/). `CityObject`s may have multiple geometries with the same LoD. | GeostoreCityJsonProtoCityObjectGeometry | Representation of geometry including geometric primitives which are used as building blocks to construct geometries of varying complexity. Geometries vary both in type and in level-of-detail, enabling representation of any shape at any level of granularity. All geometries are ultimately composed of `MultiPoint`s, which reference the actual vertices. Only linear and planar shapes are allowed, no curves or parametric surfaces. | String |
| multipoint | For geometries consisting of a single point, line, or loop. | GeostoreCityJsonProtoCityObjectGeometry | Representation of geometry including geometric primitives which are used as building blocks to construct geometries of varying complexity. Geometries vary both in type and in level-of-detail, enabling representation of any shape at any level of granularity. All geometries are ultimately composed of `MultiPoint`s, which reference the actual vertices. Only linear and planar shapes are allowed, no curves or parametric surfaces. | GeostoreCityJsonProtoCityObjectGeometryMultiPoint |
| multisurface | For geometries consisting of a collection of surfaces. | GeostoreCityJsonProtoCityObjectGeometry | Representation of geometry including geometric primitives which are used as building blocks to construct geometries of varying complexity. Geometries vary both in type and in level-of-detail, enabling representation of any shape at any level of granularity. All geometries are ultimately composed of `MultiPoint`s, which reference the actual vertices. Only linear and planar shapes are allowed, no curves or parametric surfaces. | GeostoreCityJsonProtoCityObjectGeometryMultiSurface |
| semantics | Predefined semantics that may be referenced from geometric primitives. | GeostoreCityJsonProtoCityObjectGeometry | Representation of geometry including geometric primitives which are used as building blocks to construct geometries of varying complexity. Geometries vary both in type and in level-of-detail, enabling representation of any shape at any level of granularity. All geometries are ultimately composed of `MultiPoint`s, which reference the actual vertices. Only linear and planar shapes are allowed, no curves or parametric surfaces. | list(GeostoreCityJsonProtoCityObjectGeometrySemantic) |
| solid | For geometries consisting of a watertight 3D shape. | GeostoreCityJsonProtoCityObjectGeometry | Representation of geometry including geometric primitives which are used as building blocks to construct geometries of varying complexity. Geometries vary both in type and in level-of-detail, enabling representation of any shape at any level of granularity. All geometries are ultimately composed of `MultiPoint`s, which reference the actual vertices. Only linear and planar shapes are allowed, no curves or parametric surfaces. | GeostoreCityJsonProtoCityObjectGeometrySolid |
| materialsIndex | Index into CityJsonProto.appearance.materials. | GeostoreCityJsonProtoCityObjectGeometryMaterialSpec | Used to reference a predefined material from a geometric primitive. | integer |
| xIndices | A collection of references to vertices in `CityJsonProto.flattened_vertices`. `CityJsonProto.flattened_vertices` is a flattened list of vertex coordinates. A value in `x_indices` should be the index of the x-coordinate of the desired vertex V; the full coordinates of vertex V can then be found at indices [V,V+1,V+2]. For example, an `x_indices` containing 3, 0, and 12 references three vertices, whose complete x,y,z coordinates can respectively be found at `CityJsonProto.flattened_vertices` indices [3,4,5], [0,1,2], and [12,13,14]. | GeostoreCityJsonProtoCityObjectGeometryMultiPoint | A single line, loop, or set of points. | list(integer) |
| surfaces | All surfaces are standalone entities with no relationship to each other. | GeostoreCityJsonProtoCityObjectGeometryMultiSurface | A collection of arbitrary surfaces that have no prescribed topological relationship. | list(GeostoreCityJsonProtoCityObjectGeometrySurface) |
| type | The type of semantic entity this geometric primitive is. | GeostoreCityJsonProtoCityObjectGeometrySemantic | Representation of semantic information that can be used for reasoning about geometric primitives. | String |
| shells | The first shell is exterior; any additional are interior. | GeostoreCityJsonProtoCityObjectGeometrySolid | A 3D shape, composed of a watertight exterior shell with optional interior watertight shells. | list(GeostoreCityJsonProtoCityObjectGeometryMultiSurface) |
| loops | The first loop is exterior; any additional are interior. | GeostoreCityJsonProtoCityObjectGeometrySurface | A polygonal surface, composed of a closed exterior loop with optional closed interior loops. | list(GeostoreCityJsonProtoCityObjectGeometryMultiPoint) |
| materialSpecs | The materials this surface is made of. Either all or none of the Surface protos must have this field set (even for ‘null’ references). Otherwise, this field must not be set. IMPORTANT: This field must not contain more than one MaterialSpec unless CityJSON’s material “theme” is incorporated into CityJsonProto (see discussion in go/cityjson-for-hand-modeled-landmarks). | GeostoreCityJsonProtoCityObjectGeometrySurface | A polygonal surface, composed of a closed exterior loop with optional closed interior loops. | list(GeostoreCityJsonProtoCityObjectGeometryMaterialSpec) |
| semanticsIndex | The semantics of this surface (e.g. what part of a building it is) represented as an index into the containing Geometry’s `semantics` field. Either all or none of the Surface protos must have this field set (even for ‘null’ references). Otherwise, this field must not be set. | GeostoreCityJsonProtoCityObjectGeometrySurface | A polygonal surface, composed of a closed exterior loop with optional closed interior loops. | integer |
| scale | Relative scale of the vertices in the new coordinate system relative to the old coordinate system. Applies to all three x,y,z coordinates. | GeostoreCityJsonProtoTransform | Information for transforming a point from an “old” to “new” coordinate frame. Applied as follows: vertex_new = scale * vertex_old + translate | float |
| translate | Offset of each vertex in the new coordinate system relative to the old coordinate system. | GeostoreCityJsonProtoTransform | Information for transforming a point from an “old” to “new” coordinate frame. Applied as follows: vertex_new = scale * vertex_old + translate | GeostoreCityJsonProtoTransformTranslate |
| x | GeostoreCityJsonProtoTransformTranslate | How the object will be moved along the x, y, and z axes, respectively. | float | |
| y | GeostoreCityJsonProtoTransformTranslate | How the object will be moved along the x, y, and z axes, respectively. | float | |
| z | GeostoreCityJsonProtoTransformTranslate | How the object will be moved along the x, y, and z axes, respectively. | float | |
| callToAction | Call to action for the individual product. | GeostoreComposableItemProto | Generic item proto. This is intended to have only certain aspects filled (e.g. photo only, name + price). Valid combinations of properties are enforced by linters. | GeostoreCallToActionProto |
| jobMetadata | GeostoreComposableItemProto | Generic item proto. This is intended to have only certain aspects filled (e.g. photo only, name + price). Valid combinations of properties are enforced by linters. | GeostoreJobMetadata | |
| media | Any photos describing this item. | GeostoreComposableItemProto | Generic item proto. This is intended to have only certain aspects filled (e.g. photo only, name + price). Valid combinations of properties are enforced by linters. | list(GeostoreMediaItemProto) |
| nameInfo | The repeated name_info field is for price list sections listed in multiple languages. At least one name_info containing id must be specified. There should be at most one name_info for any given language. When representing a job item, there should be exactly one name_info specified. | GeostoreComposableItemProto | Generic item proto. This is intended to have only certain aspects filled (e.g. photo only, name + price). Valid combinations of properties are enforced by linters. | list(GeostorePriceListNameInfoProto) |
| offered | Represents if an item is offered at a business. For TYPE_JOB, this represents if this job is offered by the corresponding business | GeostoreComposableItemProto | Generic item proto. This is intended to have only certain aspects filled (e.g. photo only, name + price). Valid combinations of properties are enforced by linters. | String |
| price | Price of the item. There should be at most one price for any given currency. | GeostoreComposableItemProto | Generic item proto. This is intended to have only certain aspects filled (e.g. photo only, name + price). Valid combinations of properties are enforced by linters. | GeostorePriceRangeProto |
| priceFormat | Represents which price format is being used by this item, which determines the usage/meaning of the “price” field above. Optional – the default value is legal and safe (represents no price if the “price” field is unset). | GeostoreComposableItemProto | Generic item proto. This is intended to have only certain aspects filled (e.g. photo only, name + price). Valid combinations of properties are enforced by linters. | String |
| rankingHint | Numerical score which can be provided by data sources to indicate preferred item ordering. This is purely a hint – we are not required to followed it if we have a different order we think is better. Higher scores represent items that should be shown more prominently/earlier. Optional. | GeostoreComposableItemProto | Generic item proto. This is intended to have only certain aspects filled (e.g. photo only, name + price). Valid combinations of properties are enforced by linters. | number |
| comparisonOperator | GeostoreCountComparisonProto | A count value tagged with a comparison operator. This can be used for axle count, trailer count, etc. | String | |
| count | GeostoreCountComparisonProto | A count value tagged with a comparison operator. This can be used for axle count, trailer count, etc. | integer | |
| borderLine | GeostoreCrossingStripePatternProto | Possible patterns of a crossing stripe (any element that denotes a point on a segment or lane at which the vehicle must stop or yield). These include crosswalks, stop, and yield lines. | GeostorePhysicalLineProto | |
| borderPattern | GeostoreCrossingStripePatternProto | Possible patterns of a crossing stripe (any element that denotes a point on a segment or lane at which the vehicle must stop or yield). These include crosswalks, stop, and yield lines. | String | |
| color | Colors found on this crossing. | GeostoreCrossingStripePatternProto | Possible patterns of a crossing stripe (any element that denotes a point on a segment or lane at which the vehicle must stop or yield). These include crosswalks, stop, and yield lines. | list(GeostorePaintedElementLogicalColorProto) |
| stripePattern | GeostoreCrossingStripePatternProto | Possible patterns of a crossing stripe (any element that denotes a point on a segment or lane at which the vehicle must stop or yield). These include crosswalks, stop, and yield lines. | String | |
| pointCurvature | Curvature values at points along the flowline. A linear interpolation between two successive points will yield the curvature value at intermediate points. | GeostoreCurvatureProto | list(GeostorePointCurvatureProto) | |
| bezierParams | GeostoreCurveConnectionProto | Protocol buffer describing a curve that connects two externally specified endpoints. | GeostoreCurveConnectionProtoBezierParams | |
| circleParams | GeostoreCurveConnectionProto | Protocol buffer describing a curve that connects two externally specified endpoints. | GeostoreCurveConnectionProtoCircleParams | |
| type | GeostoreCurveConnectionProto | Protocol buffer describing a curve that connects two externally specified endpoints. | String | |
| controlPoint | Internal Bezier handles. One can be used for a quadratic curve, two for cubic Beziers. | GeostoreCurveConnectionProtoBezierParams | list(GeostoreCurveConnectionProtoBezierParamsControlPoint) | |
| angleDegrees | We use this parameterization to make curves change predictable when endpoints move. Each point P is defined in terms of the straight edge [S, E] between the start point of the curve S and its end point E. *P / / / S *————* E Counter-clockwise angle between vector SE and vector SP. | GeostoreCurveConnectionProtoBezierParamsControlPoint | float | |
| distanceMultiplier | Distance(S, P) in units of Distance(S, E). | GeostoreCurveConnectionProtoBezierParamsControlPoint | float | |
| radius | Arc radius. Must be greater than half-distance between two endpoints. | GeostoreCurveConnectionProtoCircleParams | float | |
| attributionUrl | This is the URL of a website representing this DataSource as a whole. If this DataSource feature is specific to a particular dataset or product, the page may contain information relevant to that dataset or product or may be the main page of the organization. | GeostoreDataSourceProto | Every data source used to construct a data repository has an associated feature that provides more information about it. The standard feature properties have the following interpretations: bound – The bounds must includes all features that refer to this data source, so that bucketing MapReduce passes work correctly. name – The provider name associated with this data source. It is expected to remain constant from release to release, and between datasets. address – should be empty. point, polyline, polygon – should be empty. source_info – should not be set. child – should be empty. | list(GeostoreUrlProto) |
| copyrightOwner | A UTF8 string that will be inserted in copyright messages to refer to this copyright owner, e.g. “Tele Atlas”. | GeostoreDataSourceProto | Every data source used to construct a data repository has an associated feature that provides more information about it. The standard feature properties have the following interpretations: bound – The bounds must includes all features that refer to this data source, so that bucketing MapReduce passes work correctly. name – The provider name associated with this data source. It is expected to remain constant from release to release, and between datasets. address – should be empty. point, polyline, polygon – should be empty. source_info – should not be set. child – should be empty. | String |
| copyrightYear | The copyright year of this data (which may be different than the year of the release date), e.g. 2005. | GeostoreDataSourceProto | Every data source used to construct a data repository has an associated feature that provides more information about it. The standard feature properties have the following interpretations: bound – The bounds must includes all features that refer to this data source, so that bucketing MapReduce passes work correctly. name – The provider name associated with this data source. It is expected to remain constant from release to release, and between datasets. address – should be empty. point, polyline, polygon – should be empty. source_info – should not be set. child – should be empty. | integer |
| description | A free-form description of this data source. Ideally the description should include: – Where the data was obtained (URL, company name, individual, etc). – Where to find detailed documentation. – A brief summary of the licensing terms. – As much internal and external contact information as possible (e.g. who to ask about licensing questions, interpreting the data, updating the data, fixing bugs in the importer, etc). | GeostoreDataSourceProto | Every data source used to construct a data repository has an associated feature that provides more information about it. The standard feature properties have the following interpretations: bound – The bounds must includes all features that refer to this data source, so that bucketing MapReduce passes work correctly. name – The provider name associated with this data source. It is expected to remain constant from release to release, and between datasets. address – should be empty. point, polyline, polygon – should be empty. source_info – should not be set. child – should be empty. | String |
| importerBuildInfo | The build information of the importer binary used to generate this data source. | GeostoreDataSourceProto | Every data source used to construct a data repository has an associated feature that provides more information about it. The standard feature properties have the following interpretations: bound – The bounds must includes all features that refer to this data source, so that bucketing MapReduce passes work correctly. name – The provider name associated with this data source. It is expected to remain constant from release to release, and between datasets. address – should be empty. point, polyline, polygon – should be empty. source_info – should not be set. child – should be empty. | String |
| importerBuildTarget | The build target of the importer binary used to generate this data source. | GeostoreDataSourceProto | Every data source used to construct a data repository has an associated feature that provides more information about it. The standard feature properties have the following interpretations: bound – The bounds must includes all features that refer to this data source, so that bucketing MapReduce passes work correctly. name – The provider name associated with this data source. It is expected to remain constant from release to release, and between datasets. address – should be empty. point, polyline, polygon – should be empty. source_info – should not be set. child – should be empty. | String |
| importerClientInfo | The Perforce client information of the importer binary used to generate this data source. | GeostoreDataSourceProto | Every data source used to construct a data repository has an associated feature that provides more information about it. The standard feature properties have the following interpretations: bound – The bounds must includes all features that refer to this data source, so that bucketing MapReduce passes work correctly. name – The provider name associated with this data source. It is expected to remain constant from release to release, and between datasets. address – should be empty. point, polyline, polygon – should be empty. source_info – should not be set. child – should be empty. | String |
| importerMpmVersion | If the importer was built as an MPM, the version number can be stored in this field. As with build_info, this can be useful when tracking down issues that may be due to the use of a particular binary. | GeostoreDataSourceProto | Every data source used to construct a data repository has an associated feature that provides more information about it. The standard feature properties have the following interpretations: bound – The bounds must includes all features that refer to this data source, so that bucketing MapReduce passes work correctly. name – The provider name associated with this data source. It is expected to remain constant from release to release, and between datasets. address – should be empty. point, polyline, polygon – should be empty. source_info – should not be set. child – should be empty. | String |
| importerTimestamp | The timestamp of the importer binary used to generate this data source. | GeostoreDataSourceProto | Every data source used to construct a data repository has an associated feature that provides more information about it. The standard feature properties have the following interpretations: bound – The bounds must includes all features that refer to this data source, so that bucketing MapReduce passes work correctly. name – The provider name associated with this data source. It is expected to remain constant from release to release, and between datasets. address – should be empty. point, polyline, polygon – should be empty. source_info – should not be set. child – should be empty. | String |
| provider | The provider type of this data source. | GeostoreDataSourceProto | Every data source used to construct a data repository has an associated feature that provides more information about it. The standard feature properties have the following interpretations: bound – The bounds must includes all features that refer to this data source, so that bucketing MapReduce passes work correctly. name – The provider name associated with this data source. It is expected to remain constant from release to release, and between datasets. address – should be empty. point, polyline, polygon – should be empty. source_info – should not be set. child – should be empty. | String |
| rawMetadata | For every key that is used in raw_data from this source, there must be a corresponding entry in raw_metadata that describes this key. | GeostoreDataSourceProto | Every data source used to construct a data repository has an associated feature that provides more information about it. The standard feature properties have the following interpretations: bound – The bounds must includes all features that refer to this data source, so that bucketing MapReduce passes work correctly. name – The provider name associated with this data source. It is expected to remain constant from release to release, and between datasets. address – should be empty. point, polyline, polygon – should be empty. source_info – should not be set. child – should be empty. | list(GeostoreRawMetadataProto) |
| release | A release string that doesn’t have to be a date. This is provided so that we can preserve provider release strings that aren’t based on dates. If you don’t set it, the release_date will get formatted into this field for debugging purposes. | GeostoreDataSourceProto | Every data source used to construct a data repository has an associated feature that provides more information about it. The standard feature properties have the following interpretations: bound – The bounds must includes all features that refer to this data source, so that bucketing MapReduce passes work correctly. name – The provider name associated with this data source. It is expected to remain constant from release to release, and between datasets. address – should be empty. point, polyline, polygon – should be empty. source_info – should not be set. child – should be empty. | String |
| releaseDate | The release date of this data. | GeostoreDataSourceProto | Every data source used to construct a data repository has an associated feature that provides more information about it. The standard feature properties have the following interpretations: bound – The bounds must includes all features that refer to this data source, so that bucketing MapReduce passes work correctly. name – The provider name associated with this data source. It is expected to remain constant from release to release, and between datasets. address – should be empty. point, polyline, polygon – should be empty. source_info – should not be set. child – should be empty. | GeostoreDateTimeProto |
| sourceDataset | A data provider defined string describing the source dataset from which the features of this data source were generated. For example, the MultiNet “fra” dataset produces features for both France and Monaco. | GeostoreDataSourceProto | Every data source used to construct a data repository has an associated feature that provides more information about it. The standard feature properties have the following interpretations: bound – The bounds must includes all features that refer to this data source, so that bucketing MapReduce passes work correctly. name – The provider name associated with this data source. It is expected to remain constant from release to release, and between datasets. address – should be empty. point, polyline, polygon – should be empty. source_info – should not be set. child – should be empty. | String |
| precision | This attribute describes the precision of the date and time. It would be unusual for a data provider to provide a precision along with their date. It is more likely that the precision of a date will be inferred from the date format. For example “19th century” is likely to be correct to the century, while “1800” is probably correct to the year. The precision should be semantically interpreted as a cast, so a DateTimeProto object with a seconds value corresponding to 2018-03-28 18:40:00 UTC and a precision of MONTH should be interpreted as “March 2018”. The enums above are only some of the possible precision levels for dates and times. Clients may wish to add more precision enums in the future. However, these enums must be ordered by decreasing duration. Clients should be able to write date formatting code that looks like this: if (datetime.precision() <= DateTimeProto::PRECISION_CENTURY) { date = FormatCenturyDate(proto.seconds()); } else if (proto.precision() <= case DateTimeProto::PRECISION_DECADE) { date = FormatDecadeDate(proto.seconds()); } else { ... } See geostore/base/public/datetime.h for date formatting utility functions. | GeostoreDateTimeProto | WARNING: Outside of FeatureProto, please avoid in favor of a standard civil time type. Direct usage is error-prone due to the conflation of physical time and civil time (go/httat). In a protocol buffer, please use google.type.Date, with an additional google.type.TimeOfDay for precision finer-grained than a day. (For google.type.DateTime, go/prototime#types cites go/httat#zoned_datetime as a caveat). In a programming language, see go/time-devguide/languages. Additionally in C++, google3/geostore/base/public/datetime.h has conversion functions between DateTimeProto and Abseil’s civil time types. | String |
| seconds | Number of seconds since (or before) the UNIX epoch (January 1, 1970). This is also the standard epoch for Java and Python time representations. If it is important for this time be displayed correctly for different time zones, convert the time to Coordinated Universal Time (UTC). | GeostoreDateTimeProto | WARNING: Outside of FeatureProto, please avoid in favor of a standard civil time type. Direct usage is error-prone due to the conflation of physical time and civil time (go/httat). In a protocol buffer, please use google.type.Date, with an additional google.type.TimeOfDay for precision finer-grained than a day. (For google.type.DateTime, go/prototime#types cites go/httat#zoned_datetime as a caveat). In a programming language, see go/time-devguide/languages. Additionally in C++, google3/geostore/base/public/datetime.h has conversion functions between DateTimeProto and Abseil’s civil time types. | float |
| comparisonOperator | GeostoreDimensionComparisonProto | A dimension value tagged with a comparison operator. This can be used for height, width, or length. | String | |
| dimensionWithUnit | GeostoreDimensionComparisonProto | A dimension value tagged with a comparison operator. This can be used for height, width, or length. | GeostoreDimensionProto | |
| dimension | GeostoreDimensionProto | A dimension with a numerical value and unit. This can be a height, width, or length. | number | |
| unit | GeostoreDimensionProto | A dimension with a numerical value and unit. This can be a height, width, or length. | String | |
| displayLocation | The location where this feature should be rendered. | GeostoreDisplayDataProto | This holds data specific to rendering a POI on a map. It’s derived from data already in MapFacts, e.g. containing features and the feature’s point field. If empty, this proto should be ignored for rendering. See go/maps-render-alignment for motivation and more details. | GeostorePointProto |
| administeredBy | If present this feature is administered by the power present in the field. In most cases this will be a two letter ISO-3166 region code, but may be a descriptive string if no region code is available. | GeostoreDisputedAreaProto | This protocol buffer is used to store information about disputed areas. E.g., the political power that administers a disputed area or the countries that claim it. It should only be used for features of TYPE_DISPUTED_AREA. | String |
| claimant | Feature IDs (usually a country feature ID) of all parties who claim this feature. No claimants means the claim by the country that contains it (based on country polygon) is not disputed. | GeostoreDisputedAreaProto | This protocol buffer is used to store information about disputed areas. E.g., the political power that administers a disputed area or the countries that claim it. It should only be used for features of TYPE_DISPUTED_AREA. | list(GeostoreFeatureIdProto) |
| type | The type of this feature — see comments above. | GeostoreDoodleProto | This protocol buffer holds the doodle-specific attributes for features of type TYPE_DOODLE. | String |
| isFree | If true, represents that the rate is free; i.e. the price is 0 in any currency. If this is true, price must be empty. | GeostoreDurationBasedRateProto | A single cost which will apply based on the duration of utilization. The cost may apply once, or repeatedly on some interval, to account for the total utilization. If the duration expressed by range_start_seconds and range_end_seconds do not cover the entire duration of the utilization (i.e. from 0 to some time greater than the total utilization time), this must be combined with other DurationBasedRateProtos such that the entire duration of the utilization is accounted for. See go/rate-schema for more details. | boolean |
| periodicitySeconds | The billable unit of the rate; i.e. after having utilized the service for exactly periodicity_seconds, the total cost should increase by ‘price’. For example, if the rate expresses a price per hour, then periodicity_seconds should be set to 3600. If this is unset, then the rate does not vary based on duration, and price represents a flat cost. May only be set if price is nonempty. | GeostoreDurationBasedRateProto | A single cost which will apply based on the duration of utilization. The cost may apply once, or repeatedly on some interval, to account for the total utilization. If the duration expressed by range_start_seconds and range_end_seconds do not cover the entire duration of the utilization (i.e. from 0 to some time greater than the total utilization time), this must be combined with other DurationBasedRateProtos such that the entire duration of the utilization is accounted for. See go/rate-schema for more details. | integer |
| price | The total price, in each applicable currency, of utilizing the service for periodicity_seconds, or for the entire duration expressed by range_start_seconds and range_end_seconds if periodicity_seconds is 0. Each entry should have an ID of /measurement_unit/money_value and consist of two properties: one with an ID of /measurement_unit/money_value/amount and a float value with the amount, and another with the ID /measurement_unit/money_value/currency and an ID value with the MID of the proper currency. May only be set if is_free is false. | GeostoreDurationBasedRateProto | A single cost which will apply based on the duration of utilization. The cost may apply once, or repeatedly on some interval, to account for the total utilization. If the duration expressed by range_start_seconds and range_end_seconds do not cover the entire duration of the utilization (i.e. from 0 to some time greater than the total utilization time), this must be combined with other DurationBasedRateProtos such that the entire duration of the utilization is accounted for. See go/rate-schema for more details. | list(FreebaseTopic) |
| rangeEndSeconds | Upper bound for durations to match, exclusive. Unset implies indefinite. | GeostoreDurationBasedRateProto | A single cost which will apply based on the duration of utilization. The cost may apply once, or repeatedly on some interval, to account for the total utilization. If the duration expressed by range_start_seconds and range_end_seconds do not cover the entire duration of the utilization (i.e. from 0 to some time greater than the total utilization time), this must be combined with other DurationBasedRateProtos such that the entire duration of the utilization is accounted for. See go/rate-schema for more details. | integer |
| rangeStartSeconds | Lower bound for durations to match, inclusive. Required; a value of 0 expresses that the price applies from the start of the utilization period. | GeostoreDurationBasedRateProto | A single cost which will apply based on the duration of utilization. The cost may apply once, or repeatedly on some interval, to account for the total utilization. If the duration expressed by range_start_seconds and range_end_seconds do not cover the entire duration of the utilization (i.e. from 0 to some time greater than the total utilization time), this must be combined with other DurationBasedRateProtos such that the entire duration of the utilization is accounted for. See go/rate-schema for more details. | integer |
| blendOrder | Defines the relative order in which terrain data should be rendered. Features with higher blend_order should be blended on top of features with lower blend_order. NOTE: this is backwards from the way BlendRank works in Magrathean. | GeostoreElevationModelProto | Represents raster digital elevation model data. | integer |
| dataLevel | The zoom level at which this data is defined. Level 0 is world level data, and each increase in zoom level corresponds to a factor of 2 increase in scale. | GeostoreElevationModelProto | Represents raster digital elevation model data. | integer |
| dataMaxlevel | The maximum (finest) level at which this terrain data has sufficient resolution to be displayed. | GeostoreElevationModelProto | Represents raster digital elevation model data. | integer |
| elevationData | A place to store an elevation data protocol buffer. Currently, this must be a keyhole::AssetTileCompressed (see google3/keyhole/common/proto/magrathean.protodevel). | GeostoreElevationModelProto | Represents raster digital elevation model data. | Proto2BridgeMessageSet |
| fullChildDataAvailable | If true, all of the data contained in this feature is available at the next highest (more detailed) level. If this is true, partial_child_data_available should also be true. | GeostoreElevationModelProto | Represents raster digital elevation model data. | boolean |
| partialChildDataAvailable | If true, at least part of the data contained in this feature is available at the next highest (more detailed) level. | GeostoreElevationModelProto | Represents raster digital elevation model data. | boolean |
| averageElevationMeters | The average elevation of the feature in meters above the local mean sea level. | GeostoreElevationProto | This protocol buffer holds elevation and related data. | float |
| peak | Additional details for TYPE_PEAK and TYPE_VOLCANO features. | GeostoreElevationProto | This protocol buffer holds elevation and related data. | GeostorePeakProto |
| allowance | GeostoreEntranceProto | This protocol buffer holds entrance-specific attributes for features of type TYPE_ENTRANCE. | String | |
| canEnter | DEPRECATED. Please use enter_or_exit instead. | GeostoreEntranceProto | This protocol buffer holds entrance-specific attributes for features of type TYPE_ENTRANCE. | boolean |
| canExit | Whether the target can be entered through this entrance. Whether the target can be exited through this entrance. | GeostoreEntranceProto | This protocol buffer holds entrance-specific attributes for features of type TYPE_ENTRANCE. | boolean |
| featureId | Feature ID of the related entrance. References should refer to TYPE_ENTRANCE or TYPE_COMPOUND features that are entrances or exits of the referencing feature. | GeostoreEntranceReferenceProto | Models a relationship between a feature and its entrance or exit. | GeostoreFeatureIdProto |
| bizbuilderReference | Reference to BizBuilder data for this establishment. The bizbuilder_reference field indicates that a feature is claimed in CBDB (with the canonical state in MapFacts). The bizbuilder_reference is different from the social_reference’s claimed_gaia_id because some BizBuilder clients will not have +Pages. All claimed businesses should have a bizbuilder_reference. | GeostoreEstablishmentProto | This protocol buffer holds establishment-specific attributes for features of type TYPE_ESTABLISHMENT. | GeostoreBizBuilderReferenceProto |
| hours | Regular opening hours for the establishment (weekly schedule). | GeostoreEstablishmentProto | This protocol buffer holds establishment-specific attributes for features of type TYPE_ESTABLISHMENT. | GeostoreTimeScheduleProto |
| openingHours | Opening hours for this establishment, including regular weekly hours and exceptional hours (e.g. on holidays). NOTE: in practice, only the exceptional hours are filled in this message. A schema migration for regular weekly hours was planned back in 2015 (see b/23105782) but was not completed and is (as of May 2018) not prioritized. Clients should continue getting regular opening hours from the `hours` field above. In openinghours.h there is a utility function `GetOpeningHoursFromFeature` that merges `EstablishmentProto.hours` into this proto. | GeostoreEstablishmentProto | This protocol buffer holds establishment-specific attributes for features of type TYPE_ESTABLISHMENT. | GeostoreOpeningHoursProto |
| priceInfo | Pricing for products and services offered. Example: menus for restaurants. | GeostoreEstablishmentProto | This protocol buffer holds establishment-specific attributes for features of type TYPE_ESTABLISHMENT. | GeostorePriceInfoProto |
| serviceArea | GeostoreEstablishmentProto | This protocol buffer holds establishment-specific attributes for features of type TYPE_ESTABLISHMENT. | GeostoreServiceAreaProto | |
| telephone | Telephone number and related information. | GeostoreEstablishmentProto | This protocol buffer holds establishment-specific attributes for features of type TYPE_ESTABLISHMENT. | list(GeostoreTelephoneProto) |
| type | ** DEPRECATED ** This is deprecated in favor of the top-level (in FeatureProto) set of GConcepts. The type of establishment — see comments above. | GeostoreEstablishmentProto | This protocol buffer holds establishment-specific attributes for features of type TYPE_ESTABLISHMENT. | String |
| hours | The weekly schedule to be applied for the dates that fall within the range. The schedule may contain hours only for days of the week that occur during the date range specified in the range field. | GeostoreExceptionalHoursProto | An ExceptionalHoursProto holds information about exceptional (non-regular) hours for a business, such as holiday hours. | GeostoreBusinessHoursProto |
| metadata | Field-level metadata for this exception. | GeostoreExceptionalHoursProto | An ExceptionalHoursProto holds information about exceptional (non-regular) hours for a business, such as holiday hours. | GeostoreFieldMetadataProto |
| range | The dates for which this exception applies, expressed as a half open interval. For example, an exception that applies for the entire month of December 2015 should have a range December 1, 2015 to January 1, 2016. Any regular hours that start on days in this range are ignored and replaced by the exceptional hours for that day. The TimeIntervalProto for the range must be a fully specified, non-empty, and non-inverted range of dates. Concretely, the requirements are: * the range must be a TYPE_RANGE interval * the interval may not be inverted * the endpoints of the interval must specify a year, month, and day * the day_type of each endpoint must be type DAY_OF_MONTH * the endpoints may not specify hour, minute, second, week, or week_type * the begin endpoint must predate the end endpoint | GeostoreExceptionalHoursProto | An ExceptionalHoursProto holds information about exceptional (non-regular) hours for a business, such as holiday hours. | GeostoreTimeIntervalProto |
| closeReason | Structured reason for the permanent closure (if any). | GeostoreExistenceProto | String | |
| closed | Indicates whether the place is closed (permanently or temporarily), i.e., not operational in the present, but was in the past. WARNING: New code should prefer go/geo-schema-reference:operational-status. | GeostoreExistenceProto | boolean | |
| endAsOfDate | The earliest known date of this feature’s “end” (e.g. an establishment’s permanent closure), if the actual date is unknown; i.e. the best known upper bound of the day end_date would represent. end_as_of_date must be in local (civil) time and of PRECISION_DAY. WARNING: Not necessarily consistent yet with `closed` or the ClosureAttachmentProto. If you believe you need to use this field directly, please go/contact-geo-schema. | GeostoreExistenceProto | GeostoreDateTimeProto | |
| endDate | GeostoreExistenceProto | GeostoreDateTimeProto | ||
| featureBirthTimestampSeconds | ** DEPRECATED ** This field is now deprecated (see b/22878252). Please use the Geo Schema GetFeatureBirthTimestamp() API to extract the birth timestamp of a feature. The timestamp in seconds since the UNIX epoch (January 1, 1970) when this feature becomes live in the Geo repository. This was the birth date of the place’s representation in Google whereas start_date is the birth date of the place’s operations in the physical world. | GeostoreExistenceProto | String | |
| removed | Indicates whether the feature is marked as removed in the Geo repository. Removed features are still present in the Geo repository but are considered to be in an inactive state (not valid for lint purposes, not retrievable except explicitly by feature ID, etc.). NOTE: If you have access to a complete FeatureProto, do NOT read this bit directly to find out whether a feature is removed. Instead, rely on the IsFeatureRemoved() API, available in C++ (geostore/base/public/feature.h) and Java (geostore/base/Feature.java). | GeostoreExistenceProto | boolean | |
| removedReason | Structured reason why the feature is marked as removed. Relevant only when removed == true. | GeostoreExistenceProto | String | |
| startDate | (Initial) start and (permanent) end dates of operations, such that start_date is the first day operational and end_date is the first day when operations have permanently ended. The only allowed precisions are PRECISION_DAY, PRECISION_MONTH, PRECISION_YEAR. DateTimeProto.seconds should have the lowest legal value for the desired date/time and precision. E.g. for PRECISION_MONTH, 2019-02-15 21:10:30 is not valid, it should be 2019-02-01 00:00:00 instead. NOTE: The start_date and end_date are stored in UTC but should be interpreted as being in the local timezone. So clients should convert the DateTimeProto to local (civil) time using UTC+0, and then treat the result as local to the feature. | GeostoreExistenceProto | GeostoreDateTimeProto | |
| fieldProvenance | GeostoreFeatureFieldMetadataProto | Provenance information for sub-fields of this feature – go/subfield-provenance. | list(GeostoreFeatureFieldMetadataProtoFieldProvenance) | |
| fieldPath | Represents all fields for which this SourceInfo is valid. NOTE: Field paths are rooted at FeatureProto level. | GeostoreFeatureFieldMetadataProtoFieldProvenance | list(GeostoreStableFieldPathProto) | |
| provenance | GeostoreFeatureFieldMetadataProtoFieldProvenance | GeostoreProvenanceProto | ||
| featureBirthTimestampUs | The timestamp (in microseconds since the UNIX epoch) when this feature first went live in the Geo repository. Note that this has no relation to the birth data of that geographical entity in the real world. | GeostoreFeatureHistoryMetadataProto | Metadata related to the history of a given feature in the Geo repository. | String |
| lastModificationTimestampUs | The timestamp (in microseconds since the UNIX epoch) of the last modification to the feature. Note this includes attachment modifications. The feature’s initial creation is also considered as a modification. This is useful for those that consume features via both listening to notifications and reading from repository snapshots. This timestamp can be used to decide whether a feature in the snapshot was already seen in a more recent state through the notifications. | GeostoreFeatureHistoryMetadataProto | Metadata related to the history of a given feature in the Geo repository. | String |
| removalTimestampUs | The timestamp (in microseconds since the UNIX epoch) of the deletion time of the feature. If the feature is currently removed, this field gets populated with the timestamp the feature first became removed after being live (or being removed from beginning). This field won’t be set if the feature is live. | GeostoreFeatureHistoryMetadataProto | Metadata related to the history of a given feature in the Geo repository. | String |
| duplicateOf | If the feature has been marked as a DUPLICATE of another feature, this is the feature ID of that other feature. Note that the other feature may itself be removed. This field is always set. | GeostoreFeatureIdForwardingsProto | Feature ID forwardings. There are many different types of ID forwardings, some of which are attached to live features, others to removed features. This information is available in multiple forms (with different completeness guarantees): (1) in RPC responses to read requests to the live Geo repository; (2) on disk, as part of the metadata section of features found in the (inactive) features snapshots; (3) on disk, as part of a separate feature_id_forwardings side table. | GeostoreFeatureIdProto |
| forwardedId | The feature ID of the forwarded feature. This field is only set in case (3). | GeostoreFeatureIdForwardingsProto | Feature ID forwardings. There are many different types of ID forwardings, some of which are attached to live features, others to removed features. This information is available in multiple forms (with different completeness guarantees): (1) in RPC responses to read requests to the live Geo repository; (2) on disk, as part of the metadata section of features found in the (inactive) features snapshots; (3) on disk, as part of a separate feature_id_forwardings side table. | GeostoreFeatureIdProto |
| inactiveDuplicate | If other features have been marked as DUPLICATE of this feature, this is the set of all such feature IDs. All feature IDs in this set should be for removed (aka inactive) features. Note that in the context of historical read requests against MapFacts (when ReadRequest.version_selection.timestamp is set), this field won’t be set. | GeostoreFeatureIdForwardingsProto | Feature ID forwardings. There are many different types of ID forwardings, some of which are attached to live features, others to removed features. This information is available in multiple forms (with different completeness guarantees): (1) in RPC responses to read requests to the live Geo repository; (2) on disk, as part of the metadata section of features found in the (inactive) features snapshots; (3) on disk, as part of a separate feature_id_forwardings side table. | list(GeostoreFeatureIdProto) |
| replacedBy | DEPRECATED – Use feature.metadata.feature_replacement_info instead. This field was never populated. | GeostoreFeatureIdForwardingsProto | Feature ID forwardings. There are many different types of ID forwardings, some of which are attached to live features, others to removed features. This information is available in multiple forms (with different completeness guarantees): (1) in RPC responses to read requests to the live Geo repository; (2) on disk, as part of the metadata section of features found in the (inactive) features snapshots; (3) on disk, as part of a separate feature_id_forwardings side table. | GeostoreFeatureIdListProto |
| transitivelyDuplicateOf | If the feature has been transitively marked as a DUPLICATE of another feature (via a chain of size >= 1), this is the feature ID of that other feature which is the end of the chain. The field is always set even if the chain is of size 1. Note that the other feature may itself be removed. This field is only set in case (3). | GeostoreFeatureIdForwardingsProto | Feature ID forwardings. There are many different types of ID forwardings, some of which are attached to live features, others to removed features. This information is available in multiple forms (with different completeness guarantees): (1) in RPC responses to read requests to the live Geo repository; (2) on disk, as part of the metadata section of features found in the (inactive) features snapshots; (3) on disk, as part of a separate feature_id_forwardings side table. | GeostoreFeatureIdProto |
| id | The list of feature IDs. While the exact semantics of these IDs are usage-dependent, the list should never be empty or contain duplicates. | GeostoreFeatureIdListProto | A simple list of feature IDs. | list(GeostoreFeatureIdProto) |
| cellId | The S2CellId corresponding to the approximate location of this feature as of when it was first created. This can be of variable accuracy, ranging from the exact centroid of the feature at creation, a very large S2 Cell, or even being completely randomized for locationless features. Cell ids have the nice property that they follow a space-filling curve over the surface of the earth. (See s2cellid.h for details.) WARNING: Clients should only use cell IDs to perform spatial locality optimizations. There is no strict guarantee that the cell ID of a feature is related to the current geometry of the feature in any way. | GeostoreFeatureIdProto | A globally unique identifier associated with each feature. We use 128-bit identifiers so that we have lots of bits available to distinguish between features. The feature id currently consists of a 64-bit “cell id” that **sometimes** corresponds to the approximate centroid of the feature, plus a 64-bit fingerprint of other identifying information. See more on each respective field in its comments. Feature ids are first assigned when the data is created in MapFacts. After initial creation of the feature, they are immutable. This means that the only properties that you should rely on are that they are unique, and that cell_ids often – but not always – preserve spatial locality. The degree of locality varies as the feature undergoes geometry changes, and should not in general be considered a firm guarantee of the location of any particular feature. In fact, some locationless features have randomized cell IDs! Consumers of FeatureProtos from Mapfacts are guaranteed that fprints in the id field of features will be globally unique. Using the fprint allows consumers who don’t need the spatial benefit of cell ids to uniquely identify features in a 64-bit address space. This property is not guaranteed for other sources of FeatureProtos. | String |
| fprint | A 64-bit fingerprint used to identify features. Most clients should rely on MapFacts or OneRing to choose fingerprints. If creating new fprints, the strategy should be chosen so that the chance of collision is remote or non-existent, and the distribution should be reasonably uniform. For example, if the source data assigns unique ids to features, then a fingerprint of the provider name, version, and source id is sufficient. | GeostoreFeatureIdProto | A globally unique identifier associated with each feature. We use 128-bit identifiers so that we have lots of bits available to distinguish between features. The feature id currently consists of a 64-bit “cell id” that **sometimes** corresponds to the approximate centroid of the feature, plus a 64-bit fingerprint of other identifying information. See more on each respective field in its comments. Feature ids are first assigned when the data is created in MapFacts. After initial creation of the feature, they are immutable. This means that the only properties that you should rely on are that they are unique, and that cell_ids often – but not always – preserve spatial locality. The degree of locality varies as the feature undergoes geometry changes, and should not in general be considered a firm guarantee of the location of any particular feature. In fact, some locationless features have randomized cell IDs! Consumers of FeatureProtos from Mapfacts are guaranteed that fprints in the id field of features will be globally unique. Using the fprint allows consumers who don’t need the spatial benefit of cell ids to uniquely identify features in a 64-bit address space. This property is not guaranteed for other sources of FeatureProtos. | String |
| temporaryData | A place for clients to attach arbitrary data to a feature ID. Never set in MapFacts. | GeostoreFeatureIdProto | A globally unique identifier associated with each feature. We use 128-bit identifiers so that we have lots of bits available to distinguish between features. The feature id currently consists of a 64-bit “cell id” that **sometimes** corresponds to the approximate centroid of the feature, plus a 64-bit fingerprint of other identifying information. See more on each respective field in its comments. Feature ids are first assigned when the data is created in MapFacts. After initial creation of the feature, they are immutable. This means that the only properties that you should rely on are that they are unique, and that cell_ids often – but not always – preserve spatial locality. The degree of locality varies as the feature undergoes geometry changes, and should not in general be considered a firm guarantee of the location of any particular feature. In fact, some locationless features have randomized cell IDs! Consumers of FeatureProtos from Mapfacts are guaranteed that fprints in the id field of features will be globally unique. Using the fprint allows consumers who don’t need the spatial benefit of cell ids to uniquely identify features in a 64-bit address space. This property is not guaranteed for other sources of FeatureProtos. | Proto2BridgeMessageSet |
| bulkUpdatable | This field indicates whether the feature is subject to bulk updates. Caution must be exercised while editing such features since the changes made by the edits will be overwritten by the bulk update (if the feature is bulk updated). See go/mapfacts-abu for more information. | GeostoreFeatureMetadataProto | General metadata related to a given feature in the Geo repository. | String |
| coreVersionToken | core_version_token is an opaque token representing the version of the core fields of the feature. This field is not updated when attachments are changed. | GeostoreFeatureMetadataProto | General metadata related to a given feature in the Geo repository. | String |
| featureReplacementInfo | Metadata for tracking when a feature is derived from or replaced by another feature or set of features. | GeostoreFeatureMetadataProto | General metadata related to a given feature in the Geo repository. | GeostoreFeatureReplacementInfoProto |
| fieldMetadata | Metadata about certain repeated fields and their subfields, for which field type is not granular enough. | GeostoreFeatureMetadataProto | General metadata related to a given feature in the Geo repository. | GeostoreFeatureFieldMetadataProto |
| forwardings | Feature ID forwardings, if applicable. | GeostoreFeatureMetadataProto | General metadata related to a given feature in the Geo repository. | GeostoreFeatureIdForwardingsProto |
| history | Metadata related to the history. | GeostoreFeatureMetadataProto | General metadata related to a given feature in the Geo repository. | GeostoreFeatureHistoryMetadataProto |
| versionToken | version_token is an opaque token representing the version of this feature. It can be used as a concurrency token when sending edits. | GeostoreFeatureMetadataProto | General metadata related to a given feature in the Geo repository. | String |
| attachmentTypeId | Required when field_type == ATTACHMENT. | GeostoreFeaturePropertyIdProto | Message to represent a “feature property” as an abstract construct. Most feature properties are mapped one to one with the EditProto field types. However in some cases the EditProto field type granularity is too coarse to support use-cases that rely on feature properties (such as per-value rights tracking). When that is the case, the feature property is augmented with a secondary field. | String |
| attributeId | Required when field_type == FEATURE_ATTRIBUTE. | GeostoreFeaturePropertyIdProto | Message to represent a “feature property” as an abstract construct. Most feature properties are mapped one to one with the EditProto field types. However in some cases the EditProto field type granularity is too coarse to support use-cases that rely on feature properties (such as per-value rights tracking). When that is the case, the feature property is augmented with a secondary field. | String |
| fieldType | GeostoreFeaturePropertyIdProto | Message to represent a “feature property” as an abstract construct. Most feature properties are mapped one to one with the EditProto field types. However in some cases the EditProto field type granularity is too coarse to support use-cases that rely on feature properties (such as per-value rights tracking). When that is the case, the feature property is augmented with a secondary field. | String | |
| kgPropertyId | Required when field_type == KNOWLEDGE_GRAPH_PROPERTY. | GeostoreFeaturePropertyIdProto | Message to represent a “feature property” as an abstract construct. Most feature properties are mapped one to one with the EditProto field types. However in some cases the EditProto field type granularity is too coarse to support use-cases that rely on feature properties (such as per-value rights tracking). When that is the case, the feature property is augmented with a secondary field. | String |
| nameLanguage | RESERVED | GeostoreFeaturePropertyIdProto | Message to represent a “feature property” as an abstract construct. Most feature properties are mapped one to one with the EditProto field types. However in some cases the EditProto field type granularity is too coarse to support use-cases that rely on feature properties (such as per-value rights tracking). When that is the case, the feature property is augmented with a secondary field. | String |
| geopoliticalGeometry | Geopolitical (unsimplified) polygons for a feature for different geopolitical use cases. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreGeopoliticalGeometryProto |
| doodle | ** DEPRECATED ** | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreDoodleProto |
| name | The name(s) of this feature. A feature may have different names in different languages, colloquial or “vanity” names, etc. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | list(GeostoreNameProto) |
| relatedTimezone | Contains time zones known to be associated with a feature. Most features are associated with the single time zone that contains them. However, some larger features (countries, continents, etc.) are associated with all of the time zones they contain. Most features can have any number of related time zones, but TYPE_SEGMENT and TYPE_ESTABLISHMENT_POI features can have at most 1. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | list(GeostoreTimezoneProto) |
| storefrontGeometryModel | Geometry Store ID and materialized geometry for a POI feature’s storefront(s). IMPORTANT: Clients may not write to this field directly; see go/geometry-store-reading-and-writing#writing-to-geometry-store. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreGeometryStoreReferenceProto |
| center | The conceptual center of the feature, used for routing. For cities, this would be the center of the downtown, or maybe the location of city hall. For states and countries it might be the capital city. Most feature types will not have a conceptual center – by default, routing will use the centroid of the feature’s geometry. If you need a feature center point consider using GetFeatureGeometryCenter() function from geostore/base/public/feature.h rather than reading from this field directly. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostorePointProto |
| displayData | Data used to render this feature on a map. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreDisplayDataProto |
| detailed3dModel | Geometry Store ID and materialized geometry representing the feature’s physical presence in the world. Like geometry_3d above, but with additional semantic or renderable details, e.g. labeled surfaces (“door”, “window”), material specifications, etc. IMPORTANT: Clients may not write to this field directly; see go/geometry-store-reading-and-writing#writing-to-geometry-store. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreGeometryStoreReferenceProto |
| building | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreBuildingProto | |
| skiTrail | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreSkiTrailProto | |
| elevationModel | Captures elevation data used on TYPE_DIGITAL_ELEVATION_MODEL features. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreElevationModelProto |
| syntheticGeometry | We prefer features that have geometry over those that do not. In some cases we synthesize geometry (e.g., polygons for postal codes). This flag is set to indicate features that have such synthetic geometry. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | boolean |
| polygonForDisplay | Provide version of the geometry suitable for display. This has been subject to water removal and (possibly) moderate simplification. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostorePolygonProto |
| logicalBorder | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreLogicalBorderProto | |
| polyline | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | list(GeostorePolyLineProto) | |
| laneMarker | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreLaneMarkerProto | |
| entrance | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreEntranceProto | |
| geometryPrecisionMeters | If set, the feature’s actual location can be assumed to be somewhere within a circle of this radius, centered on the feature’s location. More information on this field at go/gpm-definition-update. NOTE: Only applicable to features with ‘point’ geometry. Please contact geo-schema-team@ if you have non-point use cases for which this field would be useful. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | float |
| accessPoint | Optional access point information. Access points hold detailed information about routing endpoints. For example, the main Google office is at “1600 Amphitheatre Parkway”. The feature representing that office has a polygon, a center, and an address with components for the street number, route, locality, etc. The access point information, on the other hand, identifies the specific segment, the latitude/longitude of the driveway, and so forth. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | list(GeostoreAccessPointProto) |
| rankDetails | The rank field is computed as a weighted sum of several signals. This field contains a protocol buffer whose fields give those signals and their weights. Clients should try very hard not to depend on these individual signals and use the single rank field instead. At some point in the future, this field will not be exposed anymore. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreRankDetailsProto |
| metadata | Metadata about this particular feature. Metadata is managed internally by the Geo Data Infrastructure and in general should not be set by clients. Features that don’t ultimately come from the Geo repository (MapFacts) won’t have any metadata set. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreFeatureMetadataProto |
| kgProperty | Properties that apply to this feature whose schema is defined in the Knowledge Graph schema (see https://hume.google.com/graph/schema). Not all properties that exist in the KG schema can be asserted via this mechanism. The set of properties that are allowed to be set on a feature depends on the feature’s GConcepts (and feature type). For instance, only gcid:country features may have the /geo/type/country/president property (made up example, since that property doesn’t actually exist in the KG schema). GConcept hierarchy is taken into account for deciding the set of allowed properties. Additionally, the specific properties allowed are further constrained by the list specified at go/kg-property-allowlist. NOTE: not all types of properties are allowed to appear in the Geo Schema. For now, we limit ourselves to properties whose value type is TYPE_BOOL, TYPE_COMPOUND, TYPE_DATETIME, TYPE_FLOAT, TYPE_ID, TYPE_INT, TYPE_NESTED_STRUCT, TYPE_TEXT, or TYPE_URI. NOTE(b/35039936): We are in the process of changing how a KG property with multiple values is stored in this field. Currently, such a KG property is stored in a single instance of the kg_property field. However, we will be changing this so that each value will be stored in its own instance of kg_property. Any client that wants to read from this field should be prepared to read data represented in either format. See b/35039936 or the announcement at http://g/geo-schema-announce/7IXR3Fex8to/7yFyT5UoAwAJ for an example and more details. The mechanism to assert that a KG property has no value is via the property_value_status field below. freebase.PropertyValue.value_status is not allowed be set here for consistency reason. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | list(FreebasePropertyValue) |
| relatedFeature | Geographic or logical relationships to other features. Importers don’t need to fill a geographic relationship in – it is handled by related feature processing by a standalone pipeline. Adding “contained by” country relations is however encouraged (and required for TYPE_ROUTE features). WARNING: Updates to this field handled by standalone pipelines are NOT atomic with regard to updates to the features being referenced; we do not guarantee that a given MapFacts snapshot will be consistent between this field and the related features. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | list(GeostoreRelationProto) |
| visualizationArea | Geometry Store ID and materialized geometry representing a bounding box of the feature’s geometry (or the building/grounds a POI occupies) for stylized rendering, UX experiences, etc. IMPORTANT: Clients may not write to this field directly; see go/geometry-store-reading-and-writing#writing-to-geometry-store. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreGeometryStoreReferenceProto |
| inferredGeometry | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreInferredGeometryProto | |
| attachment | The collection of attachments for this feature. Documentation: http://go/geo-attachments | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | list(GeostoreAttachmentsAttachmentProto) |
| associatedEvChargingStation | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | list(GeostoreFeatureIdProto) | |
| locale | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreLocaleProto | |
| skiLift | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreSkiLiftProto | |
| intersectionGroup | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreIntersectionGroupProto | |
| polygon | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | list(GeostorePolygonProto) | |
| sign | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreRoadSignProto | |
| skiBoundary | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreSkiBoundaryProto | |
| relatedTerminalPoint | Terminal points associated with this feature. For instance, an airport terminal may have specifically designated pickup and drop-off points. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | list(GeostoreFeatureIdProto) |
| sourceInfo | A list of the data sources that were used to construct this feature, together with optional “raw data” in the provider’s format. Raw data should not be used by production clients but may be useful for exploring data that is not currently converted to a canonical form. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | list(GeostoreSourceInfoProto) |
| restrictionGroup | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreRestrictionGroupProto | |
| futureGeometryFor | Specifies the feature that this feature’s geometry will replace. If this field is populated, the referenced feature must have a future_geometry reference back to this feature. This field is only allowed (and required) for TYPE_FUTURE_GEOMETRY features. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreFeatureIdProto |
| transitLine | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreTransitLineProto | |
| segment | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreSegmentProto | |
| track | Defines the geometry of a feature as a sequence of 6D poses, including lat, lng, altitude, roll, pitch, and yaw. Only lat and lng are typically required. Each track has an index so that they can be viewed in a stable order. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | list(GeostoreTrackProto) |
| businessChain | Data specific to business chain features, e.g., Canonical GConcepts. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreBusinessChainProto |
| geopolitical | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreGeopoliticalProto | |
| geometry3d | Geometry Store ID and materialized geometry representing the feature’s physical shape in the world. IMPORTANT: Clients may not write to this field directly; see go/geometry-store-reading-and-writing#writing-to-geometry-store. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreGeometryStoreReferenceProto |
| point | Defines the geometry of the feature. The geometry may be specified as an arbitrary union of points, poses, polylines, tracks, and polygons. Points, poses, polylines, and tracks are assumed to represent regions of unspecified size or width rather than regions of zero area. Most features should have some sort of geometry. Geometry may be synthesized if none is available (e.g., polygons for postal codes). The synthetic_geometry flag should be set in that case. Point is currently enforced as a non-repeating field for all feature types, though it is defined as repeating in case future modeling requires multiple points. The number of allowed polylines, tracks, or polygons vary based on feature type. A feature can have at most one pose (it is an optional field). | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | list(GeostorePointProto) |
| transitLineVariant | RESERVED | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreTransitLineVariantProto |
| interiorCovering | S2 interior covering that consists of cells completely enclosed within the feature’s geometry (for features with polygonal geometry). | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreCellCoveringProto |
| roadMonitor | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreRoadMonitorProto | |
| bestLocale | Describes the best-match locale for this feature. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreBestLocaleProto |
| child | Features can define themselves as a collection of other features. For example, a route is a collection of road segments, and a feature for the “Great Lakes” could be defined as lakes Superior, Michigan, Huron, Erie, and Ontario. It is not recommended to design a multi level tree using the child field to build up a feature because it requires fetching many features to see the details of the feature. In practice this is used to model archipelago, route, transit (agencies, lines, trips, departures), and river features. The geometry of a feature is implicitly defined by its children, so if a feature has children then it should not have any points, polylines, or polygons. In general, this field should not be used to represent political or postal hierarchies. For example, a county would not list its cities as children, because the county is not defined in terms of its cities (it also contains unincorporated areas, etc.). | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | list(GeostoreFeatureIdProto) |
| establishment | Also allowed on TYPE_BUSINESS_CHAIN and TYPE_TRANSIT_AGENCY features, to model the feature’s phone number(s). Other fields within EstablishmentProto are not permitted on non-TYPE_ESTABLISHMENT features. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreEstablishmentProto |
| storefrontGeometry | Represents information about the store front geometry. Only TYPE_ESTABLISHMENT_POI should have this field set. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | list(GeostoreAnchoredGeometryProto) |
| website | The official website of this feature. Stored as a repeated field to allow for multilingual official websites (see comments in url.proto). | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | list(GeostoreUrlProto) |
| propertyValueStatus | The value status of properties on this feature. For example, this specifies whether the feature is known to have no name (this is the value status of the ‘FEATURE_NAME’ property). Only property IDs which have no specific value are allowed to have a value status. Note: not all field types will be supported, please contact geo schema team if you want to enable this field for a field type that is not currently supported. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | list(GeostorePropertyValueStatusProto) |
| socialReference | All establishments must have a social reference. WARNING: Aside from creating new establishments, please do NOT introduce new uses; treat social references as if they were deprecated. For alternatives and more, see g3doc/company/teams/gdeng/geo-schema-reference/home/feature-types/establishments/social-reference.md. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreSocialReferenceProto |
| tollPath | Represents information about /geo/type/toll_path features. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreTollPathProto |
| route | Additional details on the feature types below can be found in the individual protocol buffer definitions. These extensions capture data that is specific to a set of feature types and which makes no sense for other feature types. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreRouteProto |
| parking | Describes parking details for the feature. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreParkingProto |
| knowledgeGraphReference | RESERVED | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreKnowledgeGraphReferenceProto |
| border | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreBorderProto | |
| tollCluster | Represents information about TYPE_TOLL_CLUSTER features. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreTollClusterProto |
| political | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostorePoliticalProto | |
| transitStation | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreTransitStationProto | |
| rawGconceptInstanceContainer | Geo Ontology GConcept Instances – Design doc linked off http://go/geo-ontology – In order to shield clients from changes in GConcept representation we provide an accessor library: geostore/base/public/gconcept_instance.h | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreOntologyRawGConceptInstanceContainerProto |
| internal | Data for this feature that is less about the feature and more about other data in the feature. For example, it might be data about the rights we have to other data in this FeatureProto, or MapFacts-internal shape IDs for this feature’s polygons. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreInternalFeatureProto |
| threeDimModel | Captures full model representing the feature’s 3D geometry. Should only be found on TYPE_COMPOUND_BUILDING features for now, but not part of the BuildingProto extension for possible future extensions. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreThreeDimensionalModelProto |
| temporaryData | A place for clients to attach arbitrary data to a feature. Never set in MapFacts. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | Proto2BridgeMessageSet |
| originalId | This field is used internally by the pipeline for id stability. It should not be set by individual importers, nor should it be read by consumer clients. In particular, this field will not be present in features read or snapshotted from the Mapfacts Repository. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreFeatureIdProto |
| relatedBorder | For TYPE_COUNTRY or TYPE_ADMINISTRATIVE_AREA1 features, this field defines the associated TYPE_BORDERs which reference this feature. The linked TYPE_BORDERs must have the feature.border set, pointing to this feature. TYPE_COUNTRY or TYPE_ADMINISTRATIVE_AREA1 features must have this field set for each TYPE_BORDER referencing them. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | list(GeostoreFeatureIdProto) |
| preferredViewport | The preferred viewport for this feature. If present, this latitude-longitude rectangle holds the preferred viewport for the feature. For example, it might hold the bounds of the “central” portion of a large city. There are no aspect ratio requirements. This is an optional field: if no viewport is supplied, interested clients can use heuristics to determine a viewport. Calling the standard GetFeatureGeometryBound() function would be a good way to start but note that it can return an empty bounding box (e.g., if the feature has no geometry). The preferred viewport is not necessarily fully contained by the above bounding box. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreRectProto |
| futureGeometry | Specifies the TYPE_FUTURE_GEOMETRY whose geometry will replace this feature’s geometry. If this field is populated, the referenced future geometry must have a future_geometry_for referencing this feature. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreFeatureIdProto |
| intersection | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreIntersectionProto | |
| segmentPath | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreSegmentPathProto | |
| exemptRegulatedArea | A list of feature ids of polygon based restrictions that do not apply to this feature. This may only include features of TYPE_REGULATED_AREA that also have a feature.regulated_area.restriction field defined. Setting this field opts the feature out of all restrictions set on that regulated area. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | list(GeostoreFeatureIdProto) |
| disputedArea | Represents information about disputed areas. Only TYPE_DISPUTED_AREA features should have the field set. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreDisputedAreaProto |
| level | Represents information about TYPE_LEVEL features. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreLevelProto |
| operations | Information about this feature’s operations, e.g. when this feature is temporarily closed. NOTE: for legacy reasons, some closure-specifc information (e.g. permanent closure reason) lives in ExistenceProto instead. In the future, such information should move here in OperationsProto. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreOperationsProto |
| waterRemovedPolygon | A version of the geometry which has water removed but is not simplified (thus having equal or more vertices than polygon_for_display). | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostorePolygonProto |
| dataSource | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreDataSourceProto | |
| type | The type of this feature — see comments above. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | String |
| pose | Defines the geometry of a feature as a 6D pose, including lat, lng, altitude, roll, pitch, and yaw along the WGS-84 ellipsoid. Only the lat and lng are strictly required. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostorePoseProto |
| attribute | ** DEPRECATED ** A list of attributes that describe defined aspects of this feature. An attribute must be a concrete, high quality, and editable piece of information about a feature, and must be used on some general consumer facing Google property. The data types used for attributes must be primitive types or reusable in a generic manner. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | list(GeostoreAttributeProto) |
| covering | S2 cell coverings for this feature. See util/geometry/s2cell_union.h for more information about S2 cells. Coverings are useful for quick containment or intersection tests. S2 covering that consists of cells that intersect with the feature. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreCellCoveringProto |
| schoolDistrict | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreSchoolDistrictProto | |
| status | All features can have “existence” information associated with them. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreExistenceProto |
| parent | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | list(GeostoreFeatureIdProto) | |
| address | Address for this feature. A Geo Schema address is designed to model a mailing address, so only features that have mailing addresses in the real world may have addresses. Each feature should have only one address. If you want to describe the geographic location of a feature which does not have a mailing address with respect to other well-known features, some other schema constructs should be used. Note that the field is defined as repeated though features that use this field with its intended semantics are constrained to have a single address even if they may have multiple mailing addresses in the real world. The “single address” rule is enforced by lint. Current exceptions to the single address rule and mailing address rule are described in the g3doc. Bear note that the schema team is actively working on eliminating these exceptions. http://go/geo-addresses Note the following conventions: – Addresses follow the postal hierarchy, not the political hierarchy. Addresses may have components that refer to political entities when those entities also appear in the postal hierarchy. – As stated previously, but it bears repeating, addresses on features are mailing addresses. In many cases the physical address and the mailing address are the same but the address stored on a feature represents the mailing address of the feature. An example of a non-physical mailing address would be a PO Box. – These addresses are commonly defined and verifiable by a governmental authority (e.g. the United States Postal Service in the United States, Royal Mail in the United Kingdom, Correios in Brazil, etc.) and should follow conventions and rules defined by those authorities. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | list(GeostoreAddressProto) |
| rank | WARNING: Please do NOT introduce new uses of this field; treat it as if it were deprecated. For appropriate ranking contacts, see g3doc/company/teams/gdeng/geo-schema-reference/home/feature-properties/rank.md. A floating-point number between 0.0 and 1.0 indicating how “important” we think this feature is. This can be used to decide which features to render on maps, and how to rank results when the user does a search. The rank can depend on any number of factors such as the number of references to this feature in web pages, geographic size, population, number of referring geographic entities, “priority” information encoded in the source data, etc. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | number |
| id | The globally unique id for this feature. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreFeatureIdProto |
| anchoredGeometry | Represents information about the feature’s anchored geometry. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreAnchoredGeometryProto |
| htmlText | ** DEPRECATED ** Features can have zero or more HTML texts associated with them. These might be HTML balloons used by Google Earth, for example. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | list(GeostoreHtmlTextProto) |
| regulatedArea | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreRegulatedAreaProto | |
| relatedEntrance | Logical relationship to other features that are entrances or exits to this feature. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | list(GeostoreEntranceReferenceProto) |
| bound | A latitude-longitude rectangle used by bucketing MapReduces. See the documentation on bucketing MapReduce for details. This field can be a source of confusion. Because it is called “bound”, it is often assumed that it is a tight bound on the geometry but it can be (and often is) much larger. If a tight bound is needed then use the standard GetFeatureGeometryBound() function instead. To be more explicit, if you are using this field for *anything* else than a bucketing MapReduce, you are doing the wrong thing. Not all features are required to have bounding boxes. See geostore::IsBoundRequiredForFeatureType() for the list of feature types required to have a bounding box. This bound field will be updated when a feature changes in MapFacts to include its geometry. Also, a GeoSchema pipeline, go/geo-schema-pipelines-docs#expand-bounds runs periodically to update the field for strong references from other features. Therefore, most editors don’t need to edit this field explicitly. See go/geo-changes:no-edit-for-feature-bound for the details. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreRectProto |
| elevation | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreElevationProto | |
| verticalOrdering | Represents vertical ordering for this feature relative to other geometrically-overlaping features. See go/aboutgrades for more information about distinction among different levels. | GeostoreFeatureProto | Every entry in the GeoStore database is called a “feature”. A feature is represented as a discriminated union of all the different feature types, where the actual feature type is specified by the “type” field. There are also various fields that are meaningful for most or all feature types, such as bounding regions and names. Every feature has a globally unique id that can be used to refer to it from other features. | GeostoreVerticalOrderingProto |
| derivedFrom | This feature was created to replace other features that are referenced by this field. | GeostoreFeatureReplacementInfoProto | Metadata to track feature derivations and replacements. This is used to track feature provenance (particularly for road segments). | list(GeostoreFeatureIdProto) |
| replacedBy | This feature was replaced by other features that are referenced by this this field. | GeostoreFeatureReplacementInfoProto | Metadata to track feature derivations and replacements. This is used to track feature provenance (particularly for road segments). | list(GeostoreFeatureIdProto) |
| internal | GeostoreFieldMetadataProto | Internal field metadata. This part is not exposed to downstream consumers of the repository (read-only clients) but is available to upstream providers to the repository (read-write clients). | GeostoreInternalFieldMetadataProto | |
| attributeId | **DEPRECATED** Never set. | GeostoreFieldWithRightsProto | Proto used to represent rights for a feature property id. See go/geo-rights for more details. NOTE: Use google3/geostore/provenance/public/rights.h or google3/java/com/google/geostore/provenance/rights/Rights.java instead of accessing this proto directly. | String |
| featurePropertyId | The feature property id for which this entry tracks rights. | GeostoreFieldWithRightsProto | Proto used to represent rights for a feature property id. See go/geo-rights for more details. NOTE: Use google3/geostore/provenance/public/rights.h or google3/java/com/google/geostore/provenance/rights/Rights.java instead of accessing this proto directly. | GeostoreFeaturePropertyIdProto |
| fieldType | **DEPRECATED** The field type for which this entry tracks rights. There may be multiple entries for the same field type – prefer feature_property_id to uniquely identify a particular entry. | GeostoreFieldWithRightsProto | Proto used to represent rights for a feature property id. See go/geo-rights for more details. NOTE: Use google3/geostore/provenance/public/rights.h or google3/java/com/google/geostore/provenance/rights/Rights.java instead of accessing this proto directly. | integer |
| minRightsLevel | The minimum rights level among all current values for this feature property id. | GeostoreFieldWithRightsProto | Proto used to represent rights for a feature property id. See go/geo-rights for more details. NOTE: Use google3/geostore/provenance/public/rights.h or google3/java/com/google/geostore/provenance/rights/Rights.java instead of accessing this proto directly. | String |
| curvature | RESERVED | GeostoreFlowLineProto | Wrapper to hold data related to a lane’s track, extendable for future data. | GeostoreCurvatureProto |
| track | GeostoreFlowLineProto | Wrapper to hold data related to a lane’s track, extendable for future data. | GeostoreTrackProto | |
| allergenAbsent | GeostoreFoodMenuItemOptionProto | Example: the choice of chicken, beef, or tofu for the Thai Basil dish. Each option would have its own name, price, allergen info, etc. Note: This proto stores both food and service items despite the name. | list(String) | |
| allergenPresent | GeostoreFoodMenuItemOptionProto | Example: the choice of chicken, beef, or tofu for the Thai Basil dish. Each option would have its own name, price, allergen info, etc. Note: This proto stores both food and service items despite the name. | list(String) | |
| calories | GeostoreFoodMenuItemOptionProto | Example: the choice of chicken, beef, or tofu for the Thai Basil dish. Each option would have its own name, price, allergen info, etc. Note: This proto stores both food and service items despite the name. | integer | |
| ingredients | Ingredients of the food dish option. | GeostoreFoodMenuItemOptionProto | Example: the choice of chicken, beef, or tofu for the Thai Basil dish. Each option would have its own name, price, allergen info, etc. Note: This proto stores both food and service items despite the name. | list(GeostoreFoodMenuItemOptionProtoIngredient) |
| media | Photos of the food dish option. | GeostoreFoodMenuItemOptionProto | Example: the choice of chicken, beef, or tofu for the Thai Basil dish. Each option would have its own name, price, allergen info, etc. Note: This proto stores both food and service items despite the name. | list(GeostoreMediaItemProto) |
| nameInfo | The repeated name_info field here is for item options with names or descriptions listed in multiple languages. When an item option has no names or descriptions, the size of the repeated field name_info may be 0. For example, when a food menu item does not have multiple options, the item option proto is used only to specify price and nutritional information, so it will not have a name_info field. There should be at most one name_info for any given language. | GeostoreFoodMenuItemOptionProto | Example: the choice of chicken, beef, or tofu for the Thai Basil dish. Each option would have its own name, price, allergen info, etc. Note: This proto stores both food and service items despite the name. | list(GeostorePriceListNameInfoProto) |
| nutritionFacts | Nutrition facts of the food dish option. Note that it also includes calories information with a finer defined unit information. | GeostoreFoodMenuItemOptionProto | Example: the choice of chicken, beef, or tofu for the Thai Basil dish. Each option would have its own name, price, allergen info, etc. Note: This proto stores both food and service items despite the name. | GeostorePriceInfoFoodNutritionFacts |
| portionSize | Size of the order, represented in units of items. (e.g. 4 “skewers”, 6 “pieces”) | GeostoreFoodMenuItemOptionProto | Example: the choice of chicken, beef, or tofu for the Thai Basil dish. Each option would have its own name, price, allergen info, etc. Note: This proto stores both food and service items despite the name. | GeostoreFoodMenuItemOptionProtoPortionSize |
| preparationMethods | Methods on how the food dish option is prepared. | GeostoreFoodMenuItemOptionProto | Example: the choice of chicken, beef, or tofu for the Thai Basil dish. Each option would have its own name, price, allergen info, etc. Note: This proto stores both food and service items despite the name. | list(String) |
| price | We use PriceRangeProto here but we expect the lower_price and upper_price to be both set to equal numbers because an option should have a single price. This field is not required because food item prices may be variable depending on season. | GeostoreFoodMenuItemOptionProto | Example: the choice of chicken, beef, or tofu for the Thai Basil dish. Each option would have its own name, price, allergen info, etc. Note: This proto stores both food and service items despite the name. | GeostorePriceRangeProto |
| restriction | GeostoreFoodMenuItemOptionProto | Example: the choice of chicken, beef, or tofu for the Thai Basil dish. Each option would have its own name, price, allergen info, etc. Note: This proto stores both food and service items despite the name. | list(String) | |
| servesNumPeople | Number of people can be served by this food dish option. | GeostoreFoodMenuItemOptionProto | Example: the choice of chicken, beef, or tofu for the Thai Basil dish. Each option would have its own name, price, allergen info, etc. Note: This proto stores both food and service items despite the name. | integer |
| spiciness | GeostoreFoodMenuItemOptionProto | Example: the choice of chicken, beef, or tofu for the Thai Basil dish. Each option would have its own name, price, allergen info, etc. Note: This proto stores both food and service items despite the name. | String | |
| nameInfo | The repeated name_info field is for the ingredient in multiple languages. | GeostoreFoodMenuItemOptionProtoIngredient | This message denotes an ingredient information of a food dish. | list(GeostorePriceListNameInfoProto) |
| quantity | Required. | GeostoreFoodMenuItemOptionProtoPortionSize | This message denotes the serving portion size of a food dish. | integer |
| unit | Required. The repeated name_info field is for the unit in multiple languages. | GeostoreFoodMenuItemOptionProtoPortionSize | This message denotes the serving portion size of a food dish. | list(GeostorePriceListNameInfoProto) |
| itemOption | GeostoreFoodMenuItemProto | A food menu item must have a name although it can have multiple names in different languages. Example: Thai Basil. Price for this item is specified in the item_option field. Since the price of an item may be unknown, e.g. seasonal price, there is nothing that requires an item_option to be present in the FoodMenuItemProto. | list(GeostoreFoodMenuItemOptionProto) | |
| nameInfo | The repeated name_info field is for items listed in multiple languages. | GeostoreFoodMenuItemProto | A food menu item must have a name although it can have multiple names in different languages. Example: Thai Basil. Price for this item is specified in the item_option field. Since the price of an item may be unknown, e.g. seasonal price, there is nothing that requires an item_option to be present in the FoodMenuItemProto. | list(GeostorePriceListNameInfoProto) |
| gconceptId | The unique identifier of a GConcept (e.g. “gcid:railway”). | GeostoreGConceptInstanceProto | A GConceptInstanceProto contains a GConceptID (which is the unique identifier of a GConcept, a category in the Geo Ontology). | String |
| metadata | Field-level metadata for this GConcept. | GeostoreGConceptInstanceProto | A GConceptInstanceProto contains a GConceptID (which is the unique identifier of a GConcept, a category in the Geo Ontology). | GeostoreFieldMetadataProto |
| prominence | The relative prominence of this category to this feature according to the data provider, as one of the values from the enum above. Prominence is a measure of how well the given GConcept describes the feature. An example is a gas station with convenience store and ATM. All three GConcepts are very relevant, but the gas_station GConcept is the most prominent. If the prominence of this GConcept is unknown, this field should not be set. | GeostoreGConceptInstanceProto | A GConceptInstanceProto contains a GConceptID (which is the unique identifier of a GConcept, a category in the Geo Ontology). | String |
| excludesGeometryOf | Features whose geometry to exclude while composing the geometry of this feature. | GeostoreGeometryComposition | Encapsulates all the features which, together, define the geometry of a feature. This happens by: 1. taking the union of all polygons of features referenced in includes_geometry_of 2. subtracting the polygons of all the features referenced in excludes_geometry_of | list(GeostoreFeatureIdProto) |
| includesGeometryOf | Features whose geometry to include while composing the geometry of this feature. | GeostoreGeometryComposition | Encapsulates all the features which, together, define the geometry of a feature. This happens by: 1. taking the union of all polygons of features referenced in includes_geometry_of 2. subtracting the polygons of all the features referenced in excludes_geometry_of | list(GeostoreFeatureIdProto) |
| footprint | Geometry (in STGeography format) materialized from the footprint field of the Geometry Store record associated with the geometry_id referenced above. | GeostoreGeometryStoreReferenceProto | A Geometry Store ID and, in some contexts, geometry materialized from the record associated with that ID. | String |
| geometry | Geometry materialized from the full_fidelity_proto field of the Geometry Store record associated with the geometry_id referenced above. | GeostoreGeometryStoreReferenceProto | A Geometry Store ID and, in some contexts, geometry materialized from the record associated with that ID. | GeostoreCityJsonProto |
| geometryId | The ID of a record in the Geometry Store. | GeostoreGeometryStoreReferenceProto | A Geometry Store ID and, in some contexts, geometry materialized from the record associated with that ID. | String |
| restOfWorldPolygon | The unsimplified, water-subtracted polygon representing the feature’s geometry as viewed by the rest of the world, which may differ from its default polygon, for example by excluding certain regions. | GeostoreGeopoliticalGeometryProto | Geopolitical (unsimplified) polygons for a feature for different geopolitical use cases. See go/unsimplified-poly. | GeostorePolygonProto |
| selfPolygon | The unsimplified, water-subtracted polygon representing the feature’s geometry as viewed by the country that administers it, which may differ from its default polygon, for example by including disputed areas. | GeostoreGeopoliticalGeometryProto | Geopolitical (unsimplified) polygons for a feature for different geopolitical use cases. See go/unsimplified-poly. | GeostorePolygonProto |
| conveysAttributionTo | If present, some aspect of this feature (usually name or geometry) can signify ownership of the area by the region specified. The string, if present, will be a region code. E.g., suppose a TYPE_POSTAL_CODE feature has a Russian format in Crimea (which is disputed by Ukraine), then this field would be set to “RU”. | GeostoreGeopoliticalProto | This protocol buffer is used to store geopolitical information about the feature that override the base state of the feature. For example, the name of the feature from different regions’ POV. This protocol buffer can be used on any feature involved in a geopolitical situation and is not limited to TYPE_POLITICAL features. | String |
| regionSpecificName | Any specific handling of this feature’s name from different regions’ POVs. This field can only contain up to one name per region/language combination (each of which would be a separate RegionSpecificNameProto). | GeostoreGeopoliticalProto | This protocol buffer is used to store geopolitical information about the feature that override the base state of the feature. For example, the name of the feature from different regions’ POV. This protocol buffer can be used on any feature involved in a geopolitical situation and is not limited to TYPE_POLITICAL features. | list(GeostoreRegionSpecificNameProto) |
| regionalPolygonAdjustment | Adjustments to the base polygon of this feature to construct a region-specific view. In general, this field is edited only by go/mf-triggers based on the data written to regional_polygon_composing_claims. This field should only be directly edited if there are region-specific adjustments that cannot be represented using the geometry of this feature’s claims, but note that anything written to this field will be overwritten by go/mf-triggers if regional_polygon_composing_claims is ever edited. See go/geopolitical-geometry-schema for more information. | GeostoreGeopoliticalProto | This protocol buffer is used to store geopolitical information about the feature that override the base state of the feature. For example, the name of the feature from different regions’ POV. This protocol buffer can be used on any feature involved in a geopolitical situation and is not limited to TYPE_POLITICAL features. | list(GeostoreGeopoliticalProtoRegionalPolygonAdjustmentProto) |
| regionalPolygonComposingClaims | Feature’s claim(s) which compose the region-specific polygon. This composition will be used by go/mf-triggers to compose the specified region’s view of this feature’s geometry. The difference between that polygon and this feature’s base polygon will be stored in regional_polygon_adjustment below. Edits to this field will overwrite anything already stored in regional_polygon_adjustment. See go/geopolitical-geometry-schema for more information. | GeostoreGeopoliticalProto | This protocol buffer is used to store geopolitical information about the feature that override the base state of the feature. For example, the name of the feature from different regions’ POV. This protocol buffer can be used on any feature involved in a geopolitical situation and is not limited to TYPE_POLITICAL features. | list(GeostoreGeopoliticalProtoRegionalPolygonComposingClaimsProto) |
| polygonToAdd | Polygon to add to the feature’s base polygon to get the view for the given region. Applied after polygon_to_subtract, such that any region contained in both polygons WILL be part of the final result. | GeostoreGeopoliticalProtoRegionalPolygonAdjustmentProto | Raw polygon adjustments to apply to this feature’s base polygon to construct a specific region’s view of this feature’s polygon. | GeostorePolygonProto |
| polygonToSubtract | Polygon to subtract from the feature’s base polygon to get the view for the given region. | GeostoreGeopoliticalProtoRegionalPolygonAdjustmentProto | Raw polygon adjustments to apply to this feature’s base polygon to construct a specific region’s view of this feature’s polygon. | GeostorePolygonProto |
| regionCode | Region code (or other identifier) for the region. | GeostoreGeopoliticalProtoRegionalPolygonAdjustmentProto | Raw polygon adjustments to apply to this feature’s base polygon to construct a specific region’s view of this feature’s polygon. | String |
| regionCode | Region code (or other identifier) for the region. | GeostoreGeopoliticalProtoRegionalPolygonComposingClaimsProto | The polygon composition recipe for a specific region’s view of this feature’s geometry, based on disputed area claims asserted by this country. Note that the included / excluded claims listed for a given region’s view of this feature may not match up exactly with which claims the region recognizes / does not recognize for this feature. Claims may only be included or excluded for regions that themselves are a party to the dispute, i.e. a region’s view of itself will include its own claims, and a region’s view of another feature will exclude its own claims. See current Geopolitical policy at go/geopolitical-policy-primer. | String |
| regionExcludedClaims | TYPE_DISPUTED_AREAs claimed by this feature excluded from this region’s view of the feature’s geometry. (The TDAs must have polygonal geometry and be referenced in this feature’s political.claim field.) The polygons of these claims will be subtracted to this feature’s base polygon when this feature is viewed from the specified region. | GeostoreGeopoliticalProtoRegionalPolygonComposingClaimsProto | The polygon composition recipe for a specific region’s view of this feature’s geometry, based on disputed area claims asserted by this country. Note that the included / excluded claims listed for a given region’s view of this feature may not match up exactly with which claims the region recognizes / does not recognize for this feature. Claims may only be included or excluded for regions that themselves are a party to the dispute, i.e. a region’s view of itself will include its own claims, and a region’s view of another feature will exclude its own claims. See current Geopolitical policy at go/geopolitical-policy-primer. | list(GeostoreFeatureIdProto) |
| regionIncludedClaims | TYPE_DISPUTED_AREAs claimed by this feature and included in this region’s view of the feature’s geometry. (The TDAs must have polygonal geometry and be referenced in this feature’s political.claim field.) The polygons of these claims will be added to this feature’s base polygon when this feature is viewed from the specified region. | GeostoreGeopoliticalProtoRegionalPolygonComposingClaimsProto | The polygon composition recipe for a specific region’s view of this feature’s geometry, based on disputed area claims asserted by this country. Note that the included / excluded claims listed for a given region’s view of this feature may not match up exactly with which claims the region recognizes / does not recognize for this feature. Claims may only be included or excluded for regions that themselves are a party to the dispute, i.e. a region’s view of itself will include its own claims, and a region’s view of another feature will exclude its own claims. See current Geopolitical policy at go/geopolitical-policy-primer. | list(GeostoreFeatureIdProto) |
| index | The index of the point along the segment, where 0 is the starting point. This means that the index of a point along a segment and its sibling will be different. | GeostoreGradeLevelProto | The grade level of a segment represents the relative altitude of the segment at a particular point along the segment. This level is in relation to other segments at the same point. For example, you might have a freeway at level = 0 and an overpass at level = 2. Vertical segments are represented by a polyline containing only 1 vertex and exactly two grade_level in segment.proto whose indices are 0. grade_level(0) represents the relative height at the start point of the segments, and grade_level(1) represents the one at the end point. | integer |
| level | The grade level of the indexed point. The grade level can be thought of as a relative vertical ordering with respect to other segments at the same point, where larger/more positive numbers are “higher”. Negative grade level values are allowed and are typically used for points below grade level (0 is a common choice to represent the level of points at the ground level). For vertical segments, the height, i.e. the vertical length, is represented by difference of levels in millimeters. For example, feature.segment().grade_level(0).level() == 0 and feature.segment().grade_level(1).level() == 5000, then the length of the vertical segment feature is 5000 millimeters (5 meters). | GeostoreGradeLevelProto | The grade level of a segment represents the relative altitude of the segment at a particular point along the segment. This level is in relation to other segments at the same point. For example, you might have a freeway at level = 0 and an overpass at level = 2. Vertical segments are represented by a polyline containing only 1 vertex and exactly two grade_level in segment.proto whose indices are 0. grade_level(0) represents the relative height at the start point of the segments, and grade_level(1) represents the one at the end point. | integer |
| text | Zero or more texts of the specified type, in various languages. If this is a HTML_DESCRIPTION blob then these texts would hold the description in English, German, and so forth. The text is an HTML fragment, not a full page. The fragment should be suitable for including in a DIV. It must have balanced HTML tags. It may use HTML’s “class” attributes to assign classes to HTML elements. This allows the HTML to be formatted by an (external) style sheet. The HTML should not have embedded style sheet definitions, nor should it have embedded JavaScript. | GeostoreHtmlTextProto | Represents HTML text associated with a feature. | list(GeostoreLanguageTaggedTextProto) |
| type | GeostoreHtmlTextProto | Represents HTML text associated with a feature. | String | |
| definesGeometryFor | Features whose geometry depends on this feature’s geometry. | GeostoreInferredGeometryProto | Inferred geometry defines the geometry of a feature as the union or exclusion of the geometry of other features. For instance, the geometry of a timezone can be specified as the union of all the countries it applies to. In this scenario, the timezone will can be considered a “composite feature”, while the countries are its “composing features”. A composite feature must have a bidirectional reference between itself and all its composing features. A composite feature refers to its composing features via `geometry_composition`, while the composing features must refer back to the composing feature via `defines_geometry_for`. See: go/inferred-geometry and go/geo-schema:composite-geometry-editor for more details. | list(GeostoreFeatureIdProto) |
| geometryComposition | Features whose geometry defines the geometry of this feature (i.e. “composing features”). | GeostoreInferredGeometryProto | Inferred geometry defines the geometry of a feature as the union or exclusion of the geometry of other features. For instance, the geometry of a timezone can be specified as the union of all the countries it applies to. In this scenario, the timezone will can be considered a “composite feature”, while the countries are its “composing features”. A composite feature must have a bidirectional reference between itself and all its composing features. A composite feature refers to its composing features via `geometry_composition`, while the composing features must refer back to the composing feature via `defines_geometry_for`. See: go/inferred-geometry and go/geo-schema:composite-geometry-editor for more details. | GeostoreGeometryComposition |
| polygonShapeId | A unique identifier for this feature’s polygon data which is being held externally in Shapestore (see go/shapestore). | GeostoreInternalFeatureProto | InternalFeatureProto represents fields for data that are more about other data within the FeatureProto than about the feature itself. This could be data that’s set by editors directly(ish) (e.g. trust or rights data), or data set internally by MapFacts based on other data (e.g. polygon shape IDs). | String |
| restOfWorldPolygonShapeId | A unique identifier for this feature’s rest-of-world view polygon data which is being held externally in Shapestore (see go/shapestore). This is part of the feature’s geopolitical geometry. | GeostoreInternalFeatureProto | InternalFeatureProto represents fields for data that are more about other data within the FeatureProto than about the feature itself. This could be data that’s set by editors directly(ish) (e.g. trust or rights data), or data set internally by MapFacts based on other data (e.g. polygon shape IDs). | String |
| rightsStatus | Per-field rights for this feature. See http://g3doc/geostore/g3doc/developers-guide/inputs/rights-tracking for more information. | GeostoreInternalFeatureProto | InternalFeatureProto represents fields for data that are more about other data within the FeatureProto than about the feature itself. This could be data that’s set by editors directly(ish) (e.g. trust or rights data), or data set internally by MapFacts based on other data (e.g. polygon shape IDs). | GeostoreRightsStatusProto |
| selfPolygonShapeId | A unique identifier for this feature’s self view polygon data which is being held externally in Shapestore (see go/shapestore). This is part of the feature’s geopolitical geometry. | GeostoreInternalFeatureProto | InternalFeatureProto represents fields for data that are more about other data within the FeatureProto than about the feature itself. This could be data that’s set by editors directly(ish) (e.g. trust or rights data), or data set internally by MapFacts based on other data (e.g. polygon shape IDs). | String |
| trust | Trust signals/annotations for the feature. In an input feature, these signals are computed at the beginning of the pipeline and are immutable during the processing. In output features, this proto may define the rules/criteria that a newer edit should meet, in order to be applied. | GeostoreInternalFeatureProto | InternalFeatureProto represents fields for data that are more about other data within the FeatureProto than about the feature itself. This could be data that’s set by editors directly(ish) (e.g. trust or rights data), or data set internally by MapFacts based on other data (e.g. polygon shape IDs). | GeostoreTrustSignalsProto |
| waterRemovedPolygonShapeId | A unique identifier for this feature’s water-removed polygon data which is being held externally in Shapestore (see go/shapestore). | GeostoreInternalFeatureProto | InternalFeatureProto represents fields for data that are more about other data within the FeatureProto than about the feature itself. This could be data that’s set by editors directly(ish) (e.g. trust or rights data), or data set internally by MapFacts based on other data (e.g. polygon shape IDs). | String |
| isAuto | Whether or not the piece of data has been generated automatically (i.e., by a bot/automated process based on heuristics/algorithms rather than coming as a fact set by some human user or data provider based on their knowledge). Note that this does NOT imply that the value was set as a result of a bot operation on the repository, since it is conceivable to use a bot/automated process simply as a way of convenience to ingest large amount of canonical/ground truth data. | GeostoreInternalFieldMetadataProto | boolean | |
| sourceSummary | Information about the source providing the piece of data this metadata is attached to. | GeostoreInternalFieldMetadataProto | GeostoreInternalSourceSummaryProto | |
| disallowedConnections | A list of lane connections that are explicitly not allowed to be added. NOTE: This should never reference existing lane connections on this segment. | GeostoreInternalSegmentProto | Internal-only proto used to express additional information about segments. This is intended for communicating extra information between editing clients and the repository, and should not be used by or visible to clients. WARNING – if you add new fields to InternalSegmentProto, make sure that geostore/tools/internal/mr-mergesegments_test.cc is aware of them. | list(GeostoreInternalSegmentProtoLaneConnectionReference) |
| disallowedPrimaryConnection | A list of lane connections which cannot have the primary_connection bit set. | GeostoreInternalSegmentProto | Internal-only proto used to express additional information about segments. This is intended for communicating extra information between editing clients and the repository, and should not be used by or visible to clients. WARNING – if you add new fields to InternalSegmentProto, make sure that geostore/tools/internal/mr-mergesegments_test.cc is aware of them. | list(GeostoreInternalSegmentProtoLaneConnectionReference) |
| travelAllowance | The set of restrictions that apply to this segment; these are actually *POSITIVE* restrictions, i.e. they are known to be allowed. | GeostoreInternalSegmentProto | Internal-only proto used to express additional information about segments. This is intended for communicating extra information between editing clients and the repository, and should not be used by or visible to clients. WARNING – if you add new fields to InternalSegmentProto, make sure that geostore/tools/internal/mr-mergesegments_test.cc is aware of them. | list(GeostoreRestrictionProto) |
| fromLaneNumber | The lane number on this segment. | GeostoreInternalSegmentProtoLaneConnectionReference | Specifies a single outgoing lane connection. | integer |
| segment | This reference to the other segment is weak, since strong would blow up bounds of all segments. | GeostoreInternalSegmentProtoLaneConnectionReference | Specifies a single outgoing lane connection. | GeostoreFeatureIdProto |
| toLaneNumber | This is the lane number on the target segment. | GeostoreInternalSegmentProtoLaneConnectionReference | Specifies a single outgoing lane connection. | integer |
| dataset | Within the above provider, the dataset from which this piece of data was generated. For fields that are auto-generated the “dataset” is likely to be some algorithm’s or program’s name. Similar to SourceInfoProto.dataset but with the difference that it is required to always be set. Providers that don’t have a concept of dataset may use “default”. | GeostoreInternalSourceSummaryProto | String | |
| provider | The data provider from which this piece of data was generated. Equivalent to SourceInfoProto.provider in the public schema. | GeostoreInternalSourceSummaryProto | String | |
| childGroup | All artifact intersection groups that are in this logical group. | GeostoreIntersectionGroupProto | Our TYPE_INTERSECTION features model the point where one or more segments terminate. This is topological definition: it may not match what a typical user would think of as an “intersection”. Consider the intersections where Hayes, Market, Larkin, and 9th Street meet near (37.77765, -122.41638) in San Francisco. Most people would probably consider this a single feature, even though we model it as four separate TYPE_INTERSECTION features. The TYPE_INTERSECTION_GROUP is used to model the user’s concept of a real-world intersection, which also includes turn lanes or a whole roundabout (a logical intersection). For the purposes of modeling turn restrictions and lane connections, a smaller grouping is needed to model the “core” part of the intersection where there are no lane markings. This is called a core or artifact group. An intersection group must contain at least two intersections or add some information (e.g. a name or a polygon) compared to the intersection itself, or else must not exist. The standard feature properties are interpreted as follows: name – Can be used to specify any “special” names associated with this intersection (e.g. Reads Corner intersection, PEI, Canada). Intersections that are named according to their cross streets do not need to specify this field, since this can be determined by looking at the routes associated with each segment. address – This should always be empty. point – Specifies the center of the intersection. This is basically the point where the intersection name should be rendered. Can be omitted in favor of a polygon. polyline – This should always be empty. polygon – Specifies the two-dimensional extent of the intersection. This may substitute to the point field, though having a center set is desirable in this case. child – This should always be empty. | list(GeostoreFeatureIdProto) |
| groupType | GeostoreIntersectionGroupProto | Our TYPE_INTERSECTION features model the point where one or more segments terminate. This is topological definition: it may not match what a typical user would think of as an “intersection”. Consider the intersections where Hayes, Market, Larkin, and 9th Street meet near (37.77765, -122.41638) in San Francisco. Most people would probably consider this a single feature, even though we model it as four separate TYPE_INTERSECTION features. The TYPE_INTERSECTION_GROUP is used to model the user’s concept of a real-world intersection, which also includes turn lanes or a whole roundabout (a logical intersection). For the purposes of modeling turn restrictions and lane connections, a smaller grouping is needed to model the “core” part of the intersection where there are no lane markings. This is called a core or artifact group. An intersection group must contain at least two intersections or add some information (e.g. a name or a polygon) compared to the intersection itself, or else must not exist. The standard feature properties are interpreted as follows: name – Can be used to specify any “special” names associated with this intersection (e.g. Reads Corner intersection, PEI, Canada). Intersections that are named according to their cross streets do not need to specify this field, since this can be determined by looking at the routes associated with each segment. address – This should always be empty. point – Specifies the center of the intersection. This is basically the point where the intersection name should be rendered. Can be omitted in favor of a polygon. polyline – This should always be empty. polygon – Specifies the two-dimensional extent of the intersection. This may substitute to the point field, though having a center set is desirable in this case. child – This should always be empty. | String | |
| intersection | The list of TYPE_INTERSECTION features that form this intersection group, but are NOT in any of this group’s child groups. This could be an empty list, though that is sub-optimal. Even an empty list would allow the paint team to draw a label for a named intersection, but a non-empty list would, for example, enable PathFinder to generate better directions. Each of the TYPE_INTERSECTION feature referred here must refer back to this feature in its IntersectionProto. | GeostoreIntersectionGroupProto | Our TYPE_INTERSECTION features model the point where one or more segments terminate. This is topological definition: it may not match what a typical user would think of as an “intersection”. Consider the intersections where Hayes, Market, Larkin, and 9th Street meet near (37.77765, -122.41638) in San Francisco. Most people would probably consider this a single feature, even though we model it as four separate TYPE_INTERSECTION features. The TYPE_INTERSECTION_GROUP is used to model the user’s concept of a real-world intersection, which also includes turn lanes or a whole roundabout (a logical intersection). For the purposes of modeling turn restrictions and lane connections, a smaller grouping is needed to model the “core” part of the intersection where there are no lane markings. This is called a core or artifact group. An intersection group must contain at least two intersections or add some information (e.g. a name or a polygon) compared to the intersection itself, or else must not exist. The standard feature properties are interpreted as follows: name – Can be used to specify any “special” names associated with this intersection (e.g. Reads Corner intersection, PEI, Canada). Intersections that are named according to their cross streets do not need to specify this field, since this can be determined by looking at the routes associated with each segment. address – This should always be empty. point – Specifies the center of the intersection. This is basically the point where the intersection name should be rendered. Can be omitted in favor of a polygon. polyline – This should always be empty. polygon – Specifies the two-dimensional extent of the intersection. This may substitute to the point field, though having a center set is desirable in this case. child – This should always be empty. | list(GeostoreFeatureIdProto) |
| parentGroup | Parent logical intersection group. An artifact group that does not have an associated parent logical group is assumed to be both an artifact and logical group. | GeostoreIntersectionGroupProto | Our TYPE_INTERSECTION features model the point where one or more segments terminate. This is topological definition: it may not match what a typical user would think of as an “intersection”. Consider the intersections where Hayes, Market, Larkin, and 9th Street meet near (37.77765, -122.41638) in San Francisco. Most people would probably consider this a single feature, even though we model it as four separate TYPE_INTERSECTION features. The TYPE_INTERSECTION_GROUP is used to model the user’s concept of a real-world intersection, which also includes turn lanes or a whole roundabout (a logical intersection). For the purposes of modeling turn restrictions and lane connections, a smaller grouping is needed to model the “core” part of the intersection where there are no lane markings. This is called a core or artifact group. An intersection group must contain at least two intersections or add some information (e.g. a name or a polygon) compared to the intersection itself, or else must not exist. The standard feature properties are interpreted as follows: name – Can be used to specify any “special” names associated with this intersection (e.g. Reads Corner intersection, PEI, Canada). Intersections that are named according to their cross streets do not need to specify this field, since this can be determined by looking at the routes associated with each segment. address – This should always be empty. point – Specifies the center of the intersection. This is basically the point where the intersection name should be rendered. Can be omitted in favor of a polygon. polyline – This should always be empty. polygon – Specifies the two-dimensional extent of the intersection. This may substitute to the point field, though having a center set is desirable in this case. child – This should always be empty. | GeostoreFeatureIdProto |
| intersectionGroup | The artifact or logical intersection group to which this intersection belongs. If present, the intersection group must also refer back to the intersection. If an intersection is within both the artifact and logical group, then this reference should be to the artifact group. | GeostoreIntersectionProto | A TYPE_INTERSECTION feature represents a common endpoint of one or more segments in a transportation network at which the segments are connected. An intersection in the real world may be more complicated than that (e.g., comprise multiple segment endpoints or have extra attributes), which can be modeled with an additional TYPE_INTERSECTION_GROUP feature, if needed (see intersectiongroup.proto). The standard feature properties are interpreted as follows: name – This should always be empty. Intersections that have a “special” name (e.g. Reads Corner intersection, PEI, Canada) should point to a separate TYPE_INTERSECTION_GROUP feature that captures it. Intersections which are named according to their cross streets do not need this requirement, since their name can be determined by looking at the routes associated with each segment. address – This should always be empty. point – Specifies the center of the intersection. This should be the last vertex of all the segments which terminate at this intersection. polyline – This should always be empty. polygon – This should always be empty. child – This should always be empty. | GeostoreFeatureIdProto |
| outSegment | RESERVED | GeostoreIntersectionProto | A TYPE_INTERSECTION feature represents a common endpoint of one or more segments in a transportation network at which the segments are connected. An intersection in the real world may be more complicated than that (e.g., comprise multiple segment endpoints or have extra attributes), which can be modeled with an additional TYPE_INTERSECTION_GROUP feature, if needed (see intersectiongroup.proto). The standard feature properties are interpreted as follows: name – This should always be empty. Intersections that have a “special” name (e.g. Reads Corner intersection, PEI, Canada) should point to a separate TYPE_INTERSECTION_GROUP feature that captures it. Intersections which are named according to their cross streets do not need this requirement, since their name can be determined by looking at the routes associated with each segment. address – This should always be empty. point – Specifies the center of the intersection. This should be the last vertex of all the segments which terminate at this intersection. polyline – This should always be empty. polygon – This should always be empty. child – This should always be empty. | list(GeostoreFeatureIdProto) |
| segment | The list of segments that terminate at this intersection, in any order. Note that all segments are directed towards the intersection, i.e. their endpoints indicate what sort of intersection this is. This should not be empty because an intersection with no associated segment is meaningless. | GeostoreIntersectionProto | A TYPE_INTERSECTION feature represents a common endpoint of one or more segments in a transportation network at which the segments are connected. An intersection in the real world may be more complicated than that (e.g., comprise multiple segment endpoints or have extra attributes), which can be modeled with an additional TYPE_INTERSECTION_GROUP feature, if needed (see intersectiongroup.proto). The standard feature properties are interpreted as follows: name – This should always be empty. Intersections that have a “special” name (e.g. Reads Corner intersection, PEI, Canada) should point to a separate TYPE_INTERSECTION_GROUP feature that captures it. Intersections which are named according to their cross streets do not need this requirement, since their name can be determined by looking at the routes associated with each segment. address – This should always be empty. point – Specifies the center of the intersection. This should be the last vertex of all the segments which terminate at this intersection. polyline – This should always be empty. polygon – This should always be empty. child – This should always be empty. | list(GeostoreFeatureIdProto) |
| tollCluster | The toll cluster to which this intersection belongs. If present, the toll cluster must also refer back to the intersection. To set this field, the intersection must be a gcid:toll_intersection feature. | GeostoreIntersectionProto | A TYPE_INTERSECTION feature represents a common endpoint of one or more segments in a transportation network at which the segments are connected. An intersection in the real world may be more complicated than that (e.g., comprise multiple segment endpoints or have extra attributes), which can be modeled with an additional TYPE_INTERSECTION_GROUP feature, if needed (see intersectiongroup.proto). The standard feature properties are interpreted as follows: name – This should always be empty. Intersections that have a “special” name (e.g. Reads Corner intersection, PEI, Canada) should point to a separate TYPE_INTERSECTION_GROUP feature that captures it. Intersections which are named according to their cross streets do not need this requirement, since their name can be determined by looking at the routes associated with each segment. address – This should always be empty. point – Specifies the center of the intersection. This should be the last vertex of all the segments which terminate at this intersection. polyline – This should always be empty. polygon – This should always be empty. child – This should always be empty. | GeostoreFeatureIdProto |
| duration | Describes how much time the service is going to take, e.g. how long it takes to do a haircut. Value of seconds must be from +60 (1 min) to +31,536,000 (365 days) inclusive. Value of nanos must be zero. | GeostoreJobMetadata | String | |
| jobRelatedCategories | Represents the name of a potential grouping of items. For TYPE_JOB, this is the category names of the categories that a user picked this job type from at the time of input. | GeostoreJobMetadata | list(GeostoreJobRelatedCategory) | |
| jobTypeId | Unique identifier for a job. This is required for standard jobs and blank for free-form jobs. Job type ids are prefixed with “job_type_id:”. Notice this is a unique string representation of a job across languages. E.g., “job_type_id:air_duct_repair”. The existence of a job_type_id means the job type is a standard one, and has a corresponding entry in the Standard Jobs Taxonomy. | GeostoreJobMetadata | String | |
| jobTypeMid | Represents the MID corresponding to the job_category entity in the Knowledge Graph. For example, job_type_id=”job_type_id:install_faucet”, job_type_mid=”/g/11hzzxjv3f”. | GeostoreJobMetadata | String | |
| gcid | GeostoreJobRelatedCategory | This is the category that a user picked this job type from at the time of input. The field serves two purposes: 1) The name is used in consumer surface similar to the heading name today (i.e., grouping jobs under the category. 2) The gcid is needed mainly for free-formed entries, for which GMB needs to map them to corresponding categories in the frontend, if applicable. Notice that the name and the id are both not expected to be in sync with gcid deprecation or location category change per product decision. In other words, they are not guaranteed to stay in sync, only guaranteed true at time of creation. | String | |
| language | GeostoreJobRelatedCategory | This is the category that a user picked this job type from at the time of input. The field serves two purposes: 1) The name is used in consumer surface similar to the heading name today (i.e., grouping jobs under the category. 2) The gcid is needed mainly for free-formed entries, for which GMB needs to map them to corresponding categories in the frontend, if applicable. Notice that the name and the id are both not expected to be in sync with gcid deprecation or location category change per product decision. In other words, they are not guaranteed to stay in sync, only guaranteed true at time of creation. | String | |
| name | Category name in the primary language of the feature. Generally intended to be used as a fallback when we are unable to fetch the name in the user’s language. | GeostoreJobRelatedCategory | This is the category that a user picked this job type from at the time of input. The field serves two purposes: 1) The name is used in consumer surface similar to the heading name today (i.e., grouping jobs under the category. 2) The gcid is needed mainly for free-formed entries, for which GMB needs to map them to corresponding categories in the frontend, if applicable. Notice that the name and the id are both not expected to be in sync with gcid deprecation or location category change per product decision. In other words, they are not guaranteed to stay in sync, only guaranteed true at time of creation. | String |
| id | KG Identifier (MID). For details, see http://go/ke-bg-knowledge-graph#mids. | GeostoreKnowledgeGraphReferenceProto | The reference to an entity in the KnowledgeGraph. For details on the KnowledgeGraph see http://goto/kg. | String |
| featureType | The type of the landmark feature. Allowed types: – TYPE_CARTOGRAPHIC e.g. a putting green or water hazard – TYPE_COMPOUND e.g. – the Empire state building (TYPE_COMPOUND_BUILDING) – a park (TYPE_COMPOUND_GROUNDS) – a section of a retail store (TYPE_COMPOUND_SECTION) – TYPE_ESTABLISHMENT e.g. – the Eiffel Tower (TYPE_ESTABLISHMENT_BUILDING) – a sports field (TYPE_ESTABLISHMENT_GROUNDS) – Starbucks (TYPE_ESTABLISHMENT_POI) – TYPE_INTERSECTION_GROUP e.g. a major intersection – TYPE_NATURAL_FEATURE e.g. a river – TYPE_SEGMENT e.g. a bike trail or train tracks | GeostoreLandmarkReferenceProto | This protocol buffer represents the association between a segment and a landmark feature. Notes: – References to TYPE_SEGMENT features should always point to the even sibling. – Self-references are allowed but the referencing segment’s sibling is required to have a self-reference as well (the above requirement to always reference the even sibling still applies). | integer |
| landmark | The feature ID of the landmark feature. | GeostoreLandmarkReferenceProto | This protocol buffer represents the association between a segment and a landmark feature. Notes: – References to TYPE_SEGMENT features should always point to the even sibling. – Self-references are allowed but the referencing segment’s sibling is required to have a self-reference as well (the above requirement to always reference the even sibling still applies). | GeostoreFeatureIdProto |
| travelMode | The mode(s) of travel for which this landmark is useful. | GeostoreLandmarkReferenceProto | This protocol buffer represents the association between a segment and a landmark feature. Notes: – References to TYPE_SEGMENT features should always point to the even sibling. – Self-references are allowed but the referencing segment’s sibling is required to have a self-reference as well (the above requirement to always reference the even sibling still applies). | list(String) |
| barrierMaterials | If this is a physical barrier marker, represent materials found on the marker. | GeostoreLaneMarkerProto | This proto contains attributes relevant to physical lane markers. | GeostoreBarrierLogicalMaterialProto |
| crossingPattern | Pattern border and color for crossing markers. These include crosswalks, stop, and yield lines. | GeostoreLaneMarkerProto | This proto contains attributes relevant to physical lane markers. | GeostoreCrossingStripePatternProto |
| linearPattern | Stripe pattern, spacing, and color for longitudinal markers. | GeostoreLaneMarkerProto | This proto contains attributes relevant to physical lane markers. | GeostoreLinearStripePatternProto |
| boundingMarker | References to any gcid:physical_lane_marker features that bound this lane. | GeostoreLaneProto | Describes an individual road lane. Not only driving lanes, but also parking and biking lanes are covered by this. Note that we may eventually add curbs and walking to this schema. MOTIVATION/DESIGN DISCUSSION The intent of this schema is to model a schematic representation of the road for a bunch of use cases within GMM, navigation, map tiles. For rendering, we do not want to represent the geometry of each lane exactly, but do want to model types/width/gaps/lane markings so that a schematic rendering can be made. For navigation, we model lane connectivity and restrictions per lane, so that Pathfinder can potentially pick routes based on lanes, and definitely use the lanes to better describe the path to the driver. This schema is driven by the GT team, which is likely to be the only provider of this data. It is based on compromises that we are working out with other teams, based on what our operators can reasonably collect and what is useful. See docs here: https://docs.google.com/a/google.com/document/d/11XJ1WvqS5Sm7MxWXzzc3tnsk49VhrR3BYFjiRMAzYm0/edit?hl=en_US https://docs.google.com/a/google.com/document/d/1nzdupynTUKE8xY8JcfvQbU-KWtCJ6IwHiTaCxuq40EM/edit?hl=en_US Note: Some lane information (width, surface type, etc) may duplicate or contradict information stored at the segment level. | list(GeostoreBoundingMarkerProto) |
| conjoinedCategory | If the current lane is part of a merge/split area, indicates the type (split or merge) and whether the current lane is on the left or right or in the middle of the merge/split area, as seen in the direction of traffic. See go/lane-split-merge-schema | GeostoreLaneProto | Describes an individual road lane. Not only driving lanes, but also parking and biking lanes are covered by this. Note that we may eventually add curbs and walking to this schema. MOTIVATION/DESIGN DISCUSSION The intent of this schema is to model a schematic representation of the road for a bunch of use cases within GMM, navigation, map tiles. For rendering, we do not want to represent the geometry of each lane exactly, but do want to model types/width/gaps/lane markings so that a schematic rendering can be made. For navigation, we model lane connectivity and restrictions per lane, so that Pathfinder can potentially pick routes based on lanes, and definitely use the lanes to better describe the path to the driver. This schema is driven by the GT team, which is likely to be the only provider of this data. It is based on compromises that we are working out with other teams, based on what our operators can reasonably collect and what is useful. See docs here: https://docs.google.com/a/google.com/document/d/11XJ1WvqS5Sm7MxWXzzc3tnsk49VhrR3BYFjiRMAzYm0/edit?hl=en_US https://docs.google.com/a/google.com/document/d/1nzdupynTUKE8xY8JcfvQbU-KWtCJ6IwHiTaCxuq40EM/edit?hl=en_US Note: Some lane information (width, surface type, etc) may duplicate or contradict information stored at the segment level. | String |
| distanceToNextLane | Gap between this lane and the next in meters. This is relevant when the divider is physical, or a wide painted area. For regular painted single or double lines, there is no gap. This distance is duplicated between the innermost lanes for each side. Note that this is not used to describe smallish islands – this is only for long-running gaps. In particular, this models the median width, the gap between HOV lanes/regular lanes on freeways, and the road verge between a curb and sidewalk. Note on split roads: We can model any split road with a median as a single sibling pair with this distance set to the width of the median, or as two one-way sibling pairs. | GeostoreLaneProto | Describes an individual road lane. Not only driving lanes, but also parking and biking lanes are covered by this. Note that we may eventually add curbs and walking to this schema. MOTIVATION/DESIGN DISCUSSION The intent of this schema is to model a schematic representation of the road for a bunch of use cases within GMM, navigation, map tiles. For rendering, we do not want to represent the geometry of each lane exactly, but do want to model types/width/gaps/lane markings so that a schematic rendering can be made. For navigation, we model lane connectivity and restrictions per lane, so that Pathfinder can potentially pick routes based on lanes, and definitely use the lanes to better describe the path to the driver. This schema is driven by the GT team, which is likely to be the only provider of this data. It is based on compromises that we are working out with other teams, based on what our operators can reasonably collect and what is useful. See docs here: https://docs.google.com/a/google.com/document/d/11XJ1WvqS5Sm7MxWXzzc3tnsk49VhrR3BYFjiRMAzYm0/edit?hl=en_US https://docs.google.com/a/google.com/document/d/1nzdupynTUKE8xY8JcfvQbU-KWtCJ6IwHiTaCxuq40EM/edit?hl=en_US Note: Some lane information (width, surface type, etc) may duplicate or contradict information stored at the segment level. | number |
| flow | The most logical path for the center of an object to travel along within the lane. Typically, this is the lane’s center line, but doesn’t have to be. | GeostoreLaneProto | Describes an individual road lane. Not only driving lanes, but also parking and biking lanes are covered by this. Note that we may eventually add curbs and walking to this schema. MOTIVATION/DESIGN DISCUSSION The intent of this schema is to model a schematic representation of the road for a bunch of use cases within GMM, navigation, map tiles. For rendering, we do not want to represent the geometry of each lane exactly, but do want to model types/width/gaps/lane markings so that a schematic rendering can be made. For navigation, we model lane connectivity and restrictions per lane, so that Pathfinder can potentially pick routes based on lanes, and definitely use the lanes to better describe the path to the driver. This schema is driven by the GT team, which is likely to be the only provider of this data. It is based on compromises that we are working out with other teams, based on what our operators can reasonably collect and what is useful. See docs here: https://docs.google.com/a/google.com/document/d/11XJ1WvqS5Sm7MxWXzzc3tnsk49VhrR3BYFjiRMAzYm0/edit?hl=en_US https://docs.google.com/a/google.com/document/d/1nzdupynTUKE8xY8JcfvQbU-KWtCJ6IwHiTaCxuq40EM/edit?hl=en_US Note: Some lane information (width, surface type, etc) may duplicate or contradict information stored at the segment level. | GeostoreFlowLineProto |
| laneConnection | Connections to lanes of other segments at the end of this segment. These connections model the connectivity where you don’t have to do a lane change maneuver. If any lane connection is present, assume that all others are forbidden. Also note that segment level restrictions do apply if present, and can disallow some turn even if the lanes are connected. For instance, this can happen with timed or vehicle type based restrictions on the segment. If lane connectivity implies a segment-level restriction (can’t transition to some target segment), that restriction will also exist as a segment level restriction. In effect – PathFinder does not have to look at lane connectivity to figure out segment connectivity. Example: Typically, lanes are just connected to one other lane. Example: A splitting lane is connected to the two resulting lanes. Example: At an intersection, a lane is connected to crossing lanes according to how lanes are painted across the intersection. In the common case, the target segment will be connected to the same intersection as this segment. That will however NOT be true for complex intersections where there is an intersection group. The connections will be across the whole group, connecting to one of the outgoing segments from the group. This is analogous to how we do turn restrictions around intersection groups. | GeostoreLaneProto | Describes an individual road lane. Not only driving lanes, but also parking and biking lanes are covered by this. Note that we may eventually add curbs and walking to this schema. MOTIVATION/DESIGN DISCUSSION The intent of this schema is to model a schematic representation of the road for a bunch of use cases within GMM, navigation, map tiles. For rendering, we do not want to represent the geometry of each lane exactly, but do want to model types/width/gaps/lane markings so that a schematic rendering can be made. For navigation, we model lane connectivity and restrictions per lane, so that Pathfinder can potentially pick routes based on lanes, and definitely use the lanes to better describe the path to the driver. This schema is driven by the GT team, which is likely to be the only provider of this data. It is based on compromises that we are working out with other teams, based on what our operators can reasonably collect and what is useful. See docs here: https://docs.google.com/a/google.com/document/d/11XJ1WvqS5Sm7MxWXzzc3tnsk49VhrR3BYFjiRMAzYm0/edit?hl=en_US https://docs.google.com/a/google.com/document/d/1nzdupynTUKE8xY8JcfvQbU-KWtCJ6IwHiTaCxuq40EM/edit?hl=en_US Note: Some lane information (width, surface type, etc) may duplicate or contradict information stored at the segment level. | list(GeostoreLaneProtoLaneConnection) |
| laneDividerCrossing | clang-format on Whether the divider to the inside of this lane can be crossed. Note that we assume this is symmetric, and that this also describes whether someone in the next inside lane can cross to this one. The “inside” lane is the one with a lower lane_number. Note on lane markers: We do not model the painting, but only the resulting legality. There are many painted marker styles and colors that lead to the same legality. We expect Paint or Driveabout to render lanes stylized, with solid meaning “can’t cross”, and dashed meaning “can cross”. Note on varying legality along segment: ALLOWED takes precedence – even if some small portion has a restriction (such as right before an intersection) , the lane change will be ALLOWED. | GeostoreLaneProto | Describes an individual road lane. Not only driving lanes, but also parking and biking lanes are covered by this. Note that we may eventually add curbs and walking to this schema. MOTIVATION/DESIGN DISCUSSION The intent of this schema is to model a schematic representation of the road for a bunch of use cases within GMM, navigation, map tiles. For rendering, we do not want to represent the geometry of each lane exactly, but do want to model types/width/gaps/lane markings so that a schematic rendering can be made. For navigation, we model lane connectivity and restrictions per lane, so that Pathfinder can potentially pick routes based on lanes, and definitely use the lanes to better describe the path to the driver. This schema is driven by the GT team, which is likely to be the only provider of this data. It is based on compromises that we are working out with other teams, based on what our operators can reasonably collect and what is useful. See docs here: https://docs.google.com/a/google.com/document/d/11XJ1WvqS5Sm7MxWXzzc3tnsk49VhrR3BYFjiRMAzYm0/edit?hl=en_US https://docs.google.com/a/google.com/document/d/1nzdupynTUKE8xY8JcfvQbU-KWtCJ6IwHiTaCxuq40EM/edit?hl=en_US Note: Some lane information (width, surface type, etc) may duplicate or contradict information stored at the segment level. | String |
| laneFollowsSegmentBeginFraction | These indicate for what portion of the segment the lane’s flowline exactly follows the segment, and the lane is of constant width. This will be set to not include the whole segment where there is a split/turn/merge at either end of the lane. The painting of the lane should completely synthesize the lane geometry outside of this portion, connecting it to neighboring lanes to make graphical nice. | GeostoreLaneProto | Describes an individual road lane. Not only driving lanes, but also parking and biking lanes are covered by this. Note that we may eventually add curbs and walking to this schema. MOTIVATION/DESIGN DISCUSSION The intent of this schema is to model a schematic representation of the road for a bunch of use cases within GMM, navigation, map tiles. For rendering, we do not want to represent the geometry of each lane exactly, but do want to model types/width/gaps/lane markings so that a schematic rendering can be made. For navigation, we model lane connectivity and restrictions per lane, so that Pathfinder can potentially pick routes based on lanes, and definitely use the lanes to better describe the path to the driver. This schema is driven by the GT team, which is likely to be the only provider of this data. It is based on compromises that we are working out with other teams, based on what our operators can reasonably collect and what is useful. See docs here: https://docs.google.com/a/google.com/document/d/11XJ1WvqS5Sm7MxWXzzc3tnsk49VhrR3BYFjiRMAzYm0/edit?hl=en_US https://docs.google.com/a/google.com/document/d/1nzdupynTUKE8xY8JcfvQbU-KWtCJ6IwHiTaCxuq40EM/edit?hl=en_US Note: Some lane information (width, surface type, etc) may duplicate or contradict information stored at the segment level. | number |
| laneFollowsSegmentEndFraction | GeostoreLaneProto | Describes an individual road lane. Not only driving lanes, but also parking and biking lanes are covered by this. Note that we may eventually add curbs and walking to this schema. MOTIVATION/DESIGN DISCUSSION The intent of this schema is to model a schematic representation of the road for a bunch of use cases within GMM, navigation, map tiles. For rendering, we do not want to represent the geometry of each lane exactly, but do want to model types/width/gaps/lane markings so that a schematic rendering can be made. For navigation, we model lane connectivity and restrictions per lane, so that Pathfinder can potentially pick routes based on lanes, and definitely use the lanes to better describe the path to the driver. This schema is driven by the GT team, which is likely to be the only provider of this data. It is based on compromises that we are working out with other teams, based on what our operators can reasonably collect and what is useful. See docs here: https://docs.google.com/a/google.com/document/d/11XJ1WvqS5Sm7MxWXzzc3tnsk49VhrR3BYFjiRMAzYm0/edit?hl=en_US https://docs.google.com/a/google.com/document/d/1nzdupynTUKE8xY8JcfvQbU-KWtCJ6IwHiTaCxuq40EM/edit?hl=en_US Note: Some lane information (width, surface type, etc) may duplicate or contradict information stored at the segment level. | number | |
| laneNumber | Lanes are numbered from inside of the road outward, i.e. the lane next to the center line is lane 0. The lanes then stack outwards, towards the side that one drives on this segment (right or left). NOTE: do NOT use the lane_number as index for lookup. Lane_number is not guaranteed to match the segment.lane repeated field index. | GeostoreLaneProto | Describes an individual road lane. Not only driving lanes, but also parking and biking lanes are covered by this. Note that we may eventually add curbs and walking to this schema. MOTIVATION/DESIGN DISCUSSION The intent of this schema is to model a schematic representation of the road for a bunch of use cases within GMM, navigation, map tiles. For rendering, we do not want to represent the geometry of each lane exactly, but do want to model types/width/gaps/lane markings so that a schematic rendering can be made. For navigation, we model lane connectivity and restrictions per lane, so that Pathfinder can potentially pick routes based on lanes, and definitely use the lanes to better describe the path to the driver. This schema is driven by the GT team, which is likely to be the only provider of this data. It is based on compromises that we are working out with other teams, based on what our operators can reasonably collect and what is useful. See docs here: https://docs.google.com/a/google.com/document/d/11XJ1WvqS5Sm7MxWXzzc3tnsk49VhrR3BYFjiRMAzYm0/edit?hl=en_US https://docs.google.com/a/google.com/document/d/1nzdupynTUKE8xY8JcfvQbU-KWtCJ6IwHiTaCxuq40EM/edit?hl=en_US Note: Some lane information (width, surface type, etc) may duplicate or contradict information stored at the segment level. | integer |
| laneToken | A token that can be used to identify the version of the data about this lane. | GeostoreLaneProto | Describes an individual road lane. Not only driving lanes, but also parking and biking lanes are covered by this. Note that we may eventually add curbs and walking to this schema. MOTIVATION/DESIGN DISCUSSION The intent of this schema is to model a schematic representation of the road for a bunch of use cases within GMM, navigation, map tiles. For rendering, we do not want to represent the geometry of each lane exactly, but do want to model types/width/gaps/lane markings so that a schematic rendering can be made. For navigation, we model lane connectivity and restrictions per lane, so that Pathfinder can potentially pick routes based on lanes, and definitely use the lanes to better describe the path to the driver. This schema is driven by the GT team, which is likely to be the only provider of this data. It is based on compromises that we are working out with other teams, based on what our operators can reasonably collect and what is useful. See docs here: https://docs.google.com/a/google.com/document/d/11XJ1WvqS5Sm7MxWXzzc3tnsk49VhrR3BYFjiRMAzYm0/edit?hl=en_US https://docs.google.com/a/google.com/document/d/1nzdupynTUKE8xY8JcfvQbU-KWtCJ6IwHiTaCxuq40EM/edit?hl=en_US Note: Some lane information (width, surface type, etc) may duplicate or contradict information stored at the segment level. | String |
| metadata | Field-level metadata for this lane. | GeostoreLaneProto | Describes an individual road lane. Not only driving lanes, but also parking and biking lanes are covered by this. Note that we may eventually add curbs and walking to this schema. MOTIVATION/DESIGN DISCUSSION The intent of this schema is to model a schematic representation of the road for a bunch of use cases within GMM, navigation, map tiles. For rendering, we do not want to represent the geometry of each lane exactly, but do want to model types/width/gaps/lane markings so that a schematic rendering can be made. For navigation, we model lane connectivity and restrictions per lane, so that Pathfinder can potentially pick routes based on lanes, and definitely use the lanes to better describe the path to the driver. This schema is driven by the GT team, which is likely to be the only provider of this data. It is based on compromises that we are working out with other teams, based on what our operators can reasonably collect and what is useful. See docs here: https://docs.google.com/a/google.com/document/d/11XJ1WvqS5Sm7MxWXzzc3tnsk49VhrR3BYFjiRMAzYm0/edit?hl=en_US https://docs.google.com/a/google.com/document/d/1nzdupynTUKE8xY8JcfvQbU-KWtCJ6IwHiTaCxuq40EM/edit?hl=en_US Note: Some lane information (width, surface type, etc) may duplicate or contradict information stored at the segment level. | GeostoreFieldMetadataProto |
| restriction | Restrictions that apply to this lane only. Examples include HOV lanes. If a lane restriction implies a segment-level restriction (can’t route on the segment at all), that restriction will also exist as a segment level restriction. In effect – PathFinder does not have to look at lane restrictions to figure out segment restrictions. | GeostoreLaneProto | Describes an individual road lane. Not only driving lanes, but also parking and biking lanes are covered by this. Note that we may eventually add curbs and walking to this schema. MOTIVATION/DESIGN DISCUSSION The intent of this schema is to model a schematic representation of the road for a bunch of use cases within GMM, navigation, map tiles. For rendering, we do not want to represent the geometry of each lane exactly, but do want to model types/width/gaps/lane markings so that a schematic rendering can be made. For navigation, we model lane connectivity and restrictions per lane, so that Pathfinder can potentially pick routes based on lanes, and definitely use the lanes to better describe the path to the driver. This schema is driven by the GT team, which is likely to be the only provider of this data. It is based on compromises that we are working out with other teams, based on what our operators can reasonably collect and what is useful. See docs here: https://docs.google.com/a/google.com/document/d/11XJ1WvqS5Sm7MxWXzzc3tnsk49VhrR3BYFjiRMAzYm0/edit?hl=en_US https://docs.google.com/a/google.com/document/d/1nzdupynTUKE8xY8JcfvQbU-KWtCJ6IwHiTaCxuq40EM/edit?hl=en_US Note: Some lane information (width, surface type, etc) may duplicate or contradict information stored at the segment level. | list(GeostoreRestrictionProto) |
| shared | True if this lane is usable in both directions (left-turn lane, reversing lane, one-lane road, etc). To get the total number of lanes for a road, add up the lanes in each direction counting 0.5 for each shared lane. | GeostoreLaneProto | Describes an individual road lane. Not only driving lanes, but also parking and biking lanes are covered by this. Note that we may eventually add curbs and walking to this schema. MOTIVATION/DESIGN DISCUSSION The intent of this schema is to model a schematic representation of the road for a bunch of use cases within GMM, navigation, map tiles. For rendering, we do not want to represent the geometry of each lane exactly, but do want to model types/width/gaps/lane markings so that a schematic rendering can be made. For navigation, we model lane connectivity and restrictions per lane, so that Pathfinder can potentially pick routes based on lanes, and definitely use the lanes to better describe the path to the driver. This schema is driven by the GT team, which is likely to be the only provider of this data. It is based on compromises that we are working out with other teams, based on what our operators can reasonably collect and what is useful. See docs here: https://docs.google.com/a/google.com/document/d/11XJ1WvqS5Sm7MxWXzzc3tnsk49VhrR3BYFjiRMAzYm0/edit?hl=en_US https://docs.google.com/a/google.com/document/d/1nzdupynTUKE8xY8JcfvQbU-KWtCJ6IwHiTaCxuq40EM/edit?hl=en_US Note: Some lane information (width, surface type, etc) may duplicate or contradict information stored at the segment level. | boolean |
| stopLine | References to any gcid:physical_lane_marker features that intersect this lane, with the implication that a moving vehicle should stop there. | GeostoreLaneProto | Describes an individual road lane. Not only driving lanes, but also parking and biking lanes are covered by this. Note that we may eventually add curbs and walking to this schema. MOTIVATION/DESIGN DISCUSSION The intent of this schema is to model a schematic representation of the road for a bunch of use cases within GMM, navigation, map tiles. For rendering, we do not want to represent the geometry of each lane exactly, but do want to model types/width/gaps/lane markings so that a schematic rendering can be made. For navigation, we model lane connectivity and restrictions per lane, so that Pathfinder can potentially pick routes based on lanes, and definitely use the lanes to better describe the path to the driver. This schema is driven by the GT team, which is likely to be the only provider of this data. It is based on compromises that we are working out with other teams, based on what our operators can reasonably collect and what is useful. See docs here: https://docs.google.com/a/google.com/document/d/11XJ1WvqS5Sm7MxWXzzc3tnsk49VhrR3BYFjiRMAzYm0/edit?hl=en_US https://docs.google.com/a/google.com/document/d/1nzdupynTUKE8xY8JcfvQbU-KWtCJ6IwHiTaCxuq40EM/edit?hl=en_US Note: Some lane information (width, surface type, etc) may duplicate or contradict information stored at the segment level. | list(GeostoreFeatureIdProto) |
| surface | clang-format on LINT.ThenChange(//depot/google3/geostore/base/proto/segment.proto) Unlike the surface in SegmentProto, this field does not have a default value. This is because the lane-level surface overrides the segment-level surface. The lane’s surface should be unset unless explicitly overriding the segment’s surface. | GeostoreLaneProto | Describes an individual road lane. Not only driving lanes, but also parking and biking lanes are covered by this. Note that we may eventually add curbs and walking to this schema. MOTIVATION/DESIGN DISCUSSION The intent of this schema is to model a schematic representation of the road for a bunch of use cases within GMM, navigation, map tiles. For rendering, we do not want to represent the geometry of each lane exactly, but do want to model types/width/gaps/lane markings so that a schematic rendering can be made. For navigation, we model lane connectivity and restrictions per lane, so that Pathfinder can potentially pick routes based on lanes, and definitely use the lanes to better describe the path to the driver. This schema is driven by the GT team, which is likely to be the only provider of this data. It is based on compromises that we are working out with other teams, based on what our operators can reasonably collect and what is useful. See docs here: https://docs.google.com/a/google.com/document/d/11XJ1WvqS5Sm7MxWXzzc3tnsk49VhrR3BYFjiRMAzYm0/edit?hl=en_US https://docs.google.com/a/google.com/document/d/1nzdupynTUKE8xY8JcfvQbU-KWtCJ6IwHiTaCxuq40EM/edit?hl=en_US Note: Some lane information (width, surface type, etc) may duplicate or contradict information stored at the segment level. | String |
| type | clang-format on | GeostoreLaneProto | Describes an individual road lane. Not only driving lanes, but also parking and biking lanes are covered by this. Note that we may eventually add curbs and walking to this schema. MOTIVATION/DESIGN DISCUSSION The intent of this schema is to model a schematic representation of the road for a bunch of use cases within GMM, navigation, map tiles. For rendering, we do not want to represent the geometry of each lane exactly, but do want to model types/width/gaps/lane markings so that a schematic rendering can be made. For navigation, we model lane connectivity and restrictions per lane, so that Pathfinder can potentially pick routes based on lanes, and definitely use the lanes to better describe the path to the driver. This schema is driven by the GT team, which is likely to be the only provider of this data. It is based on compromises that we are working out with other teams, based on what our operators can reasonably collect and what is useful. See docs here: https://docs.google.com/a/google.com/document/d/11XJ1WvqS5Sm7MxWXzzc3tnsk49VhrR3BYFjiRMAzYm0/edit?hl=en_US https://docs.google.com/a/google.com/document/d/1nzdupynTUKE8xY8JcfvQbU-KWtCJ6IwHiTaCxuq40EM/edit?hl=en_US Note: Some lane information (width, surface type, etc) may duplicate or contradict information stored at the segment level. | String |
| width | Width of this lane in meters. In many cases, we will collect this data by dividing the total road width by the number of lanes. On accuracy: This is a rough average width along this segment. If and when we wanted to be more accurate, we’d extend this schema to have full polygons for segments/lanes rather than just this average width. | GeostoreLaneProto | Describes an individual road lane. Not only driving lanes, but also parking and biking lanes are covered by this. Note that we may eventually add curbs and walking to this schema. MOTIVATION/DESIGN DISCUSSION The intent of this schema is to model a schematic representation of the road for a bunch of use cases within GMM, navigation, map tiles. For rendering, we do not want to represent the geometry of each lane exactly, but do want to model types/width/gaps/lane markings so that a schematic rendering can be made. For navigation, we model lane connectivity and restrictions per lane, so that Pathfinder can potentially pick routes based on lanes, and definitely use the lanes to better describe the path to the driver. This schema is driven by the GT team, which is likely to be the only provider of this data. It is based on compromises that we are working out with other teams, based on what our operators can reasonably collect and what is useful. See docs here: https://docs.google.com/a/google.com/document/d/11XJ1WvqS5Sm7MxWXzzc3tnsk49VhrR3BYFjiRMAzYm0/edit?hl=en_US https://docs.google.com/a/google.com/document/d/1nzdupynTUKE8xY8JcfvQbU-KWtCJ6IwHiTaCxuq40EM/edit?hl=en_US Note: Some lane information (width, surface type, etc) may duplicate or contradict information stored at the segment level. | number |
| boundingMarker | References to any gcid:physical_lane_marker features that bound this lane connection. | GeostoreLaneProtoLaneConnection | list(GeostoreBoundingMarkerProto) | |
| connectionToken | A token that can be used to identify the version of the data about this lane connection. | GeostoreLaneProtoLaneConnection | String | |
| curve | Specifies how the flowline should be synthesized in this connection region. If unspecified, heuristics may be used to pick a sweep shape based on retraction values or neighboring curves. | GeostoreLaneProtoLaneConnection | GeostoreCurveConnectionProto | |
| flow | The most logical path for the center of an object to travel along within the lane connection. Typically, this is the lane connection’s center line, but doesn’t have to be. | GeostoreLaneProtoLaneConnection | GeostoreFlowLineProto | |
| laneNumber | This is the lane number on the target segment. This field is not set if the target segment doesn’t have lanes, or we don’t know the exact connectivity. | GeostoreLaneProtoLaneConnection | integer | |
| primaryConnection | True if this connects to the unique, natural continuation of the current lane. At most one LaneConnection per lane can have this field set true. This attribute is of interest to ADAS providers as a hint to which lane a vehicle is likely to follow, in the absence of other information about the vehicle’s planned path. | GeostoreLaneProtoLaneConnection | boolean | |
| segment | This reference to the other segment is weak, since strong would blow up bounds of all segments. | GeostoreLaneProtoLaneConnection | GeostoreFeatureIdProto | |
| yieldToOtherConnections | The inverse of the primary connection bit that provides a hint that this connection is part of a merge and a vehicle following this connection should yield to vehicles following other incoming connections. | GeostoreLaneProtoLaneConnection | boolean | |
| language | The external form of a Google International Identifiers Initiative (III) LanguageCode object. See google3/i18n/identifiers/languagecode.h for details. We place extra restrictions on languages in addition to what the III library requires. See http://go/geo-schema-reference/feature-properties/languages.md | GeostoreLanguageTaggedTextProto | Represents a piece of text with an associated language. | String |
| text | The text (UTF-8 encoding). | GeostoreLanguageTaggedTextProto | Represents a piece of text with an associated language. | String |
| building | The building(s) to which this level belongs. A level will typically belong to a single building, but it is valid for a single level to be shared by multiple buildings (for example, a large underground parking lot). These buildings refer back to the level via another strong reference (the BuildingProto.level field). | GeostoreLevelProto | A feature used to represent a logical level, e.g. floor. A feature belonging to a given level should point to the level feature using relation RELATION_ON_LEVEL. The standard feature properties are interpreted as follows: name – Levels should have names according to the following: * Short, elevator-style names, such as “L” for “Lobby” and “2” for “Second floor”, must be included and must be tagged with FLAG_ABBREVIATED. There must be an unambiguous “best” abbreviated name. * Longer names such as “Ticketing” or “Upper Level” may be present when the level has a specific name. * Non-abbreviated names should only be added if they are known to meaningfully expand upon the abbreviated name. For example, the long name “Observation Deck 2” for the abbreviated name “OD2” is a good additional name. In contrast, the name “Level 2” for the abbreviated name “2” is not desired. address – This should always be empty. point, polyline, polygon, center – These should never be set (since we are representing a logical entity). preferred_viewport – This should be the approximate extent of the level. child – This should always be empty. | list(GeostoreFeatureIdProto) |
| number | The elevation of this level relative to the ground level, in levels. 0 = ground floor (even in locales that call the ground floor “1st floor”); 0.5 = between ground and first floor, eg mezzanine; 1 = first floor (one level above ground floor); -3 = three levels below ground floor. | GeostoreLevelProto | A feature used to represent a logical level, e.g. floor. A feature belonging to a given level should point to the level feature using relation RELATION_ON_LEVEL. The standard feature properties are interpreted as follows: name – Levels should have names according to the following: * Short, elevator-style names, such as “L” for “Lobby” and “2” for “Second floor”, must be included and must be tagged with FLAG_ABBREVIATED. There must be an unambiguous “best” abbreviated name. * Longer names such as “Ticketing” or “Upper Level” may be present when the level has a specific name. * Non-abbreviated names should only be added if they are known to meaningfully expand upon the abbreviated name. For example, the long name “Observation Deck 2” for the abbreviated name “OD2” is a good additional name. In contrast, the name “Level 2” for the abbreviated name “2” is not desired. address – This should always be empty. point, polyline, polygon, center – These should never be set (since we are representing a logical entity). preferred_viewport – This should be the approximate extent of the level. child – This should always be empty. | number |
| line | A linear marker may consist of one or more parallel physical lines. These are ordered left to right along the direction of the marker core polyline. | GeostoreLinearStripePatternProto | list(GeostorePhysicalLineProto) | |
| language | The language associated with this preference. The external form of a Google International Identifiers Initiative (III) LanguageCode object. See google3/i18n/identifiers/languagecode.h for details. We place extra restrictions on languages in addition to what the III library requires. See http://go/geo-schema-reference/feature-properties/languages.md | GeostoreLocaleLanguageProto | This message describes the details of a single language within a locale. | String |
| official | Flag to indicate if the associated language is “official” within a locale. | GeostoreLocaleLanguageProto | This message describes the details of a single language within a locale. | boolean |
| preference | This value represents the preference of the associated language within a locale. It must be between 0.0 and 1.0. | GeostoreLocaleLanguageProto | This message describes the details of a single language within a locale. | number |
| speakingPercent | Percentage of population that can speak the associated language within a locale. It must be between 0 and 100. | GeostoreLocaleLanguageProto | This message describes the details of a single language within a locale. | number |
| writingPercent | Percentage of population that can write the associated language within a locale. It must be between 0 and 100. | GeostoreLocaleLanguageProto | This message describes the details of a single language within a locale. | number |
| language | This holds the list of languages spoken within a locale. | GeostoreLocaleProto | A locale is a meta-feature that describes the geographic extent of localization preferences such as the local language, and formatting conventions for numbers, dates and monetary values. Multilingual areas may be contained by multiple locales. We try to model locales fine-grained enough for deciding which languages are typically used within a city. For example, while French is an official language for all of Switzerland, we would prefer to have Zurich contained by a separate (more fine-grained) Swiss-German locale indicating that German, not French, is the predominantly spoken language in this city. Note that language borders are frequently considered a political question and often don’t have clearly defined extents. For example, California has a significant Spanish-speaking population, but Spanish is not an official language of California. | list(GeostoreLocaleLanguageProto) |
| localizationPolicyId | The ID of the localization policy (from googledata/geostore/localization/localization_policies.textpb) to apply to features that have this locale as their best match locale. Localization policy IDs are arbitrary identifiers that uniquely distinguish a set of language-selection rules. | GeostoreLocaleProto | A locale is a meta-feature that describes the geographic extent of localization preferences such as the local language, and formatting conventions for numbers, dates and monetary values. Multilingual areas may be contained by multiple locales. We try to model locales fine-grained enough for deciding which languages are typically used within a city. For example, while French is an official language for all of Switzerland, we would prefer to have Zurich contained by a separate (more fine-grained) Swiss-German locale indicating that German, not French, is the predominantly spoken language in this city. Note that language borders are frequently considered a political question and often don’t have clearly defined extents. For example, California has a significant Spanish-speaking population, but Spanish is not an official language of California. | String |
| borderSegment | All the border segments which make up this logical border. Border segments must be TYPE_BORDER features which have the same left/right features. This is a many-to-many bidirectional relationship, so any border segment within this list might be part of another logical border. | GeostoreLogicalBorderProto | A logical border is a grouping of border features, which together model a divide between two regions. The borders within this grouping share common attributes, such as the regions they divide, and may represent a conceptual group of borders, of which may be wholly disputed, wholly undisputed, or a mixture of disputed and undisputed. Note that any borders within this group may be part of multiple logical borders. A logical border is required to have a name describing what the grouping represents (e.g. “US – Mexico Border”, “Kosovo – Serbia Border (Disputed)”). | list(GeostoreFeatureIdProto) |
| status | The logical border status identifies its legal status. This is similar to the BorderStatus present within border segments, but applies to the group as a whole. | GeostoreLogicalBorderProto | A logical border is a grouping of border features, which together model a divide between two regions. The borders within this grouping share common attributes, such as the regions they divide, and may represent a conceptual group of borders, of which may be wholly disputed, wholly undisputed, or a mixture of disputed and undisputed. Note that any borders within this group may be part of multiple logical borders. A logical border is required to have a name describing what the grouping represents (e.g. “US – Mexico Border”, “Kosovo – Serbia Border (Disputed)”). | String |
| googleUrl | The FIFE url associated with the media. NOTE: This FIFE URL must be PII-free, see go/product-catalogue-photo-storage | GeostoreMediaItemProto | Media item attached to an element of price list. | String |
| mediaFormat | GeostoreMediaItemProto | Media item attached to an element of price list. | String | |
| mediaKey | The mediaKey associated with the media. NOTE: This media key must be PII-free, see go/product-catalogue-photo-storage | GeostoreMediaItemProto | Media item attached to an element of price list. | String |
| mediaSize | GeostoreMediaItemProto | Media item attached to an element of price list. | GeostoreMediaItemProtoMediaSize | |
| originalHeightPx | GeostoreMediaItemProtoMediaSize | Width and height of the original photo in pixels. | integer | |
| originalWidthPx | GeostoreMediaItemProtoMediaSize | Width and height of the original photo in pixels. | integer | |
| flag | clang-format on The set of flags that apply to this name. | GeostoreNameProto | A name for a Feature (street name, point of interest, city, building, etc). We currently use NameProto for two essentially disjoint purposes: 1. Common names, which can be language-specific, or have other kinds of variations. 2. Opaque IDs, such as postal codes, which only have the `text` field set, and potentially some flags. This includes internal-only features like template ids. Each NameProto representing a common name corresponds to an assertion that a fluent speaker or writer of a language would recognize NameProto.text to name the given feature in that language. As such, NameProtos are stored in a repeated field, often having: 1. multiple names with the same text and varying languages, and 2. multiple names with the same language and varying texts. | list(String) |
| language | The external form of a Google International Identifiers Initiative (III) LanguageCode object. See google3/i18n/identifiers/languagecode.h for details. These strings should be treated as opaque blobs. You can use LanguageCodeConverter::FromOther to convert the string to a LanguageCode reference. You can then call methods on the LanguageCode class to extract language/script/region subtags (if any). See also http://g3doc/i18n/identifiers/g3doc/using-iii. We place extra restrictions on languages in addition to what the III library requires. See go/geo-schema-reference/feature-properties/languages. This field may be missing if the name does not have a concept of language but should be set if the language is unknown. | GeostoreNameProto | A name for a Feature (street name, point of interest, city, building, etc). We currently use NameProto for two essentially disjoint purposes: 1. Common names, which can be language-specific, or have other kinds of variations. 2. Opaque IDs, such as postal codes, which only have the `text` field set, and potentially some flags. This includes internal-only features like template ids. Each NameProto representing a common name corresponds to an assertion that a fluent speaker or writer of a language would recognize NameProto.text to name the given feature in that language. As such, NameProtos are stored in a repeated field, often having: 1. multiple names with the same text and varying languages, and 2. multiple names with the same language and varying texts. | String |
| metadata | Field-level metadata for this name. NOTE: there are multiple NameProto fields in the Geo Schema. Metadata here is only expected to be present on FeatureProto.name[]. | GeostoreNameProto | A name for a Feature (street name, point of interest, city, building, etc). We currently use NameProto for two essentially disjoint purposes: 1. Common names, which can be language-specific, or have other kinds of variations. 2. Opaque IDs, such as postal codes, which only have the `text` field set, and potentially some flags. This includes internal-only features like template ids. Each NameProto representing a common name corresponds to an assertion that a fluent speaker or writer of a language would recognize NameProto.text to name the given feature in that language. As such, NameProtos are stored in a repeated field, often having: 1. multiple names with the same text and varying languages, and 2. multiple names with the same language and varying texts. | GeostoreFieldMetadataProto |
| rawText | ** DEPRECATED ** The name text provided in the original source data (UTF-8 encoding). This is the text provided in the source data unmodified with the exception of being converted to UTF-8 and stripping extra leading, trailing and duplicate whitespaces (if necessary). | GeostoreNameProto | A name for a Feature (street name, point of interest, city, building, etc). We currently use NameProto for two essentially disjoint purposes: 1. Common names, which can be language-specific, or have other kinds of variations. 2. Opaque IDs, such as postal codes, which only have the `text` field set, and potentially some flags. This includes internal-only features like template ids. Each NameProto representing a common name corresponds to an assertion that a fluent speaker or writer of a language would recognize NameProto.text to name the given feature in that language. As such, NameProtos are stored in a repeated field, often having: 1. multiple names with the same text and varying languages, and 2. multiple names with the same language and varying texts. | String |
| shortText | The short name text (UTF-8 encoding). Acronyms/abbreviations should be consistently used, for example “NE 57th St” rather than “Northeast 57th Street”, “N.E 57th St.” or some other variant. This field should be populated with the chosen canonical version of the shortened name, based on per-term transformations. For feature specific abbreviations (such as ‘CA’ for ‘California’), one should define a separate name with FLAG_ABBREVIATED set. For other variants of the shortened name that are not the canonical one, devise client based logic (ex: query rewriting rules). | GeostoreNameProto | A name for a Feature (street name, point of interest, city, building, etc). We currently use NameProto for two essentially disjoint purposes: 1. Common names, which can be language-specific, or have other kinds of variations. 2. Opaque IDs, such as postal codes, which only have the `text` field set, and potentially some flags. This includes internal-only features like template ids. Each NameProto representing a common name corresponds to an assertion that a fluent speaker or writer of a language would recognize NameProto.text to name the given feature in that language. As such, NameProtos are stored in a repeated field, often having: 1. multiple names with the same text and varying languages, and 2. multiple names with the same language and varying texts. | String |
| temporaryData | A place for clients to attach arbitrary data to a name. Never set in MapFacts. | GeostoreNameProto | A name for a Feature (street name, point of interest, city, building, etc). We currently use NameProto for two essentially disjoint purposes: 1. Common names, which can be language-specific, or have other kinds of variations. 2. Opaque IDs, such as postal codes, which only have the `text` field set, and potentially some flags. This includes internal-only features like template ids. Each NameProto representing a common name corresponds to an assertion that a fluent speaker or writer of a language would recognize NameProto.text to name the given feature in that language. As such, NameProtos are stored in a repeated field, often having: 1. multiple names with the same text and varying languages, and 2. multiple names with the same language and varying texts. | Proto2BridgeMessageSet |
| text | The name text (UTF-8 encoding). Acronyms/abbreviations should be fully expanded, for example “Northeast 57th Street” rather than “NE 57th St”. They can be shortened at display or geocode time. This decision prevents ambiguity over such issues as whether “St” represents “Street” or “Saint”. However, it pushes language-specific knowledge into code. We will have libraries and data files to contract acronyms/abbreviations at run-time. | GeostoreNameProto | A name for a Feature (street name, point of interest, city, building, etc). We currently use NameProto for two essentially disjoint purposes: 1. Common names, which can be language-specific, or have other kinds of variations. 2. Opaque IDs, such as postal codes, which only have the `text` field set, and potentially some flags. This includes internal-only features like template ids. Each NameProto representing a common name corresponds to an assertion that a fluent speaker or writer of a language would recognize NameProto.text to name the given feature in that language. As such, NameProtos are stored in a repeated field, often having: 1. multiple names with the same text and varying languages, and 2. multiple names with the same language and varying texts. | String |
| instance | GeostoreOntologyRawGConceptInstanceContainerProto | The container for all GConceptInstances associated with a feature. | list(GeostoreOntologyRawGConceptInstanceProto) | |
| instance | This is the ‘public’ section of the GConceptInstance. | GeostoreOntologyRawGConceptInstanceProto | A RawGConceptInstanceProto contains all data required by both internal and external clients. We store the ‘public’ data in a GConceptInstanceProto and the ‘private’ data inside of RawGConceptInstanceProto. NOTE: this doesn’t really match the design we want anymore. Please talk to the Geo Schema team if you are planning to make use of the “private” fields below. | GeostoreGConceptInstanceProto |
| isAddedByEdit | ** DEPRECATED ** Was this GConcept explicitly added by an edit? Examples of gconcepts not added by edits include those inferred through geo ontology and those mapped from legacy category forms by the feature updater. Note that it is possible for both is_added_by_edit and is_inferred to be true – it means this gconcept is added by an edit and there is also another more fine-grained gconcept added by an edit. | GeostoreOntologyRawGConceptInstanceProto | A RawGConceptInstanceProto contains all data required by both internal and external clients. We store the ‘public’ data in a GConceptInstanceProto and the ‘private’ data inside of RawGConceptInstanceProto. NOTE: this doesn’t really match the design we want anymore. Please talk to the Geo Schema team if you are planning to make use of the “private” fields below. | boolean |
| isInferred | RESERVED | GeostoreOntologyRawGConceptInstanceProto | A RawGConceptInstanceProto contains all data required by both internal and external clients. We store the ‘public’ data in a GConceptInstanceProto and the ‘private’ data inside of RawGConceptInstanceProto. NOTE: this doesn’t really match the design we want anymore. Please talk to the Geo Schema team if you are planning to make use of the “private” fields below. | boolean |
| provider | ** DEPRECATED ** These two fields combined describe the source of a GConceptInstance. They are based on geostore/base/proto/datasourceprovider.proto. Their use has been deprecated. Use the FieldMetadataProto inside instance instead. | GeostoreOntologyRawGConceptInstanceProto | A RawGConceptInstanceProto contains all data required by both internal and external clients. We store the ‘public’ data in a GConceptInstanceProto and the ‘private’ data inside of RawGConceptInstanceProto. NOTE: this doesn’t really match the design we want anymore. Please talk to the Geo Schema team if you are planning to make use of the “private” fields below. | String |
| sourceDataset | GeostoreOntologyRawGConceptInstanceProto | A RawGConceptInstanceProto contains all data required by both internal and external clients. We store the ‘public’ data in a GConceptInstanceProto and the ‘private’ data inside of RawGConceptInstanceProto. NOTE: this doesn’t really match the design we want anymore. Please talk to the Geo Schema team if you are planning to make use of the “private” fields below. | String | |
| exception | Date delimited exceptions to the typical recurring opening hours. May only be present if regular weekly hours are also specified. | GeostoreOpeningHoursProto | Message to represent opening hours including regular weekly hours and a set of exceptions. | list(GeostoreExceptionalHoursProto) |
| regularHours | Typical recurring opening hours, expressed as a weekly schedule. NOTE: this field was introduced to have a more client-friendly format for representing weekly hours but, as of November 2018, it’s not used for the main opening hours of TYPE_ESTABLISHMENT features (instead, the data is stored in the `EstablishmentProto.hours` field, see b/23105782 tracking the possible schema migration). It is however used in other contexts where `OpeningHoursProto` appears in the Geo Schema. In openinghours.h there is a utility function `GetOpeningHoursFromFeature` that merges `EstablishmentProto.hours` into this proto. | GeostoreOpeningHoursProto | Message to represent opening hours including regular weekly hours and a set of exceptions. | GeostoreBusinessHoursProto |
| temporaryClosure | Records temporary status changes of the feature, such as remodel, vacation, etc.: the feature is temporarily (but not permanently) unavailable. See go/geo-schema-reference:operational-lifecycle#temporary-closure for guidance on interpreting this data and constraints on writing it. NOTE: Order of the TemporaryClosureProtos is *not* guaranteed to be chronological. | GeostoreOperationsProto | Information about a feature’s operations, e.g. when the feature is temporarily closed. | list(GeostoreTemporaryClosureProto) |
| countryCode | The two-letter ISO 3166-1 country code corresponding to the domain this status override applies to, when rendering the border polyline. | GeostoreOverrideBorderStatusProto | This message captures a border status override. For instance, if the TYPE_BORDER feature between China and Hong Kong must be hidden on ditu.google.cn (the Chinese domain for Google Maps) but may be displayed on other domains, we will have a country override border status for “CN” set to STATUS_NEVER_DISPLAY. At least one override restriction must be defined. Currently the only supported restriction is by country code. | String |
| status | The override status, from the BorderStatus enumeration. The value here must be different from the main status (otherwise there’s no point in providing the override). | GeostoreOverrideBorderStatusProto | This message captures a border status override. For instance, if the TYPE_BORDER feature between China and Hong Kong must be hidden on ditu.google.cn (the Chinese domain for Google Maps) but may be displayed on other domains, we will have a country override border status for “CN” set to STATUS_NEVER_DISPLAY. At least one override restriction must be defined. Currently the only supported restriction is by country code. | String |
| color | GeostorePaintedElementLogicalColorProto | Painted element logical color. Most legal definitions only specify a color category (like “yellow”) and don’t specify an exact hue, rather stating that the colors must be distinguishable from each other. We refer to this as the “logical” color. | String | |
| allowanceType | The type of parking for this allowance. Allowance details only apply to the type of parking specified. | GeostoreParkingAllowanceProto | Describes the parking allowances for a feature, or the situations and requirements under which one may be permitted to park, such as certain vehicle types, valet parking, and permit parking. Also describes the cost of parking, which may vary based on the time and duration parked. Includes vehicle type, any other conditions for eligibility, and the cost of parking, which may vary based on the time and duration parked. If is_discount is set to true on a given allowance, that allowance represents a discount that can be applied to lower the cost of non-discount allowances specified on feature via parking_provider_feature. In this way, allowances can be ‘layered,’ i.e. appended, onto each other when denormalizing references via parking_provider_feature. | String |
| isDiscount | If true, this allowance represents a discount rather than an individual rate; any rate values specified in this allowance describe a discount to be applied to the non-discount allowances in the ParkingProto. | GeostoreParkingAllowanceProto | Describes the parking allowances for a feature, or the situations and requirements under which one may be permitted to park, such as certain vehicle types, valet parking, and permit parking. Also describes the cost of parking, which may vary based on the time and duration parked. Includes vehicle type, any other conditions for eligibility, and the cost of parking, which may vary based on the time and duration parked. If is_discount is set to true on a given allowance, that allowance represents a discount that can be applied to lower the cost of non-discount allowances specified on feature via parking_provider_feature. In this way, allowances can be ‘layered,’ i.e. appended, onto each other when denormalizing references via parking_provider_feature. | boolean |
| minPurchaseForValidation | If this rate requires validation, this expresses the minimum purchase required for validation in each applicable currency. Should have an ID of /measurement_unit/money_value and consist of two properties: one with an ID of /measurement_unit/money_value/amount and a float value with the amount, and another with the ID /measurement_unit/money_value/currency and an ID value with the MID of the proper currency (from the /finance/currency type). A value of 0 suggests that no purchase is required. If empty, this suggests that no validation is required for this rate. | GeostoreParkingAllowanceProto | Describes the parking allowances for a feature, or the situations and requirements under which one may be permitted to park, such as certain vehicle types, valet parking, and permit parking. Also describes the cost of parking, which may vary based on the time and duration parked. Includes vehicle type, any other conditions for eligibility, and the cost of parking, which may vary based on the time and duration parked. If is_discount is set to true on a given allowance, that allowance represents a discount that can be applied to lower the cost of non-discount allowances specified on feature via parking_provider_feature. In this way, allowances can be ‘layered,’ i.e. appended, onto each other when denormalizing references via parking_provider_feature. | list(FreebaseTopic) |
| permitType | Any additional details about the permit type; e.g. “Zone A”. In any local languages. Should only be set if allowance_type is PERMIT. | GeostoreParkingAllowanceProto | Describes the parking allowances for a feature, or the situations and requirements under which one may be permitted to park, such as certain vehicle types, valet parking, and permit parking. Also describes the cost of parking, which may vary based on the time and duration parked. Includes vehicle type, any other conditions for eligibility, and the cost of parking, which may vary based on the time and duration parked. If is_discount is set to true on a given allowance, that allowance represents a discount that can be applied to lower the cost of non-discount allowances specified on feature via parking_provider_feature. In this way, allowances can be ‘layered,’ i.e. appended, onto each other when denormalizing references via parking_provider_feature. | list(GeostoreLanguageTaggedTextProto) |
| serviceType | The types of services that this parking allowance applies to. For instance, some cities have streets that only allow traditional taxis to pick up passengers. | GeostoreParkingAllowanceProto | Describes the parking allowances for a feature, or the situations and requirements under which one may be permitted to park, such as certain vehicle types, valet parking, and permit parking. Also describes the cost of parking, which may vary based on the time and duration parked. Includes vehicle type, any other conditions for eligibility, and the cost of parking, which may vary based on the time and duration parked. If is_discount is set to true on a given allowance, that allowance represents a discount that can be applied to lower the cost of non-discount allowances specified on feature via parking_provider_feature. In this way, allowances can be ‘layered,’ i.e. appended, onto each other when denormalizing references via parking_provider_feature. | list(String) |
| timeBasedRate | Describes the rate structures. Each TimeBasedRateProto defines a rate which may apply based on a particular arrival, departure or utilization time; for example, one rate might apply if arriving before 9am, and another might apply regardless of arrival or departure time. | GeostoreParkingAllowanceProto | Describes the parking allowances for a feature, or the situations and requirements under which one may be permitted to park, such as certain vehicle types, valet parking, and permit parking. Also describes the cost of parking, which may vary based on the time and duration parked. Includes vehicle type, any other conditions for eligibility, and the cost of parking, which may vary based on the time and duration parked. If is_discount is set to true on a given allowance, that allowance represents a discount that can be applied to lower the cost of non-discount allowances specified on feature via parking_provider_feature. In this way, allowances can be ‘layered,’ i.e. appended, onto each other when denormalizing references via parking_provider_feature. | list(GeostoreTimeBasedRateProto) |
| vehicleType | Restrictions on which vehicle type(s) the allowance applies to. By default, the allowance applies to any vehicle types. | GeostoreParkingAllowanceProto | Describes the parking allowances for a feature, or the situations and requirements under which one may be permitted to park, such as certain vehicle types, valet parking, and permit parking. Also describes the cost of parking, which may vary based on the time and duration parked. Includes vehicle type, any other conditions for eligibility, and the cost of parking, which may vary based on the time and duration parked. If is_discount is set to true on a given allowance, that allowance represents a discount that can be applied to lower the cost of non-discount allowances specified on feature via parking_provider_feature. In this way, allowances can be ‘layered,’ i.e. appended, onto each other when denormalizing references via parking_provider_feature. | String |
| allowance | Describes the parking allowances for the feature, which are the situations and requirements under which one is permitted to park at the feature’s parking facilities, or discounts that a user may be eligible for. | GeostoreParkingProto | Used to describe the parking facilities provided by or available to a feature. Features of TYPE_ROAD or TYPE_COMPOUND can have a ParkingProto (with parking_provider_feature unset) that describes the parking facilities provided by that feature. Features of TYPE_COMPOUND or TYPE_ESTABLISHMENT_POI can have a ParkingProto (with parking_provider_feature set) to indicate that the feature has dedicated parking and provide details about it, and defer some details of the parking facilities to the referent feature(s). ParkingProto is maintained by the Harbor Pilot team (go/harbor-pilot). Detailed modeling information is described at go/parking-schema. | list(GeostoreParkingAllowanceProto) |
| openingHours | Hours in which the parking facility is open; that is, permits both arrivals and departures of the facility. Should only be set on compounds (i.e. parking lots or garages); roads are considered to always be “open,” though parking at certain times may be prohibited via restrictions. If unset on a compound, this suggests we don’t know the opening hours, or they are the same as the hours of the entity for which this feature offers parking facilities. | GeostoreParkingProto | Used to describe the parking facilities provided by or available to a feature. Features of TYPE_ROAD or TYPE_COMPOUND can have a ParkingProto (with parking_provider_feature unset) that describes the parking facilities provided by that feature. Features of TYPE_COMPOUND or TYPE_ESTABLISHMENT_POI can have a ParkingProto (with parking_provider_feature set) to indicate that the feature has dedicated parking and provide details about it, and defer some details of the parking facilities to the referent feature(s). ParkingProto is maintained by the Harbor Pilot team (go/harbor-pilot). Detailed modeling information is described at go/parking-schema. | GeostoreOpeningHoursProto |
| parkingAvailable | Indicates whether long-term parking is available at the feature; if true, long-term parking is available at the feature and parking allowances may be present on this feature, or parking_provider_feature may indicate deferred parking feature(s). If false, this is an explicit statement that there is no long-term parking associated with this feature. If unset, we don’t know whether there is long-term parking associated with this feature. If false or unset, only additional restrictions or short-term allowances will be populated. | GeostoreParkingProto | Used to describe the parking facilities provided by or available to a feature. Features of TYPE_ROAD or TYPE_COMPOUND can have a ParkingProto (with parking_provider_feature unset) that describes the parking facilities provided by that feature. Features of TYPE_COMPOUND or TYPE_ESTABLISHMENT_POI can have a ParkingProto (with parking_provider_feature set) to indicate that the feature has dedicated parking and provide details about it, and defer some details of the parking facilities to the referent feature(s). ParkingProto is maintained by the Harbor Pilot team (go/harbor-pilot). Detailed modeling information is described at go/parking-schema. | boolean |
| parkingProviderFeature | If empty, indicates that the feature containing this ParkingProto provides parking facilities, which are described by this proto. If nonempty, indicates that the feature with this ParkingProto does not contain parking facilities itself, but visitors of this feature may use the parking available to the referent feature(s). The referent feature(s) may themselves contain parking facilities or defer to other features. A ParkingProto may defer parking details to another feature, but still include its own data. This suggests that a visitor of the referrer feature is eligible for different rates or discounts. The data in these fields applies transitively, and any fields in a referrer may be applied to the referent (for a visitor of the referrer). | GeostoreParkingProto | Used to describe the parking facilities provided by or available to a feature. Features of TYPE_ROAD or TYPE_COMPOUND can have a ParkingProto (with parking_provider_feature unset) that describes the parking facilities provided by that feature. Features of TYPE_COMPOUND or TYPE_ESTABLISHMENT_POI can have a ParkingProto (with parking_provider_feature set) to indicate that the feature has dedicated parking and provide details about it, and defer some details of the parking facilities to the referent feature(s). ParkingProto is maintained by the Harbor Pilot team (go/harbor-pilot). Detailed modeling information is described at go/parking-schema. | list(GeostoreFeatureIdProto) |
| restriction | Describes any parking restrictions that apply to this feature. Should only be set on road segments for which parking is explicitly prohibited for some or all times; for roads which do not prohibit parking and for all other facilities, the ability to park should be expressed using allowances. In the instance that both a restriction and an allowance applies at a given time, restrictions always have precedence over the same parking allowances. However, explicit short-term allowances (PICKUP_GOODS, PICKUP_PASSENGERS) take precedence over general NO_PARKING, NO_STANDING, or NO_STOPPING restrictions. | GeostoreParkingProto | Used to describe the parking facilities provided by or available to a feature. Features of TYPE_ROAD or TYPE_COMPOUND can have a ParkingProto (with parking_provider_feature unset) that describes the parking facilities provided by that feature. Features of TYPE_COMPOUND or TYPE_ESTABLISHMENT_POI can have a ParkingProto (with parking_provider_feature set) to indicate that the feature has dedicated parking and provide details about it, and defer some details of the parking facilities to the referent feature(s). ParkingProto is maintained by the Harbor Pilot team (go/harbor-pilot). Detailed modeling information is described at go/parking-schema. | list(GeostoreParkingRestrictionProto) |
| restrictedHours | Times at which parking is prohibited. | GeostoreParkingRestrictionProto | Expresses a parking restriction on a road; i.e. times at which parking on the road is prohibited. | GeostoreTimeScheduleProto |
| restrictionType | clang-format on The type of restriction that applies at this time. | GeostoreParkingRestrictionProto | Expresses a parking restriction on a road; i.e. times at which parking on the road is prohibited. | String |
| serviceType | The types of services that this parking restriction applies to. We expect most parking restrictions to apply to all services, but some airports have specific rideshare parking or taxi parking zones. | GeostoreParkingRestrictionProto | Expresses a parking restriction on a road; i.e. times at which parking on the road is prohibited. | list(String) |
| vehicleType | The types of vehicles that this parking restriction applies to. For instance, some streets may allow motorcycles to park but not automobiles or trucks. | GeostoreParkingRestrictionProto | Expresses a parking restriction on a road; i.e. times at which parking on the road is prohibited. | list(String) |
| prominenceMeters | Topographic prominence in meters: the height of the peak’s summit above the lowest contour line encircling it and no higher summit. | GeostorePeakProto | This protocol buffer holds related data for features of type TYPE_PEAK and TYPE_VOLCANO. | float |
| angleDegrees | This value specifies the angle of the crosswalk. Zero degrees represents a crosswalk perpendicular to the direction of travel, towards the right side of the segment. The crosswalk angle, winds clockwise. Range [-90, 90]. The following crosswalk would have a 15 degree angle: / / <--/-------------------------------- / / | GeostorePedestrianCrossingProto | A crossing describes a path from the end point of a segment to the start point of its sibling. Each individual crossing should uniquely represent a physically distinct crossing in the real world. Pedestrian crossings are bidirectional. This proto represents “simple” crossings. More complicated crossings (such as the diagonal crosswalk at Shibuya Station in Tokyo) will be represented using a separate pedestrian network. Example 1: Standard four way crossing. Assume each road (A/B/C) has a crosswalk (denoted by a ‘-‘) right before intersection X. Assume crossing at D is prohibited (denoted by a ‘%’). Assume “prime” roads (A’,B’,…) are OUT segments relative to X. A\\\\A’ B//B’ \\\\ // \\\\ // – – X – % // \\\\ // \\\\ C’//C D’\\\\D * A CROSSABLE PedestrianCrossing should be added to A, B and C. * An UNCROSSABLE PedestrianCrossing should be added to D. Example 2: Simple intersection with one crossing. Assume intersection X was added to accommodate the crosswalk (through X, denoted by ‘-‘). Assume “prime” roads (A’,B’,…) are OUT segments relative to X. A\\\\A’ \\\\ \\\\ -X- \\\\ \\\\ B’\\\\B * A CROSSABLE PedestrianCrossing must be added to either A or B, but not both because each real-world crossing should be represented exactly once. Duplicative crossings may be arbitrarily removed. | float |
| crossAnywhere | This value enables crossing anywhere (not just at the segment’s endpoint), typically used on long, low-traffic residential streets. This attribute is only respected for trivial segment -> sibling routes. All other routes can cross at a MapFacts intersection. | GeostorePedestrianCrossingProto | A crossing describes a path from the end point of a segment to the start point of its sibling. Each individual crossing should uniquely represent a physically distinct crossing in the real world. Pedestrian crossings are bidirectional. This proto represents “simple” crossings. More complicated crossings (such as the diagonal crosswalk at Shibuya Station in Tokyo) will be represented using a separate pedestrian network. Example 1: Standard four way crossing. Assume each road (A/B/C) has a crosswalk (denoted by a ‘-‘) right before intersection X. Assume crossing at D is prohibited (denoted by a ‘%’). Assume “prime” roads (A’,B’,…) are OUT segments relative to X. A\\\\A’ B//B’ \\\\ // \\\\ // – – X – % // \\\\ // \\\\ C’//C D’\\\\D * A CROSSABLE PedestrianCrossing should be added to A, B and C. * An UNCROSSABLE PedestrianCrossing should be added to D. Example 2: Simple intersection with one crossing. Assume intersection X was added to accommodate the crosswalk (through X, denoted by ‘-‘). Assume “prime” roads (A’,B’,…) are OUT segments relative to X. A\\\\A’ \\\\ \\\\ -X- \\\\ \\\\ B’\\\\B * A CROSSABLE PedestrianCrossing must be added to either A or B, but not both because each real-world crossing should be represented exactly once. Duplicative crossings may be arbitrarily removed. | boolean |
| crossingType | Crossing type is used as a restriction and can also be used for rendering. | GeostorePedestrianCrossingProto | A crossing describes a path from the end point of a segment to the start point of its sibling. Each individual crossing should uniquely represent a physically distinct crossing in the real world. Pedestrian crossings are bidirectional. This proto represents “simple” crossings. More complicated crossings (such as the diagonal crosswalk at Shibuya Station in Tokyo) will be represented using a separate pedestrian network. Example 1: Standard four way crossing. Assume each road (A/B/C) has a crosswalk (denoted by a ‘-‘) right before intersection X. Assume crossing at D is prohibited (denoted by a ‘%’). Assume “prime” roads (A’,B’,…) are OUT segments relative to X. A\\\\A’ B//B’ \\\\ // \\\\ // – – X – % // \\\\ // \\\\ C’//C D’\\\\D * A CROSSABLE PedestrianCrossing should be added to A, B and C. * An UNCROSSABLE PedestrianCrossing should be added to D. Example 2: Simple intersection with one crossing. Assume intersection X was added to accommodate the crosswalk (through X, denoted by ‘-‘). Assume “prime” roads (A’,B’,…) are OUT segments relative to X. A\\\\A’ \\\\ \\\\ -X- \\\\ \\\\ B’\\\\B * A CROSSABLE PedestrianCrossing must be added to either A or B, but not both because each real-world crossing should be represented exactly once. Duplicative crossings may be arbitrarily removed. | String |
| offset | The crossing offset defines a fraction between the distance from the segment endpoint to the centerline of the crosswalk and the length of the segment. For example, the segment length is 20 meters and the distance from segment end to center of crosswalk is 2 meters, the value of offset will be 0.1. | GeostorePedestrianCrossingProto | A crossing describes a path from the end point of a segment to the start point of its sibling. Each individual crossing should uniquely represent a physically distinct crossing in the real world. Pedestrian crossings are bidirectional. This proto represents “simple” crossings. More complicated crossings (such as the diagonal crosswalk at Shibuya Station in Tokyo) will be represented using a separate pedestrian network. Example 1: Standard four way crossing. Assume each road (A/B/C) has a crosswalk (denoted by a ‘-‘) right before intersection X. Assume crossing at D is prohibited (denoted by a ‘%’). Assume “prime” roads (A’,B’,…) are OUT segments relative to X. A\\\\A’ B//B’ \\\\ // \\\\ // – – X – % // \\\\ // \\\\ C’//C D’\\\\D * A CROSSABLE PedestrianCrossing should be added to A, B and C. * An UNCROSSABLE PedestrianCrossing should be added to D. Example 2: Simple intersection with one crossing. Assume intersection X was added to accommodate the crosswalk (through X, denoted by ‘-‘). Assume “prime” roads (A’,B’,…) are OUT segments relative to X. A\\\\A’ \\\\ \\\\ -X- \\\\ \\\\ B’\\\\B * A CROSSABLE PedestrianCrossing must be added to either A or B, but not both because each real-world crossing should be represented exactly once. Duplicative crossings may be arbitrarily removed. | number |
| restriction | Restrictions for this crossing (such as constructions on the crosswalk). They must not have subpath or travel_mode. | GeostorePedestrianCrossingProto | A crossing describes a path from the end point of a segment to the start point of its sibling. Each individual crossing should uniquely represent a physically distinct crossing in the real world. Pedestrian crossings are bidirectional. This proto represents “simple” crossings. More complicated crossings (such as the diagonal crosswalk at Shibuya Station in Tokyo) will be represented using a separate pedestrian network. Example 1: Standard four way crossing. Assume each road (A/B/C) has a crosswalk (denoted by a ‘-‘) right before intersection X. Assume crossing at D is prohibited (denoted by a ‘%’). Assume “prime” roads (A’,B’,…) are OUT segments relative to X. A\\\\A’ B//B’ \\\\ // \\\\ // – – X – % // \\\\ // \\\\ C’//C D’\\\\D * A CROSSABLE PedestrianCrossing should be added to A, B and C. * An UNCROSSABLE PedestrianCrossing should be added to D. Example 2: Simple intersection with one crossing. Assume intersection X was added to accommodate the crosswalk (through X, denoted by ‘-‘). Assume “prime” roads (A’,B’,…) are OUT segments relative to X. A\\\\A’ \\\\ \\\\ -X- \\\\ \\\\ B’\\\\B * A CROSSABLE PedestrianCrossing must be added to either A or B, but not both because each real-world crossing should be represented exactly once. Duplicative crossings may be arbitrarily removed. | list(GeostoreRestrictionProto) |
| width | This value defines the full width of the crossing in the direction perpendicular to the direction which pedestrians walk on the crossing (in meters). The crossing is allowed to “spill” into the next segment (0.5 * width can be greater than the offset). Cannot be a negative value. | GeostorePedestrianCrossingProto | A crossing describes a path from the end point of a segment to the start point of its sibling. Each individual crossing should uniquely represent a physically distinct crossing in the real world. Pedestrian crossings are bidirectional. This proto represents “simple” crossings. More complicated crossings (such as the diagonal crosswalk at Shibuya Station in Tokyo) will be represented using a separate pedestrian network. Example 1: Standard four way crossing. Assume each road (A/B/C) has a crosswalk (denoted by a ‘-‘) right before intersection X. Assume crossing at D is prohibited (denoted by a ‘%’). Assume “prime” roads (A’,B’,…) are OUT segments relative to X. A\\\\A’ B//B’ \\\\ // \\\\ // – – X – % // \\\\ // \\\\ C’//C D’\\\\D * A CROSSABLE PedestrianCrossing should be added to A, B and C. * An UNCROSSABLE PedestrianCrossing should be added to D. Example 2: Simple intersection with one crossing. Assume intersection X was added to accommodate the crosswalk (through X, denoted by ‘-‘). Assume “prime” roads (A’,B’,…) are OUT segments relative to X. A\\\\A’ \\\\ \\\\ -X- \\\\ \\\\ B’\\\\B * A CROSSABLE PedestrianCrossing must be added to either A or B, but not both because each real-world crossing should be represented exactly once. Duplicative crossings may be arbitrarily removed. | number |
| dashLengthMeters | Applicable for DASHED and DOTTED_DASHED lines. | GeostorePhysicalLineProto | Describes a single physical marker line. NOTE: PhysicalLineProto could be compared against one another by canonicalizing them via GetCanonicalPhysicalLine() in google3/geostore/base/internal/lane_marker.cc. Any fields that don’t contribute to the definition of a physical line in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalPhysicalLine(). LINT.IfChange | number |
| gapColor | This should be rarely needed, but can represent patterns of alternating colors. | GeostorePhysicalLineProto | Describes a single physical marker line. NOTE: PhysicalLineProto could be compared against one another by canonicalizing them via GetCanonicalPhysicalLine() in google3/geostore/base/internal/lane_marker.cc. Any fields that don’t contribute to the definition of a physical line in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalPhysicalLine(). LINT.IfChange | GeostorePaintedElementLogicalColorProto |
| gapLengthMeters | Applicable for DASHED, DOTTED, and DOTTED_DASHED lines. | GeostorePhysicalLineProto | Describes a single physical marker line. NOTE: PhysicalLineProto could be compared against one another by canonicalizing them via GetCanonicalPhysicalLine() in google3/geostore/base/internal/lane_marker.cc. Any fields that don’t contribute to the definition of a physical line in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalPhysicalLine(). LINT.IfChange | number |
| material | GeostorePhysicalLineProto | Describes a single physical marker line. NOTE: PhysicalLineProto could be compared against one another by canonicalizing them via GetCanonicalPhysicalLine() in google3/geostore/base/internal/lane_marker.cc. Any fields that don’t contribute to the definition of a physical line in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalPhysicalLine(). LINT.IfChange | list(String) | |
| paintColor | Color for the painted elements. Applicable to all types. | GeostorePhysicalLineProto | Describes a single physical marker line. NOTE: PhysicalLineProto could be compared against one another by canonicalizing them via GetCanonicalPhysicalLine() in google3/geostore/base/internal/lane_marker.cc. Any fields that don’t contribute to the definition of a physical line in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalPhysicalLine(). LINT.IfChange | GeostorePaintedElementLogicalColorProto |
| pattern | GeostorePhysicalLineProto | Describes a single physical marker line. NOTE: PhysicalLineProto could be compared against one another by canonicalizing them via GetCanonicalPhysicalLine() in google3/geostore/base/internal/lane_marker.cc. Any fields that don’t contribute to the definition of a physical line in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalPhysicalLine(). LINT.IfChange | String | |
| physicalLineToken | A token that can be used to identify the version of the data about this marker line. | GeostorePhysicalLineProto | Describes a single physical marker line. NOTE: PhysicalLineProto could be compared against one another by canonicalizing them via GetCanonicalPhysicalLine() in google3/geostore/base/internal/lane_marker.cc. Any fields that don’t contribute to the definition of a physical line in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalPhysicalLine(). LINT.IfChange | String |
| curvatureStatus | GeostorePointCurvatureProto | String | ||
| radiansPerMeter | Curvature in radians per meter. Negative is a curve to the left and positive is a curve to the right. | GeostorePointCurvatureProto | number | |
| startPointFraction | How far along the line this curvature value starts to apply, in the format of decimal between 0 and 1. | GeostorePointCurvatureProto | number | |
| latE7 | GeostorePointProto | integer | ||
| lngE7 | GeostorePointProto | integer | ||
| metadata | NOTE: If removing metadata, remove ‘option objc_class_prefix = “GS”;’ together. See cl/189921100. Field-level metadata for this point. NOTE: there are multiple PointProto fields in the Geo Schema. Metadata here is only expected to be present on FeatureProto.point[] and FeatureProto.center. | GeostorePointProto | GeostoreFieldMetadataProto | |
| temporaryData | A place for clients to attach arbitrary data to a point. Never set in MapFacts. | GeostorePointProto | Proto2BridgeMessageSet | |
| altitudeMeters | Altitude of this point is assumed to be relative to the ground level. | GeostorePointWithHeightProto | PointWithHeightProto encodes lat/lng through PointProto and contains altitude information. | number |
| point | GeostorePointWithHeightProto | PointWithHeightProto encodes lat/lng through PointProto and contains altitude information. | GeostorePointProto | |
| capital | Many political regions have a conceptual center (capitals of a country or a top-level division are examples). If set, the target feature must be a TYPE_LOCALITY feature. | GeostorePoliticalProto | This protocol buffer is included from feature.proto as an optional message. Political features represent the different ways that people are divided into geographical regions. This protocol buffer is applicable only to TYPE_POLITICAL features and is used to store political information from the feature’s point of view. | GeostoreFeatureIdProto |
| claim | Feature IDs of the features claimed by this feature’s government that are not necessarily included in the feature’s geometry. | GeostorePoliticalProto | This protocol buffer is included from feature.proto as an optional message. Political features represent the different ways that people are divided into geographical regions. This protocol buffer is applicable only to TYPE_POLITICAL features and is used to store political information from the feature’s point of view. | list(GeostoreFeatureIdProto) |
| grossDomesticProductUsdMillions | The Gross Domestic Product of the political region measured in millions of current United States dollars. It must not be negative. | GeostorePoliticalProto | This protocol buffer is included from feature.proto as an optional message. Political features represent the different ways that people are divided into geographical regions. This protocol buffer is applicable only to TYPE_POLITICAL features and is used to store political information from the feature’s point of view. | float |
| literacyPercent | Percentage of population that are literate within a political region. It must be between 0 and 100. | GeostorePoliticalProto | This protocol buffer is included from feature.proto as an optional message. Political features represent the different ways that people are divided into geographical regions. This protocol buffer is applicable only to TYPE_POLITICAL features and is used to store political information from the feature’s point of view. | number |
| population | The number of people in this political region. This field is intended to store accurate population, not an estimation such as representative value for population range. It must not be negative. | GeostorePoliticalProto | This protocol buffer is included from feature.proto as an optional message. Political features represent the different ways that people are divided into geographical regions. This protocol buffer is applicable only to TYPE_POLITICAL features and is used to store political information from the feature’s point of view. | String |
| baseMeters | The polygon loops above are basically flat: each point has a latitude and a longitude but no altitude. We don’t want to build real 3D models here, but we do want to be able to generate 2.5D models. A 2.5D model is built by translating the flat polygon upward some distance (base) then extruding it upward some additional distance (height). The elevation of the bottom of the extruded polygon (above ground level). | GeostorePolygonProto | A general non-self-intersecting spherical polygon, consisting of one or more loops defining multiple disconnected regions possibly with holes. All loops should be oriented CCW around the region they define. This applies to the exterior loop(s) as well as any holes. Within MapFacts (and underlying infrastructure) the data fields may be replaced by a single shape_id stored in internal_feature. Any such PolygonProtos shouldn’t be expected to work with public functions in //geostore/base/public/polygon.h. | number |
| cellId | ** DEPRECATED ** This is part of a splitting strategy for large polygons, which was never fully launched and we decided not to pursue. For features with very complex polygonal geometry, we break up the polygon into pieces that align with S2 cells at various levels. We do this for performance reasons as some geometry operations have quadratic complexity with regards to the total number of vertices. In these cases, we store the S2 cell ID corresponding to the piece of the overall polygon that is described by this specific PolygonProto message. Each polygon piece is expected to be fully contained by the S2 cell corresponding to this cell ID. However, note that the S2 cell ID is not required to correspond to the smallest S2 cell that fully contains the polygon (and often won’t be). In addition, polygon pieces are required to not have any overlap (which translates to having entirely disjoint S2 cell IDs, i.e. one can not be parent (or grand parent, etc.) of another). | GeostorePolygonProto | A general non-self-intersecting spherical polygon, consisting of one or more loops defining multiple disconnected regions possibly with holes. All loops should be oriented CCW around the region they define. This applies to the exterior loop(s) as well as any holes. Within MapFacts (and underlying infrastructure) the data fields may be replaced by a single shape_id stored in internal_feature. Any such PolygonProtos shouldn’t be expected to work with public functions in //geostore/base/public/polygon.h. | String |
| encoded | Encoding of the polygon using S2Polygon::Encode()’s compressed representation. | GeostorePolygonProto | A general non-self-intersecting spherical polygon, consisting of one or more loops defining multiple disconnected regions possibly with holes. All loops should be oriented CCW around the region they define. This applies to the exterior loop(s) as well as any holes. Within MapFacts (and underlying infrastructure) the data fields may be replaced by a single shape_id stored in internal_feature. Any such PolygonProtos shouldn’t be expected to work with public functions in //geostore/base/public/polygon.h. | String |
| heightMeters | The distance from the bottom of the extruded polygon to the top. | GeostorePolygonProto | A general non-self-intersecting spherical polygon, consisting of one or more loops defining multiple disconnected regions possibly with holes. All loops should be oriented CCW around the region they define. This applies to the exterior loop(s) as well as any holes. Within MapFacts (and underlying infrastructure) the data fields may be replaced by a single shape_id stored in internal_feature. Any such PolygonProtos shouldn’t be expected to work with public functions in //geostore/base/public/polygon.h. | number |
| loop | ** DEPRECATED ** We have switched to using exclusively the encoded form in the wire format to and from MapFacts, so this field should never be populated there. See go/encoded-polygons for more info. “Classic” polygon representation, defined by one or more loops. The last vertex of each polyline is implicitly connected to the first vertex. All loops should be specified in CCW order. | GeostorePolygonProto | A general non-self-intersecting spherical polygon, consisting of one or more loops defining multiple disconnected regions possibly with holes. All loops should be oriented CCW around the region they define. This applies to the exterior loop(s) as well as any holes. Within MapFacts (and underlying infrastructure) the data fields may be replaced by a single shape_id stored in internal_feature. Any such PolygonProtos shouldn’t be expected to work with public functions in //geostore/base/public/polygon.h. | list(GeostorePolyLineProto) |
| metadata | Field-level metadata for this polygon. | GeostorePolygonProto | A general non-self-intersecting spherical polygon, consisting of one or more loops defining multiple disconnected regions possibly with holes. All loops should be oriented CCW around the region they define. This applies to the exterior loop(s) as well as any holes. Within MapFacts (and underlying infrastructure) the data fields may be replaced by a single shape_id stored in internal_feature. Any such PolygonProtos shouldn’t be expected to work with public functions in //geostore/base/public/polygon.h. | GeostoreFieldMetadataProto |
| temporaryData | A place for clients to attach arbitrary data to a polygon. Never set in MapFacts. | GeostorePolygonProto | A general non-self-intersecting spherical polygon, consisting of one or more loops defining multiple disconnected regions possibly with holes. All loops should be oriented CCW around the region they define. This applies to the exterior loop(s) as well as any holes. Within MapFacts (and underlying infrastructure) the data fields may be replaced by a single shape_id stored in internal_feature. Any such PolygonProtos shouldn’t be expected to work with public functions in //geostore/base/public/polygon.h. | Proto2BridgeMessageSet |
| unsuitableForDisplay | Some polygons are known to be rough proxies for a feature’s “real” polygonal representation. Such polygons are generally unsuitable for display. Rendering clients should not show these in most cases. Polygons unsuitable for display do have other uses, such as user location or containment analysis, or as an input to learning algorithms. This is an orthogonal concept to FeatureProto.synthetic_geometry, which only pertains to the method by which a polygon was created, rather than its fidelity to ground truth. For features that have multiple polygons, this bit should be consistently set to the same value on all polygons. | GeostorePolygonProto | A general non-self-intersecting spherical polygon, consisting of one or more loops defining multiple disconnected regions possibly with holes. All loops should be oriented CCW around the region they define. This applies to the exterior loop(s) as well as any holes. Within MapFacts (and underlying infrastructure) the data fields may be replaced by a single shape_id stored in internal_feature. Any such PolygonProtos shouldn’t be expected to work with public functions in //geostore/base/public/polygon.h. | boolean |
| metadata | Field-level metadata for this polyline. NOTE: there are multiple PolyLineProto fields in the Geo Schema. Metadata here is only expected to be present on FeatureProto.polyline[]. | GeostorePolyLineProto | GeostoreFieldMetadataProto | |
| temporaryData | A place for clients to attach arbitrary data to a polyline. Never set in MapFacts. | GeostorePolyLineProto | Proto2BridgeMessageSet | |
| vertex | A sequence of vertices connected by geodesics (the equivalent of straight lines on the sphere). Adjacent vertices are connected by the shorter of the two geodesics that connect them, i.e. all edges are 180 degrees or less. Note that the edge definition becomes numerically unstable as the arc length approaches 180 degrees. Polylines are generally expected to be non-self-intersecting, but any such restriction is imposed by the user of the polyline rather than the polyline itself. | GeostorePolyLineProto | list(GeostorePointProto) | |
| altitude | The height of the pose. A positive height is above the WGS-84 ellipsoid in meters; negative is below. | GeostorePoseProto | A pose is an object’s position in space, as well as its orientation. All fields except lat and lng are optional. All fields are in the WGS-84 ellipsoid, and rotations are right-hand rule (i.e. if the right hand thumb points along a vector, curled fingers indicate positive rotation direction). An un-rotated pose would be pointing due North, along the surface of the ellipsoid. Rotations are applied in the order: yaw, pitch, roll. Note that the rotation axes are rotated along with the model for each rotation step. WARNING: This proto is not meant to be used directly. Please use the provided libraries: //geostore/base/public/pose.h //java/com/google/geostore/base/Pose.java | float |
| index | The index of the PoseProto in a list of PoseProtos. | GeostorePoseProto | A pose is an object’s position in space, as well as its orientation. All fields except lat and lng are optional. All fields are in the WGS-84 ellipsoid, and rotations are right-hand rule (i.e. if the right hand thumb points along a vector, curled fingers indicate positive rotation direction). An un-rotated pose would be pointing due North, along the surface of the ellipsoid. Rotations are applied in the order: yaw, pitch, roll. Note that the rotation axes are rotated along with the model for each rotation step. WARNING: This proto is not meant to be used directly. Please use the provided libraries: //geostore/base/public/pose.h //java/com/google/geostore/base/Pose.java | integer |
| lat | The latitude of the pose in degrees [-90, 90]. | GeostorePoseProto | A pose is an object’s position in space, as well as its orientation. All fields except lat and lng are optional. All fields are in the WGS-84 ellipsoid, and rotations are right-hand rule (i.e. if the right hand thumb points along a vector, curled fingers indicate positive rotation direction). An un-rotated pose would be pointing due North, along the surface of the ellipsoid. Rotations are applied in the order: yaw, pitch, roll. Note that the rotation axes are rotated along with the model for each rotation step. WARNING: This proto is not meant to be used directly. Please use the provided libraries: //geostore/base/public/pose.h //java/com/google/geostore/base/Pose.java | float |
| lng | The longitude of the pose in degrees (-180,180]. | GeostorePoseProto | A pose is an object’s position in space, as well as its orientation. All fields except lat and lng are optional. All fields are in the WGS-84 ellipsoid, and rotations are right-hand rule (i.e. if the right hand thumb points along a vector, curled fingers indicate positive rotation direction). An un-rotated pose would be pointing due North, along the surface of the ellipsoid. Rotations are applied in the order: yaw, pitch, roll. Note that the rotation axes are rotated along with the model for each rotation step. WARNING: This proto is not meant to be used directly. Please use the provided libraries: //geostore/base/public/pose.h //java/com/google/geostore/base/Pose.java | float |
| pitch | The rotation around the longitude line East tangent in degrees [-90, 90]. | GeostorePoseProto | A pose is an object’s position in space, as well as its orientation. All fields except lat and lng are optional. All fields are in the WGS-84 ellipsoid, and rotations are right-hand rule (i.e. if the right hand thumb points along a vector, curled fingers indicate positive rotation direction). An un-rotated pose would be pointing due North, along the surface of the ellipsoid. Rotations are applied in the order: yaw, pitch, roll. Note that the rotation axes are rotated along with the model for each rotation step. WARNING: This proto is not meant to be used directly. Please use the provided libraries: //geostore/base/public/pose.h //java/com/google/geostore/base/Pose.java | float |
| roll | The rotation around the latitude line North tangent in degrees (-180, 180]. | GeostorePoseProto | A pose is an object’s position in space, as well as its orientation. All fields except lat and lng are optional. All fields are in the WGS-84 ellipsoid, and rotations are right-hand rule (i.e. if the right hand thumb points along a vector, curled fingers indicate positive rotation direction). An un-rotated pose would be pointing due North, along the surface of the ellipsoid. Rotations are applied in the order: yaw, pitch, roll. Note that the rotation axes are rotated along with the model for each rotation step. WARNING: This proto is not meant to be used directly. Please use the provided libraries: //geostore/base/public/pose.h //java/com/google/geostore/base/Pose.java | float |
| yaw | The rotation around the Up vector, from North, in degrees (-180, 180]. | GeostorePoseProto | A pose is an object’s position in space, as well as its orientation. All fields except lat and lng are optional. All fields are in the WGS-84 ellipsoid, and rotations are right-hand rule (i.e. if the right hand thumb points along a vector, curled fingers indicate positive rotation direction). An un-rotated pose would be pointing due North, along the surface of the ellipsoid. Rotations are applied in the order: yaw, pitch, roll. Note that the rotation axes are rotated along with the model for each rotation step. WARNING: This proto is not meant to be used directly. Please use the provided libraries: //geostore/base/public/pose.h //java/com/google/geostore/base/Pose.java | float |
| calories | GeostorePriceInfoFoodNutritionFacts | This message represents nutrition facts for a food dish. | GeostorePriceInfoFoodNutritionFactsCaloriesFact | |
| cholesterol | Cholesterol information for a given food dish. | GeostorePriceInfoFoodNutritionFacts | This message represents nutrition facts for a food dish. | GeostorePriceInfoFoodNutritionFactsNutritionFact |
| protein | Protein information for a given food dish. | GeostorePriceInfoFoodNutritionFacts | This message represents nutrition facts for a food dish. | GeostorePriceInfoFoodNutritionFactsNutritionFact |
| sodium | Sodium information for a given food dish. | GeostorePriceInfoFoodNutritionFacts | This message represents nutrition facts for a food dish. | GeostorePriceInfoFoodNutritionFactsNutritionFact |
| totalCarbohydrate | Carbohydrate information for a given food dish. | GeostorePriceInfoFoodNutritionFacts | This message represents nutrition facts for a food dish. | GeostorePriceInfoFoodNutritionFactsNutritionFact |
| totalFat | Fat information for a given food dish. | GeostorePriceInfoFoodNutritionFacts | This message represents nutrition facts for a food dish. | GeostorePriceInfoFoodNutritionFactsNutritionFact |
| lowerAmount | GeostorePriceInfoFoodNutritionFactsCaloriesFact | This message denotes calories information with an upper bound and lower bound range. | integer | |
| unit | Unit of the given calories information. | GeostorePriceInfoFoodNutritionFactsCaloriesFact | This message denotes calories information with an upper bound and lower bound range. | String |
| upperAmount | GeostorePriceInfoFoodNutritionFactsCaloriesFact | This message denotes calories information with an upper bound and lower bound range. | integer | |
| lowerAmount | GeostorePriceInfoFoodNutritionFactsNutritionFact | This message denotes nutrition information with an upper bound and lower bound range and can be represented by mass unit. | float | |
| unit | Unit of the given nutrition information. | GeostorePriceInfoFoodNutritionFactsNutritionFact | This message denotes nutrition information with an upper bound and lower bound range and can be represented by mass unit. | String |
| upperAmount | GeostorePriceInfoFoodNutritionFactsNutritionFact | This message denotes nutrition information with an upper bound and lower bound range and can be represented by mass unit. | float | |
| priceList | The actual food menus. This is a repeated field because a restaurant may offer multiple menus, e.g. for different language or for different available time, such as holidays vs non-holidays. | GeostorePriceInfoProto | list(GeostorePriceListProto) | |
| priceListUrl | All URLs that give price list information for this establishment. For food menus, this would represent menu_urls. Note that this field is a repeated list of UrlListProtos. Each UrlListProto instance in the list is intended to hold lists of URLs that are translations of the same URL. | GeostorePriceInfoProto | list(GeostoreUrlListProto) | |
| status | Message containing metadata about the verified status of the PriceInfo. Only verified listings should be displayed. | GeostorePriceInfoProto | GeostorePriceInfoStatus | |
| isVerified | GeostorePriceInfoStatus | Providers of PriceInfo (e.g. SinglePlatform, YEXT) send verified and unverified listings. PriceInfoStatus is used to encapsulate this information. | boolean | |
| description | GeostorePriceListNameInfoProto | A PriceListNameInfoProto is used by PriceListProto and fields and messages contained in it for storing names, descriptions, languages, and IDs. The name field and the description field must be in the same language, as specified by the language field. None of the fields in this proto is required, although it is not expected to have the language field set unless there is a name or description. When the language field is not set, it is understood to be the preferred language of the locale where the establishment is located. An empty string for any of the fields is not allowed (as enforced by lints). | String | |
| id | IDs are intended to be unique identifiers of PriceInfoLists, Sections, and Menu items. This is enforced by the ID_DUPLICATE_PRICE_LIST_ID lint. | GeostorePriceListNameInfoProto | A PriceListNameInfoProto is used by PriceListProto and fields and messages contained in it for storing names, descriptions, languages, and IDs. The name field and the description field must be in the same language, as specified by the language field. None of the fields in this proto is required, although it is not expected to have the language field set unless there is a name or description. When the language field is not set, it is understood to be the preferred language of the locale where the establishment is located. An empty string for any of the fields is not allowed (as enforced by lints). | String |
| language | The external form of a Google International Identifiers Initiative (III) LanguageCode object. See google3/i18n/identifiers/languagecode.h for details. We place extra restrictions on languages in addition to what the III library requires. See go/geo-schema-reference/feature-properties/languages. | GeostorePriceListNameInfoProto | A PriceListNameInfoProto is used by PriceListProto and fields and messages contained in it for storing names, descriptions, languages, and IDs. The name field and the description field must be in the same language, as specified by the language field. None of the fields in this proto is required, although it is not expected to have the language field set unless there is a name or description. When the language field is not set, it is understood to be the preferred language of the locale where the establishment is located. An empty string for any of the fields is not allowed (as enforced by lints). | String |
| name | GeostorePriceListNameInfoProto | A PriceListNameInfoProto is used by PriceListProto and fields and messages contained in it for storing names, descriptions, languages, and IDs. The name field and the description field must be in the same language, as specified by the language field. None of the fields in this proto is required, although it is not expected to have the language field set unless there is a name or description. When the language field is not set, it is understood to be the preferred language of the locale where the establishment is located. An empty string for any of the fields is not allowed (as enforced by lints). | String | |
| aggregatorId | For third party lists, represents the ID of the aggregator which provided this data. Optional. | GeostorePriceListProto | A PriceListProto can be used to represent any type of price lists, one of which is a menu of food and drinks. It contains names and descriptions, together with its source URL list if it is extracted or attributed to that URL. The names and descriptions are represented using repeated PriceListNameInfo fields to allow versions in different languages. A PriceListProto may contain multiple sections; in the context of a food menu, this would be multiple menu sections, e.g. for breakfast, lunch, dinner, prix fixe, or dinner for two, etc. At least one menu section must be present. Each section contains a number of items; for food menus, it may be FoodMenuItems defined below. At least one item must be present in each section. | String |
| availableTime | The time period when this price list is available. Establishments are not required to give available_time for any given price list, however, when this field is not set, the price list is understood as available any time the establishment is open. | GeostorePriceListProto | A PriceListProto can be used to represent any type of price lists, one of which is a menu of food and drinks. It contains names and descriptions, together with its source URL list if it is extracted or attributed to that URL. The names and descriptions are represented using repeated PriceListNameInfo fields to allow versions in different languages. A PriceListProto may contain multiple sections; in the context of a food menu, this would be multiple menu sections, e.g. for breakfast, lunch, dinner, prix fixe, or dinner for two, etc. At least one menu section must be present. Each section contains a number of items; for food menus, it may be FoodMenuItems defined below. At least one item must be present in each section. | GeostoreTimeScheduleProto |
| cuisines | Cuisine information if the location the price lists attached to is an eligible feature for a food menu price list. Cuisine information should also only show up in a food price list. | GeostorePriceListProto | A PriceListProto can be used to represent any type of price lists, one of which is a menu of food and drinks. It contains names and descriptions, together with its source URL list if it is extracted or attributed to that URL. The names and descriptions are represented using repeated PriceListNameInfo fields to allow versions in different languages. A PriceListProto may contain multiple sections; in the context of a food menu, this would be multiple menu sections, e.g. for breakfast, lunch, dinner, prix fixe, or dinner for two, etc. At least one menu section must be present. Each section contains a number of items; for food menus, it may be FoodMenuItems defined below. At least one item must be present in each section. | list(String) |
| nameInfo | The repeated name_info field is for price lists listed in multiple languages. When a price list has no names or descriptions, the size of the repeated field name_info may be 0. There should be at most one name_info for any given language. | GeostorePriceListProto | A PriceListProto can be used to represent any type of price lists, one of which is a menu of food and drinks. It contains names and descriptions, together with its source URL list if it is extracted or attributed to that URL. The names and descriptions are represented using repeated PriceListNameInfo fields to allow versions in different languages. A PriceListProto may contain multiple sections; in the context of a food menu, this would be multiple menu sections, e.g. for breakfast, lunch, dinner, prix fixe, or dinner for two, etc. At least one menu section must be present. Each section contains a number of items; for food menus, it may be FoodMenuItems defined below. At least one item must be present in each section. | list(GeostorePriceListNameInfoProto) |
| section | Each price list may have multiple sections. Note that these sections within the same price list should most times contain only the same type of items for sale, e.g. all sections should usually contain only food items if the enclosing price list is representing food menu. However, sometimes such a requirement may be wrong, for example, McDonald’s may sell burgers as well as toys, and the toys may be in its own section. Thus we don’t enforce any requirement that all sections contain only the same type of items. | GeostorePriceListProto | A PriceListProto can be used to represent any type of price lists, one of which is a menu of food and drinks. It contains names and descriptions, together with its source URL list if it is extracted or attributed to that URL. The names and descriptions are represented using repeated PriceListNameInfo fields to allow versions in different languages. A PriceListProto may contain multiple sections; in the context of a food menu, this would be multiple menu sections, e.g. for breakfast, lunch, dinner, prix fixe, or dinner for two, etc. At least one menu section must be present. Each section contains a number of items; for food menus, it may be FoodMenuItems defined below. At least one item must be present in each section. | list(GeostorePriceListSectionProto) |
| sourceUrl | Where this price list comes from. If set, this must also be a member of the price_list_url field, and represents translations of a single URL. | GeostorePriceListProto | A PriceListProto can be used to represent any type of price lists, one of which is a menu of food and drinks. It contains names and descriptions, together with its source URL list if it is extracted or attributed to that URL. The names and descriptions are represented using repeated PriceListNameInfo fields to allow versions in different languages. A PriceListProto may contain multiple sections; in the context of a food menu, this would be multiple menu sections, e.g. for breakfast, lunch, dinner, prix fixe, or dinner for two, etc. At least one menu section must be present. Each section contains a number of items; for food menus, it may be FoodMenuItems defined below. At least one item must be present in each section. | GeostoreUrlListProto |
| callToAction | Call to action for the section. | GeostorePriceListSectionProto | A PriceListSectionProto is used to store a section of a PriceListProto. For example, for a PriceListProto representing a food menu, a PriceListSectionProto represents a menu section. Each PriceListSectionProto contains a repeated list of items for sale; these items can be products or services. Right now every section should contain items of one type. | GeostoreCallToActionProto |
| foodItem | To store food and drink items when the containing PriceListSectionProto is a food menu section. | GeostorePriceListSectionProto | A PriceListSectionProto is used to store a section of a PriceListProto. For example, for a PriceListProto representing a food menu, a PriceListSectionProto represents a menu section. Each PriceListSectionProto contains a repeated list of items for sale; these items can be products or services. Right now every section should contain items of one type. | list(GeostoreFoodMenuItemProto) |
| item | To store any items when the containing PriceListSectionProto is not food / legacy services. | GeostorePriceListSectionProto | A PriceListSectionProto is used to store a section of a PriceListProto. For example, for a PriceListProto representing a food menu, a PriceListSectionProto represents a menu section. Each PriceListSectionProto contains a repeated list of items for sale; these items can be products or services. Right now every section should contain items of one type. | list(GeostoreComposableItemProto) |
| itemType | This has to have at most one value. | GeostorePriceListSectionProto | A PriceListSectionProto is used to store a section of a PriceListProto. For example, for a PriceListProto representing a food menu, a PriceListSectionProto represents a menu section. Each PriceListSectionProto contains a repeated list of items for sale; these items can be products or services. Right now every section should contain items of one type. | list(String) |
| language | The external form of a Google International Identifiers Initiative (III) LanguageCode object. See google3/i18n/identifiers/languagecode.h for details. We place extra restrictions on languages in addition to what the III library requires. See go/geo-schema-reference/feature-properties/languages. When set, represents the language of the section and its items. Any section and item level name infos must match this language. Optional. | GeostorePriceListSectionProto | A PriceListSectionProto is used to store a section of a PriceListProto. For example, for a PriceListProto representing a food menu, a PriceListSectionProto represents a menu section. Each PriceListSectionProto contains a repeated list of items for sale; these items can be products or services. Right now every section should contain items of one type. | String |
| media | One or more media items (photos, videos, etc.) describing this section / category. | GeostorePriceListSectionProto | A PriceListSectionProto is used to store a section of a PriceListProto. For example, for a PriceListProto representing a food menu, a PriceListSectionProto represents a menu section. Each PriceListSectionProto contains a repeated list of items for sale; these items can be products or services. Right now every section should contain items of one type. | list(GeostoreMediaItemProto) |
| nameInfo | The repeated name_info field is for price list sections listed in multiple languages. When a price list section has no names or descriptions, the size of the repeated field name_info may be 0. There should be at most one name_info for any given language. | GeostorePriceListSectionProto | A PriceListSectionProto is used to store a section of a PriceListProto. For example, for a PriceListProto representing a food menu, a PriceListSectionProto represents a menu section. Each PriceListSectionProto contains a repeated list of items for sale; these items can be products or services. Right now every section should contain items of one type. | list(GeostorePriceListNameInfoProto) |
| currency | Currency code for the price range: a valid currency code from i18n/identifiers/currencycode.h. Lower and upper price are both assumed to use the same currency. | GeostorePriceRangeProto | This message represents a price range of an attribute. The meaning of the price bounds is domain specific. But mainly they are soft bounds for a normal usage. E.g. “restaurant prices” are subject to an higher level of “soft” bounds than “museum admission price” | String |
| lowerPrice | This message allows unbounded price ranges. e.g. Lower_price is undefined. At least one of the two prices must be set for the price range to be meaningful. | GeostorePriceRangeProto | This message represents a price range of an attribute. The meaning of the price bounds is domain specific. But mainly they are soft bounds for a normal usage. E.g. “restaurant prices” are subject to an higher level of “soft” bounds than “museum admission price” | float |
| units | clang-format on | GeostorePriceRangeProto | This message represents a price range of an attribute. The meaning of the price bounds is domain specific. But mainly they are soft bounds for a normal usage. E.g. “restaurant prices” are subject to an higher level of “soft” bounds than “museum admission price” | String |
| upperPrice | GeostorePriceRangeProto | This message represents a price range of an attribute. The meaning of the price bounds is domain specific. But mainly they are soft bounds for a normal usage. E.g. “restaurant prices” are subject to an higher level of “soft” bounds than “museum admission price” | float | |
| propertyId | The property ID whose value status is defined by this proto. | GeostorePropertyValueStatusProto | PropertyValueStatusProto specifies what we know about a field corresponding to FeaturePropertyId’s value in the absence of any specific value. For now, it just indicates when we know that there is no value. Eventually it might also indicate that we know it has value, just not what it is, etc. | GeostoreFeaturePropertyIdProto |
| valueStatus | `value_status` specifies whether the feature has a value for the property. This should always be set to something other than the default value (`PROPERTY_VALUE_STATUS_UNSPECIFIED`). | GeostorePropertyValueStatusProto | PropertyValueStatusProto specifies what we know about a field corresponding to FeaturePropertyId’s value in the absence of any specific value. For now, it just indicates when we know that there is no value. Eventually it might also indicate that we know it has value, just not what it is, etc. | String |
| dataset | The dataset from which this the referenced data was created. The content of this string will be determined by the data provider, and may encode extra information, such as data confidence. | GeostoreProvenanceProto | This is a minimal version of SourceInfoProto. | String |
| provider | The data provider from which the referenced data was generated. | GeostoreProvenanceProto | This is a minimal version of SourceInfoProto. | String |
| signal | A list of signals. Each one is extracted separately by a SignalExtractor. | GeostoreRankDetailsProto | This message is embedded within a FeatureProto. It has rank calculation details such as available rank signals and rank signal mixer used to compute final rank. For more details, see the Oyster Rank wiki page: http://wiki.corp.google.com/twiki/bin/view/Main/OysterRank | list(GeostoreRankSignalProto) |
| signalMixerType | The signal mixer that was used to calculate the rank. | GeostoreRankDetailsProto | This message is embedded within a FeatureProto. It has rank calculation details such as available rank signals and rank signal mixer used to compute final rank. For more details, see the Oyster Rank wiki page: http://wiki.corp.google.com/twiki/bin/view/Main/OysterRank | String |
| metadata | Field-level metadata for this signal. | GeostoreRankSignalProto | This message is embedded in the RankDetailsProto (below). It represents one rank signal, which is a floating point value estimating the Oyster Rank of the feature. | GeostoreFieldMetadataProto |
| rank | A value in the range [0, 1] estimating Oyster Rank according to this signal. Non-provider specific signals (e.g. SIGNAL_POPULATION) are interpreted by some common code in the ranking pipeline. Because of that, data providers should leave this field empty when setting such signals (so that the rank assignment can be uniform across all features regardless of contributing data providers). On the other hand, provider-specific signals (e.g. SIGNAL_ZENRIN_CITY_CATEGORY) are required to specify the rank field (it is not optional for them). That is because no code other than that of the provider itself will be able to fill in a meaningful value later on. We don’t want clients to be reading from the raw_scalar / raw_string fields to interpret the data. | GeostoreRankSignalProto | This message is embedded in the RankDetailsProto (below). It represents one rank signal, which is a floating point value estimating the Oyster Rank of the feature. | number |
| rawScalar | The raw scalar value that was used to compute ‘rank’ above. The meaning of this attribute changes depending on the signal type. | GeostoreRankSignalProto | This message is embedded in the RankDetailsProto (below). It represents one rank signal, which is a floating point value estimating the Oyster Rank of the feature. | number |
| rawString | The raw string value that was used to compute ‘rank’ above. The meaning of this attribute changes depending on the signal type. | GeostoreRankSignalProto | This message is embedded in the RankDetailsProto (below). It represents one rank signal, which is a floating point value estimating the Oyster Rank of the feature. | String |
| type | GeostoreRankSignalProto | This message is embedded in the RankDetailsProto (below). It represents one rank signal, which is a floating point value estimating the Oyster Rank of the feature. | String | |
| key | The key associated with this data item. For source data in shape file format, this will typically be a column name. Keys need to be unique with respect to a particular data source (see DataSourceProto), but they do not need to be globally unique. You can look up the documentation for a key (e.g. a longer label and description) by following the source_id link of the parent SourceInfoProto, which takes you to a TYPE_DATA_SOURCE feature, and then looking up the corresponding RawMetadataProto object for this key in that feature’s optional data_source field. | GeostoreRawDataProto | A RawDataProto is a key-value pair that represents arbitrary source data from a particular provider. Raw data can be attached to features using their source_info field. | String |
| valueString | All data items are represented as strings, the logic being that it is easy to convert other data types to strings, and there is no need to access this data efficiently. | GeostoreRawDataProto | A RawDataProto is a key-value pair that represents arbitrary source data from a particular provider. Raw data can be attached to features using their source_info field. | String |
| conflationMethod | Method to use when conflating together RawDataProto values at the same key NB: If you add a new ConflationMethod, then you must add the corresponding logic to MergeRawData to conflate the RawDataProto values using this method. | GeostoreRawMetadataProto | String | |
| description | Self-contained documentation about what this field represents and how its values are encoded. | GeostoreRawMetadataProto | String | |
| key | The key being described. | GeostoreRawMetadataProto | String | |
| label | A longer, human-readable name associated with this key. The label might be used in a data explorer tool, for example. | GeostoreRawMetadataProto | String | |
| hi | GeostoreRectProto | A latitude-longitude rectangle, represented as two diagonally opposite points “lo” and “hi”. The rectangle is considered to be a closed region, i.e. it includes its boundary. The latitude bounds must be in the range -90 to 90 degrees inclusive, and the longitude bounds must be in the range -180 to 180 degrees inclusive. Various cases include: – If lo == hi, the rectangle consists of a single point. – If lo.longitude > hi.longitude, the longitude range is “inverted” (the rectangle crosses the 180 degree longitude line). – If lo.longitude == -180 degrees and hi.longitude = 180 degrees, the rectangle includes all longitudes. – If lo.longitude = 180 degrees and hi.longitude = -180 degrees, the longitude range is empty. – If lo.latitude > hi.latitude, the latitude range is empty. | GeostorePointProto | |
| lo | GeostoreRectProto | A latitude-longitude rectangle, represented as two diagonally opposite points “lo” and “hi”. The rectangle is considered to be a closed region, i.e. it includes its boundary. The latitude bounds must be in the range -90 to 90 degrees inclusive, and the longitude bounds must be in the range -180 to 180 degrees inclusive. Various cases include: – If lo == hi, the rectangle consists of a single point. – If lo.longitude > hi.longitude, the longitude range is “inverted” (the rectangle crosses the 180 degree longitude line). – If lo.longitude == -180 degrees and hi.longitude = 180 degrees, the rectangle includes all longitudes. – If lo.longitude = 180 degrees and hi.longitude = -180 degrees, the longitude range is empty. – If lo.latitude > hi.latitude, the latitude range is empty. | GeostorePointProto | |
| displayableAsAlternativeName | If true, this region specific name should be appended, in parentheses, to the appropriate name from FeatureProto.name, for the default rest of world behavior. | GeostoreRegionSpecificNameProto | This protocol buffer supports a name per region per language, allowing it to represent the name of a given feature in different regions and languages. For example, the Persian Gulf has different English names in UAE versus Lebanon; each would need to be represented as distinct RegionSpecificNameProtos. | boolean |
| name | Name to be used for this feature in a specific region and language. | GeostoreRegionSpecificNameProto | This protocol buffer supports a name per region per language, allowing it to represent the name of a given feature in different regions and languages. For example, the Persian Gulf has different English names in UAE versus Lebanon; each would need to be represented as distinct RegionSpecificNameProtos. | GeostoreNameProto |
| regionCode | Region code (or other identifier) for the region. | GeostoreRegionSpecificNameProto | This protocol buffer supports a name per region per language, allowing it to represent the name of a given feature in different regions and languages. For example, the Persian Gulf has different English names in UAE versus Lebanon; each would need to be represented as distinct RegionSpecificNameProtos. | String |
| restriction | The set of restrictions that apply to a zone. These restrictions may limit the routability of every segment contained within the defined feature.polygon. Repeated restrictions are treated collectively as an OR meaning that segments in the zone are only routable if none of the restrictions apply. If any segments within the defined polygon should not have these restrictions applied, they must list this regulated area’s feature id in their feature.exempt_regulated_area field. | GeostoreRegulatedAreaProto | A collection of information that applies to a polygonal area. | list(GeostoreRestrictionProto) |
| metadata | Field-level metadata for this relation. | GeostoreRelationProto | This message is embedded within a FeatureProto, and represents a geographic or logical relationship of that feature to some other feature. Note that some relation types are there purely for the purpose of grouping together other relation types. They are noted as ABSTRACT in comments. Other relation types are no longer supported / in use. They are noted as DEPRECATED in comments (and marked with the standard deprecated option, too). Other relation types are reserved for future use or just not intended for use at all, for various internal reasons. They are noted as RESERVED in comments. WARNING: Updates to this proto within a FeatureProto’s related_feature field handled by standalone pipelines and are NOT atomic with regard to updates to the features being referenced; we do not guarantee that a given MapFacts snapshot will be consistent between this field and the related features. | GeostoreFieldMetadataProto |
| otherFeatureCountryCode | If and only if the other feature is of TYPE_COUNTRY, the 2-letter country code. This is the FLAG_COUNTRY_CODE_2 name of the country component. | GeostoreRelationProto | This message is embedded within a FeatureProto, and represents a geographic or logical relationship of that feature to some other feature. Note that some relation types are there purely for the purpose of grouping together other relation types. They are noted as ABSTRACT in comments. Other relation types are no longer supported / in use. They are noted as DEPRECATED in comments (and marked with the standard deprecated option, too). Other relation types are reserved for future use or just not intended for use at all, for various internal reasons. They are noted as RESERVED in comments. WARNING: Updates to this proto within a FeatureProto’s related_feature field handled by standalone pipelines and are NOT atomic with regard to updates to the features being referenced; we do not guarantee that a given MapFacts snapshot will be consistent between this field and the related features. | String |
| otherFeatureId | The feature ID of the feature to which we’re relating. WARNING: the related feature does not necessarily have a bound that encloses this feature, so in a bucketing MapReduce, you may not be able to follow all relationships. Relations that use strong references are annotated above but you can also refer to IsRelationStrong() in geostore/base/public/relation.h. | GeostoreRelationProto | This message is embedded within a FeatureProto, and represents a geographic or logical relationship of that feature to some other feature. Note that some relation types are there purely for the purpose of grouping together other relation types. They are noted as ABSTRACT in comments. Other relation types are no longer supported / in use. They are noted as DEPRECATED in comments (and marked with the standard deprecated option, too). Other relation types are reserved for future use or just not intended for use at all, for various internal reasons. They are noted as RESERVED in comments. WARNING: Updates to this proto within a FeatureProto’s related_feature field handled by standalone pipelines and are NOT atomic with regard to updates to the features being referenced; we do not guarantee that a given MapFacts snapshot will be consistent between this field and the related features. | GeostoreFeatureIdProto |
| otherFeatureName | RESERVED | GeostoreRelationProto | This message is embedded within a FeatureProto, and represents a geographic or logical relationship of that feature to some other feature. Note that some relation types are there purely for the purpose of grouping together other relation types. They are noted as ABSTRACT in comments. Other relation types are no longer supported / in use. They are noted as DEPRECATED in comments (and marked with the standard deprecated option, too). Other relation types are reserved for future use or just not intended for use at all, for various internal reasons. They are noted as RESERVED in comments. WARNING: Updates to this proto within a FeatureProto’s related_feature field handled by standalone pipelines and are NOT atomic with regard to updates to the features being referenced; we do not guarantee that a given MapFacts snapshot will be consistent between this field and the related features. | list(GeostoreNameProto) |
| otherFeatureTerritorialAdministrator | If and only if the other feature is of TYPE_DISPUTED_AREA, the territorial administrator found in its GeopoliticalAttachmentProto.administered_by field, if any. Since this string is copied exactly, it may be a 2-letter country code or another type of descriptive string. | GeostoreRelationProto | This message is embedded within a FeatureProto, and represents a geographic or logical relationship of that feature to some other feature. Note that some relation types are there purely for the purpose of grouping together other relation types. They are noted as ABSTRACT in comments. Other relation types are no longer supported / in use. They are noted as DEPRECATED in comments (and marked with the standard deprecated option, too). Other relation types are reserved for future use or just not intended for use at all, for various internal reasons. They are noted as RESERVED in comments. WARNING: Updates to this proto within a FeatureProto’s related_feature field handled by standalone pipelines and are NOT atomic with regard to updates to the features being referenced; we do not guarantee that a given MapFacts snapshot will be consistent between this field and the related features. | String |
| otherFeatureType | The type of the feature to which we’re relating. | GeostoreRelationProto | This message is embedded within a FeatureProto, and represents a geographic or logical relationship of that feature to some other feature. Note that some relation types are there purely for the purpose of grouping together other relation types. They are noted as ABSTRACT in comments. Other relation types are no longer supported / in use. They are noted as DEPRECATED in comments (and marked with the standard deprecated option, too). Other relation types are reserved for future use or just not intended for use at all, for various internal reasons. They are noted as RESERVED in comments. WARNING: Updates to this proto within a FeatureProto’s related_feature field handled by standalone pipelines and are NOT atomic with regard to updates to the features being referenced; we do not guarantee that a given MapFacts snapshot will be consistent between this field and the related features. | integer |
| overlapFraction | ** DEPRECATED ** If relation is exactly RELATION_OVERLAPS but not any of its subcategories, overlap_fraction contains an estimate of the fraction of the geometry of this feature that intersects with the other feature, ranging from 0.0 to 1.0. Note that this is a rough estimate based on cell coverings, and may not be very accurate. In particular, values of 0.0 and 1.0 are possible, even though in principle they should not be. | GeostoreRelationProto | This message is embedded within a FeatureProto, and represents a geographic or logical relationship of that feature to some other feature. Note that some relation types are there purely for the purpose of grouping together other relation types. They are noted as ABSTRACT in comments. Other relation types are no longer supported / in use. They are noted as DEPRECATED in comments (and marked with the standard deprecated option, too). Other relation types are reserved for future use or just not intended for use at all, for various internal reasons. They are noted as RESERVED in comments. WARNING: Updates to this proto within a FeatureProto’s related_feature field handled by standalone pipelines and are NOT atomic with regard to updates to the features being referenced; we do not guarantee that a given MapFacts snapshot will be consistent between this field and the related features. | number |
| relation | The relationship of the feature that contains this RelationProto to the feature other_feature_id. Note the relation_is_reversed field below. Some relations imply weak references, other strong ones. Strong references are annotated above but you can also refer to IsRelationStrong() in geostore/base/public/relation.h. | GeostoreRelationProto | This message is embedded within a FeatureProto, and represents a geographic or logical relationship of that feature to some other feature. Note that some relation types are there purely for the purpose of grouping together other relation types. They are noted as ABSTRACT in comments. Other relation types are no longer supported / in use. They are noted as DEPRECATED in comments (and marked with the standard deprecated option, too). Other relation types are reserved for future use or just not intended for use at all, for various internal reasons. They are noted as RESERVED in comments. WARNING: Updates to this proto within a FeatureProto’s related_feature field handled by standalone pipelines and are NOT atomic with regard to updates to the features being referenced; we do not guarantee that a given MapFacts snapshot will be consistent between this field and the related features. | String |
| relationIsReversed | RESERVED | GeostoreRelationProto | This message is embedded within a FeatureProto, and represents a geographic or logical relationship of that feature to some other feature. Note that some relation types are there purely for the purpose of grouping together other relation types. They are noted as ABSTRACT in comments. Other relation types are no longer supported / in use. They are noted as DEPRECATED in comments (and marked with the standard deprecated option, too). Other relation types are reserved for future use or just not intended for use at all, for various internal reasons. They are noted as RESERVED in comments. WARNING: Updates to this proto within a FeatureProto’s related_feature field handled by standalone pipelines and are NOT atomic with regard to updates to the features being referenced; we do not guarantee that a given MapFacts snapshot will be consistent between this field and the related features. | boolean |
| temporaryData | A place for clients to attach arbitrary data to a relation. Never set in MapFacts. | GeostoreRelationProto | This message is embedded within a FeatureProto, and represents a geographic or logical relationship of that feature to some other feature. Note that some relation types are there purely for the purpose of grouping together other relation types. They are noted as ABSTRACT in comments. Other relation types are no longer supported / in use. They are noted as DEPRECATED in comments (and marked with the standard deprecated option, too). Other relation types are reserved for future use or just not intended for use at all, for various internal reasons. They are noted as RESERVED in comments. WARNING: Updates to this proto within a FeatureProto’s related_feature field handled by standalone pipelines and are NOT atomic with regard to updates to the features being referenced; we do not guarantee that a given MapFacts snapshot will be consistent between this field and the related features. | Proto2BridgeMessageSet |
| metadata | Field-level metadata for this restriction group. | GeostoreRestrictionGroupProto | A restriction group represents common properties of a set of restrictions on segments that are associated with the same underlying cause across a geographic region. Every segment referenced by this restriction group should have at least one restriction that refers backs to this restriction group. The standard feature properties have the following interpretations: name – A name that represents the name for this restriction group. kg_property – A reference back to a KG event in case this restriction group belongs to an event in KG. /geo/type/restriction_group/associated_event contains a mid to the associated event. | GeostoreFieldMetadataProto |
| segment | FeatureId of all segments that have a RestrictionProto referring back to this RestrictionGroup. | GeostoreRestrictionGroupProto | A restriction group represents common properties of a set of restrictions on segments that are associated with the same underlying cause across a geographic region. Every segment referenced by this restriction group should have at least one restriction that refers backs to this restriction group. The standard feature properties have the following interpretations: name – A name that represents the name for this restriction group. kg_property – A reference back to a KG event in case this restriction group belongs to an event in KG. /geo/type/restriction_group/associated_event contains a mid to the associated event. | list(GeostoreFeatureIdProto) |
| autonomousDrivingProducts | The restriction only applies in these specific autonomous driving product scenarios. NOTE: This should only be set on restrictions with TRAVEL_AUTONOMOUS_VEHICLE travel mode. | GeostoreRestrictionProto | A restriction is an expression that limits when an action can be taken. Each restriction has a set of conditions. If all of the conditions are true, then the restriction applies and the action cannot be taken. For example, the restriction “no turns 3-5pm except buses” would have two conditions: “time is 3-5pm” and “vehicle is not a bus”. If both of these conditions apply, the restriction is true, and the turn is prohibited. Multiple restrictions may apply to the same action. Clients handle this by always declaring RestrictionProto as a “repeated” element. The semantics of having multiple restrictions are that if any restriction applies, then the action cannot be taken. In other words, restrictions are OR-ed together. Putting all of this together, a set of RestrictionProtos can be interpreted as a bool expression in disjunctive normal form: (A and B) or (D and E and F) or (G and H) The action is prohibited if this expression is true. Note that a restriction with no conditions is always true, i.e. its action is always prohibited. NOTE: RestrictionProtos are often compared against one another (e.g. to check for duplicate/redundant restrictions) by canonicalizing them via GetCanonicalRestriction() in google3/geostore/base/internal/restriction.cc. Any fields that don’t contribute to the definition of a restriction in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalRestriction(). LINT.IfChange | list(String) |
| intersectionGroup | Actually *required* if style=STYLE_IN_OUT, otherwise forbidden. Typically the intersection group type is artifact, but either artifact or logical groups can be used for STYLE_IN_OUT restrictions. | GeostoreRestrictionProto | A restriction is an expression that limits when an action can be taken. Each restriction has a set of conditions. If all of the conditions are true, then the restriction applies and the action cannot be taken. For example, the restriction “no turns 3-5pm except buses” would have two conditions: “time is 3-5pm” and “vehicle is not a bus”. If both of these conditions apply, the restriction is true, and the turn is prohibited. Multiple restrictions may apply to the same action. Clients handle this by always declaring RestrictionProto as a “repeated” element. The semantics of having multiple restrictions are that if any restriction applies, then the action cannot be taken. In other words, restrictions are OR-ed together. Putting all of this together, a set of RestrictionProtos can be interpreted as a bool expression in disjunctive normal form: (A and B) or (D and E and F) or (G and H) The action is prohibited if this expression is true. Note that a restriction with no conditions is always true, i.e. its action is always prohibited. NOTE: RestrictionProtos are often compared against one another (e.g. to check for duplicate/redundant restrictions) by canonicalizing them via GetCanonicalRestriction() in google3/geostore/base/internal/restriction.cc. Any fields that don’t contribute to the definition of a restriction in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalRestriction(). LINT.IfChange | GeostoreFeatureIdProto |
| metadata | Field-level metadata for this restriction. | GeostoreRestrictionProto | A restriction is an expression that limits when an action can be taken. Each restriction has a set of conditions. If all of the conditions are true, then the restriction applies and the action cannot be taken. For example, the restriction “no turns 3-5pm except buses” would have two conditions: “time is 3-5pm” and “vehicle is not a bus”. If both of these conditions apply, the restriction is true, and the turn is prohibited. Multiple restrictions may apply to the same action. Clients handle this by always declaring RestrictionProto as a “repeated” element. The semantics of having multiple restrictions are that if any restriction applies, then the action cannot be taken. In other words, restrictions are OR-ed together. Putting all of this together, a set of RestrictionProtos can be interpreted as a bool expression in disjunctive normal form: (A and B) or (D and E and F) or (G and H) The action is prohibited if this expression is true. Note that a restriction with no conditions is always true, i.e. its action is always prohibited. NOTE: RestrictionProtos are often compared against one another (e.g. to check for duplicate/redundant restrictions) by canonicalizing them via GetCanonicalRestriction() in google3/geostore/base/internal/restriction.cc. Any fields that don’t contribute to the definition of a restriction in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalRestriction(). LINT.IfChange | GeostoreFieldMetadataProto |
| restrictionGroup | Restriction group this restriction belongs to. | GeostoreRestrictionProto | A restriction is an expression that limits when an action can be taken. Each restriction has a set of conditions. If all of the conditions are true, then the restriction applies and the action cannot be taken. For example, the restriction “no turns 3-5pm except buses” would have two conditions: “time is 3-5pm” and “vehicle is not a bus”. If both of these conditions apply, the restriction is true, and the turn is prohibited. Multiple restrictions may apply to the same action. Clients handle this by always declaring RestrictionProto as a “repeated” element. The semantics of having multiple restrictions are that if any restriction applies, then the action cannot be taken. In other words, restrictions are OR-ed together. Putting all of this together, a set of RestrictionProtos can be interpreted as a bool expression in disjunctive normal form: (A and B) or (D and E and F) or (G and H) The action is prohibited if this expression is true. Note that a restriction with no conditions is always true, i.e. its action is always prohibited. NOTE: RestrictionProtos are often compared against one another (e.g. to check for duplicate/redundant restrictions) by canonicalizing them via GetCanonicalRestriction() in google3/geostore/base/internal/restriction.cc. Any fields that don’t contribute to the definition of a restriction in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalRestriction(). LINT.IfChange | GeostoreFeatureIdProto |
| restrictionToken | A token that can be used to identify the version of the data about this restriction. | GeostoreRestrictionProto | A restriction is an expression that limits when an action can be taken. Each restriction has a set of conditions. If all of the conditions are true, then the restriction applies and the action cannot be taken. For example, the restriction “no turns 3-5pm except buses” would have two conditions: “time is 3-5pm” and “vehicle is not a bus”. If both of these conditions apply, the restriction is true, and the turn is prohibited. Multiple restrictions may apply to the same action. Clients handle this by always declaring RestrictionProto as a “repeated” element. The semantics of having multiple restrictions are that if any restriction applies, then the action cannot be taken. In other words, restrictions are OR-ed together. Putting all of this together, a set of RestrictionProtos can be interpreted as a bool expression in disjunctive normal form: (A and B) or (D and E and F) or (G and H) The action is prohibited if this expression is true. Note that a restriction with no conditions is always true, i.e. its action is always prohibited. NOTE: RestrictionProtos are often compared against one another (e.g. to check for duplicate/redundant restrictions) by canonicalizing them via GetCanonicalRestriction() in google3/geostore/base/internal/restriction.cc. Any fields that don’t contribute to the definition of a restriction in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalRestriction(). LINT.IfChange | String |
| schedule | When specified, restriction applies only at particular times (operating hours or times of the year: reversing lanes, seasonal roads, no left turns from 3-5pm Mon-Fri except holidays). Otherwise, restriction is in effect at all times. | GeostoreRestrictionProto | A restriction is an expression that limits when an action can be taken. Each restriction has a set of conditions. If all of the conditions are true, then the restriction applies and the action cannot be taken. For example, the restriction “no turns 3-5pm except buses” would have two conditions: “time is 3-5pm” and “vehicle is not a bus”. If both of these conditions apply, the restriction is true, and the turn is prohibited. Multiple restrictions may apply to the same action. Clients handle this by always declaring RestrictionProto as a “repeated” element. The semantics of having multiple restrictions are that if any restriction applies, then the action cannot be taken. In other words, restrictions are OR-ed together. Putting all of this together, a set of RestrictionProtos can be interpreted as a bool expression in disjunctive normal form: (A and B) or (D and E and F) or (G and H) The action is prohibited if this expression is true. Note that a restriction with no conditions is always true, i.e. its action is always prohibited. NOTE: RestrictionProtos are often compared against one another (e.g. to check for duplicate/redundant restrictions) by canonicalizing them via GetCanonicalRestriction() in google3/geostore/base/internal/restriction.cc. Any fields that don’t contribute to the definition of a restriction in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalRestriction(). LINT.IfChange | GeostoreTimeScheduleProto |
| scope | The scope that the restriction applies to. – SCOPE_DIRECTION means the segment/sibling pair is restricted in the direction of the segment that contains this RestrictionProto. For segment/sibling pairs with pedestrian facilities (and thus side-of-road routing) the RestrictionProto restricts both facilities in the direction of the segment (assuming that the restriction applies to travel mode TRAVEL_PEDESTRIAN). – SCOPE_SIDE means the RestrictionProto applies only to the side of road that the containing segment represents. That sibling’s pedestrian facility is restricted in both directions. Schema constraints: – SCOPE_SIDE must be set if and only if travel_mode == [TRAVEL_PEDESTRIAN] and the segment containing the restriction has the pedestrian_facility field set and is not set to PEDESTRIAN_FACILITY_UNKNOWN. Such restrictions must have no subpath. – All other restrictions must have this field set to SCOPE_DIRECTION (whether explicitly or implicitly). This distinction is necessary for cases such as pedestrian facility on one-way segment/sibling roads. NOTE: This field only makes sense in the context of segment restrictions, not lane restrictions. | GeostoreRestrictionProto | A restriction is an expression that limits when an action can be taken. Each restriction has a set of conditions. If all of the conditions are true, then the restriction applies and the action cannot be taken. For example, the restriction “no turns 3-5pm except buses” would have two conditions: “time is 3-5pm” and “vehicle is not a bus”. If both of these conditions apply, the restriction is true, and the turn is prohibited. Multiple restrictions may apply to the same action. Clients handle this by always declaring RestrictionProto as a “repeated” element. The semantics of having multiple restrictions are that if any restriction applies, then the action cannot be taken. In other words, restrictions are OR-ed together. Putting all of this together, a set of RestrictionProtos can be interpreted as a bool expression in disjunctive normal form: (A and B) or (D and E and F) or (G and H) The action is prohibited if this expression is true. Note that a restriction with no conditions is always true, i.e. its action is always prohibited. NOTE: RestrictionProtos are often compared against one another (e.g. to check for duplicate/redundant restrictions) by canonicalizing them via GetCanonicalRestriction() in google3/geostore/base/internal/restriction.cc. Any fields that don’t contribute to the definition of a restriction in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalRestriction(). LINT.IfChange | String |
| style | Restriction Style defines the semantics of the subpath field, as defined above in the documentation of subpath. | GeostoreRestrictionProto | A restriction is an expression that limits when an action can be taken. Each restriction has a set of conditions. If all of the conditions are true, then the restriction applies and the action cannot be taken. For example, the restriction “no turns 3-5pm except buses” would have two conditions: “time is 3-5pm” and “vehicle is not a bus”. If both of these conditions apply, the restriction is true, and the turn is prohibited. Multiple restrictions may apply to the same action. Clients handle this by always declaring RestrictionProto as a “repeated” element. The semantics of having multiple restrictions are that if any restriction applies, then the action cannot be taken. In other words, restrictions are OR-ed together. Putting all of this together, a set of RestrictionProtos can be interpreted as a bool expression in disjunctive normal form: (A and B) or (D and E and F) or (G and H) The action is prohibited if this expression is true. Note that a restriction with no conditions is always true, i.e. its action is always prohibited. NOTE: RestrictionProtos are often compared against one another (e.g. to check for duplicate/redundant restrictions) by canonicalizing them via GetCanonicalRestriction() in google3/geostore/base/internal/restriction.cc. Any fields that don’t contribute to the definition of a restriction in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalRestriction(). LINT.IfChange | String |
| subpath | “subpath” specifies the GeoStore segments that this restriction applies to, according to the restriction_style field below. Segments that are referenced by this subpath field also refer to this feature back via the same subpath field. For all styles of restriction, all segments in the subpath must have identical copies of the restriction. In other words, restrictions are duplicated along every segment in the subpath. Note that subpaths of length 1 do not have any purpose and are disallowed. Note that it is possible to represent restrictions either using STYLE_CONTIGUOUS, or depending on the length of the subpath, one of the more specific STYLE_SINGLE, STYLE_TURN, or STYLE_IN_OUT. New code should use the more specific alternatives if possible, as they support instant updates. For restriction_style == STYLE_CONTIGUOUS (the default): “subpath” can either be empty, for a single-segment restriction, or it specifies exactly the sequence of segments which this restriction applies to. The subpath may be used to specify a turn restriction (a subpath of length 2) or to prohibit more complex maneuvers. For example, when merging onto a road from the right-hand side it may not be possible to make an immediate left turn due to insufficient time to cross the intervening lanes or the presence of a physical barrier. This would be indicated by a subpath restriction of length 3 or more. For restriction_style == STYLE_SINGLE: The subpath field of the Restriction must be empty. The restriction applies only to the segment it is attached to. There must not be an intersection group specified. For restriction_style == STYLE_TURN: The subpath field of the Restriction must contain exactly two segments. The first is called the “in_segment”, the second is the “out_segment”. They must be contiguous, i.e. the end intersection of the in_segment is the start intersection of the out_segment. The restriction applies only to a direct maneuver from the in_segment to the out_segment. Other paths from the in_segment to the out_segment are not restricted. There must not be an intersection group specified. For restriction_style == STYLE_IN_OUT: The subpath field of the Restriction must contain exactly two segments. The first is called the “in_segment”, the second is the “out_segment”. Note that the two segments define paths, but may not actually be one. The end intersection of the in_segment must be in an intersection group which also contains the start intersection of the out_segment. The in- and out-segments are not required to be adjacent, but may be. Either way, the restriction applies to any path from the in_segment to the out_segment through the intersection group, not just direct turns. The intersection_group must be specified. Note that clients which read restrictions and need to know which paths are restricted by a given IN_OUT restriction must expand the IN_OUT restriction by finding all paths through the intersection group from the in_segment to the out_segment. | GeostoreRestrictionProto | A restriction is an expression that limits when an action can be taken. Each restriction has a set of conditions. If all of the conditions are true, then the restriction applies and the action cannot be taken. For example, the restriction “no turns 3-5pm except buses” would have two conditions: “time is 3-5pm” and “vehicle is not a bus”. If both of these conditions apply, the restriction is true, and the turn is prohibited. Multiple restrictions may apply to the same action. Clients handle this by always declaring RestrictionProto as a “repeated” element. The semantics of having multiple restrictions are that if any restriction applies, then the action cannot be taken. In other words, restrictions are OR-ed together. Putting all of this together, a set of RestrictionProtos can be interpreted as a bool expression in disjunctive normal form: (A and B) or (D and E and F) or (G and H) The action is prohibited if this expression is true. Note that a restriction with no conditions is always true, i.e. its action is always prohibited. NOTE: RestrictionProtos are often compared against one another (e.g. to check for duplicate/redundant restrictions) by canonicalizing them via GetCanonicalRestriction() in google3/geostore/base/internal/restriction.cc. Any fields that don’t contribute to the definition of a restriction in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalRestriction(). LINT.IfChange | list(GeostoreFeatureIdProto) |
| temporaryData | A place for clients to attach arbitrary data to a restriction. Never set in MapFacts. | GeostoreRestrictionProto | A restriction is an expression that limits when an action can be taken. Each restriction has a set of conditions. If all of the conditions are true, then the restriction applies and the action cannot be taken. For example, the restriction “no turns 3-5pm except buses” would have two conditions: “time is 3-5pm” and “vehicle is not a bus”. If both of these conditions apply, the restriction is true, and the turn is prohibited. Multiple restrictions may apply to the same action. Clients handle this by always declaring RestrictionProto as a “repeated” element. The semantics of having multiple restrictions are that if any restriction applies, then the action cannot be taken. In other words, restrictions are OR-ed together. Putting all of this together, a set of RestrictionProtos can be interpreted as a bool expression in disjunctive normal form: (A and B) or (D and E and F) or (G and H) The action is prohibited if this expression is true. Note that a restriction with no conditions is always true, i.e. its action is always prohibited. NOTE: RestrictionProtos are often compared against one another (e.g. to check for duplicate/redundant restrictions) by canonicalizing them via GetCanonicalRestriction() in google3/geostore/base/internal/restriction.cc. Any fields that don’t contribute to the definition of a restriction in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalRestriction(). LINT.IfChange | Proto2BridgeMessageSet |
| travelMode | Restriction applies only to the given travel modes. This field should always be set, but may be missing in old data. WARNING: Restrictions with no travel modes are DEPRECATED. Historically, no travel modes has meant “all travel modes”, except they didn’t really even mean that, because Pathfinder would use a complex set of heuristics to interpret the “correct” travel modes. Pathfinder currently (last updated August 2013) has heuristics to cope with incomplete data that reduce or extend application of the specified restrictions to pedestrians or bicycles. We are actively working to remove these heuristics and replace them with explicit, correct travel modes in the data. See b/8746491. | GeostoreRestrictionProto | A restriction is an expression that limits when an action can be taken. Each restriction has a set of conditions. If all of the conditions are true, then the restriction applies and the action cannot be taken. For example, the restriction “no turns 3-5pm except buses” would have two conditions: “time is 3-5pm” and “vehicle is not a bus”. If both of these conditions apply, the restriction is true, and the turn is prohibited. Multiple restrictions may apply to the same action. Clients handle this by always declaring RestrictionProto as a “repeated” element. The semantics of having multiple restrictions are that if any restriction applies, then the action cannot be taken. In other words, restrictions are OR-ed together. Putting all of this together, a set of RestrictionProtos can be interpreted as a bool expression in disjunctive normal form: (A and B) or (D and E and F) or (G and H) The action is prohibited if this expression is true. Note that a restriction with no conditions is always true, i.e. its action is always prohibited. NOTE: RestrictionProtos are often compared against one another (e.g. to check for duplicate/redundant restrictions) by canonicalizing them via GetCanonicalRestriction() in google3/geostore/base/internal/restriction.cc. Any fields that don’t contribute to the definition of a restriction in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalRestriction(). LINT.IfChange | list(String) |
| type | LINT.ThenChange(//depot/google3/google/geo/entities/v1/fields/segment.proto) clang-format on The type of restriction. This is not a condition, but rather tells you what kind of restriction it is. This field should always be set. | GeostoreRestrictionProto | A restriction is an expression that limits when an action can be taken. Each restriction has a set of conditions. If all of the conditions are true, then the restriction applies and the action cannot be taken. For example, the restriction “no turns 3-5pm except buses” would have two conditions: “time is 3-5pm” and “vehicle is not a bus”. If both of these conditions apply, the restriction is true, and the turn is prohibited. Multiple restrictions may apply to the same action. Clients handle this by always declaring RestrictionProto as a “repeated” element. The semantics of having multiple restrictions are that if any restriction applies, then the action cannot be taken. In other words, restrictions are OR-ed together. Putting all of this together, a set of RestrictionProtos can be interpreted as a bool expression in disjunctive normal form: (A and B) or (D and E and F) or (G and H) The action is prohibited if this expression is true. Note that a restriction with no conditions is always true, i.e. its action is always prohibited. NOTE: RestrictionProtos are often compared against one another (e.g. to check for duplicate/redundant restrictions) by canonicalizing them via GetCanonicalRestriction() in google3/geostore/base/internal/restriction.cc. Any fields that don’t contribute to the definition of a restriction in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalRestriction(). LINT.IfChange | String |
| vehicleAttributeFilter | The restriction only applies to vehicles that meet all of the attributes defined here. If this is empty, it does not affect the scope of the restriction. | GeostoreRestrictionProto | A restriction is an expression that limits when an action can be taken. Each restriction has a set of conditions. If all of the conditions are true, then the restriction applies and the action cannot be taken. For example, the restriction “no turns 3-5pm except buses” would have two conditions: “time is 3-5pm” and “vehicle is not a bus”. If both of these conditions apply, the restriction is true, and the turn is prohibited. Multiple restrictions may apply to the same action. Clients handle this by always declaring RestrictionProto as a “repeated” element. The semantics of having multiple restrictions are that if any restriction applies, then the action cannot be taken. In other words, restrictions are OR-ed together. Putting all of this together, a set of RestrictionProtos can be interpreted as a bool expression in disjunctive normal form: (A and B) or (D and E and F) or (G and H) The action is prohibited if this expression is true. Note that a restriction with no conditions is always true, i.e. its action is always prohibited. NOTE: RestrictionProtos are often compared against one another (e.g. to check for duplicate/redundant restrictions) by canonicalizing them via GetCanonicalRestriction() in google3/geostore/base/internal/restriction.cc. Any fields that don’t contribute to the definition of a restriction in the real world should be bundled with the annotative fields near the bottom and excluded in GetCanonicalRestriction(). LINT.IfChange | GeostoreVehicleAttributeFilterProto |
| fieldWithRights | GeostoreRightsStatusProto | Proto used to represent rights for FeatureProto. See go/geo-rights for more details. NOTE: Use google3/geostore/provenance/public/rights.h or google3/java/com/google/geostore/provenance/rights/Rights.java instead of accessing this proto directly. | list(GeostoreFieldWithRightsProto) | |
| timeSchedule | Specifies what times the information is applicable. This can be specific times (3-5 PM) or days of the week (Mon – Fri), as well as more general times like school hours, dusk to dawn, etc. If no value is set, the restriction is applicable at all times. | GeostoreRoadConditionalProto | A RoadConditionalProto defines conditions that affect when the road traversal information is applicable. | GeostoreTimeScheduleProto |
| vehicleAttribute | Additional attributes that apply to the applied vehicle types. | GeostoreRoadConditionalProto | A RoadConditionalProto defines conditions that affect when the road traversal information is applicable. | GeostoreVehicleAttributeFilterProto |
| vehicleType | Restrictions applying to specific types of vehicles. | GeostoreRoadConditionalProto | A RoadConditionalProto defines conditions that affect when the road traversal information is applicable. | list(String) |
| monitoredRoad | The TYPE_ROAD segment features that this road monitor may observe. | GeostoreRoadMonitorProto | A road monitor is a device that observes traffic for road violations like speeding or running a red light. These are modeled within MapFacts so that navigation services can warn users when they drive along road segments that are monitored. | list(GeostoreFeatureIdProto) |
| featureId | The id of the feature referred to by this component, typically the route or locality feature this sign points towards. In the ASCII art example above, this field would contain the id for the routes A11 and E50 and the localities Chartres and Paris in the corresponding component. | GeostoreRoadSignComponentProto | Below is some horrible ASCII art and a description of the components of a road sign. +——————-+ | A11 E50 Paris | | Chartres | +——————-+ This sign would be composed of four components (all of them text components, the only option we support for now). The three in the first row would all have a “major_position” of zero. Their “minor_position” values would be zero for “A11”, one for “E50”, and two for “Paris”. The component in the second row would have “major_position” value of one. This message provides the details of a single component of a road sign. A component defines its position within a sign, its type, and its content. | GeostoreFeatureIdProto |
| featureType | The type of the feature referred to by this component. If feature_id is specified type of that feature should be the same as this field. | GeostoreRoadSignComponentProto | Below is some horrible ASCII art and a description of the components of a road sign. +——————-+ | A11 E50 Paris | | Chartres | +——————-+ This sign would be composed of four components (all of them text components, the only option we support for now). The three in the first row would all have a “major_position” of zero. Their “minor_position” values would be zero for “A11”, one for “E50”, and two for “Paris”. The component in the second row would have “major_position” value of one. This message provides the details of a single component of a road sign. A component defines its position within a sign, its type, and its content. | integer |
| majorPosition | This is the “major” position of this component within the set of components that make up a sign. This number can be thought of as the “row” of the sign on which the component appears, but no guarantees are made that there is a one-to-one mapping between “major_position” and the rows of information on the actual sign being modeled. A “major_position” value of zero would indicate that the component is near the top of the sign. | GeostoreRoadSignComponentProto | Below is some horrible ASCII art and a description of the components of a road sign. +——————-+ | A11 E50 Paris | | Chartres | +——————-+ This sign would be composed of four components (all of them text components, the only option we support for now). The three in the first row would all have a “major_position” of zero. Their “minor_position” values would be zero for “A11”, one for “E50”, and two for “Paris”. The component in the second row would have “major_position” value of one. This message provides the details of a single component of a road sign. A component defines its position within a sign, its type, and its content. | integer |
| minorPosition | This is the position of a component within the components of a sign that share a common “major_position”. It can be though of as the “column” of the component, but like “major_position”, no guarantees are made regarding its mapping to reality. For data sources that don’t provide enough information to determine a component’s major and minor positions, major position should be populated and minor position should not be present. A “minor_position” value of zero would indicate that the component is near the “beginning” of the sign. In countries where signs are read from left to right, “minor_position” zero would be near the left side of the sign. | GeostoreRoadSignComponentProto | Below is some horrible ASCII art and a description of the components of a road sign. +——————-+ | A11 E50 Paris | | Chartres | +——————-+ This sign would be composed of four components (all of them text components, the only option we support for now). The three in the first row would all have a “major_position” of zero. Their “minor_position” values would be zero for “A11”, one for “E50”, and two for “Paris”. The component in the second row would have “major_position” value of one. This message provides the details of a single component of a road sign. A component defines its position within a sign, its type, and its content. | integer |
| routeDirection | The direction of traffic for the referenced TYPE_ROUTE feature. | GeostoreRoadSignComponentProto | Below is some horrible ASCII art and a description of the components of a road sign. +——————-+ | A11 E50 Paris | | Chartres | +——————-+ This sign would be composed of four components (all of them text components, the only option we support for now). The three in the first row would all have a “major_position” of zero. Their “minor_position” values would be zero for “A11”, one for “E50”, and two for “Paris”. The component in the second row would have “major_position” value of one. This message provides the details of a single component of a road sign. A component defines its position within a sign, its type, and its content. | String |
| semanticType | The semantic type of sign. | GeostoreRoadSignComponentProto | Below is some horrible ASCII art and a description of the components of a road sign. +——————-+ | A11 E50 Paris | | Chartres | +——————-+ This sign would be composed of four components (all of them text components, the only option we support for now). The three in the first row would all have a “major_position” of zero. Their “minor_position” values would be zero for “A11”, one for “E50”, and two for “Paris”. The component in the second row would have “major_position” value of one. This message provides the details of a single component of a road sign. A component defines its position within a sign, its type, and its content. | String |
| text | If this sign component is of type “TYPE_TEXT”, this field contains the text of the component. A NameProto is used to allow language and flags to be associated with the text. | GeostoreRoadSignComponentProto | Below is some horrible ASCII art and a description of the components of a road sign. +——————-+ | A11 E50 Paris | | Chartres | +——————-+ This sign would be composed of four components (all of them text components, the only option we support for now). The three in the first row would all have a “major_position” of zero. Their “minor_position” values would be zero for “A11”, one for “E50”, and two for “Paris”. The component in the second row would have “major_position” value of one. This message provides the details of a single component of a road sign. A component defines its position within a sign, its type, and its content. | GeostoreNameProto |
| component | The list of components for a single road sign. A sign may be composed of multiple components, each with its own position and content. | GeostoreRoadSignProto | A RoadSignProto holds the details of a road sign. Currently this is simply a list of the items that appear on the sign and their relative position. | list(GeostoreRoadSignComponentProto) |
| displayPreference | clang-format on | GeostoreRouteAssociationProto | This protocol buffer holds metadata about the association between a segment and a route. | String |
| metadata | Field-level metadata for the route association. | GeostoreRouteAssociationProto | This protocol buffer holds metadata about the association between a segment and a route. | GeostoreFieldMetadataProto |
| route | Identifies the route feature to which this metadata applies. This is one of the routes the segment refers to via the SegmentProto.route field. | GeostoreRouteAssociationProto | This protocol buffer holds metadata about the association between a segment and a route. | GeostoreFeatureIdProto |
| routeDirection | The direction of the TYPE_ROUTE feature in this route association. A small number of countries (mostly just the United States, Mexico, and Canada) use directional routes. For example, in the United States highway US-1 is referred to as US-1 North or US-1 South on the sides where flow of traffic moves in those directions. | GeostoreRouteAssociationProto | This protocol buffer holds metadata about the association between a segment and a route. | String |
| childType | The feature type of the route children. Should be set if and only if all children are of the same feature type. | GeostoreRouteProto | A route is a collection of segments that forms a logical group – usually a named road or highway. Segments can belong to more than one route, and the segments of one route may be a subset of the segments of another route (e.g. I-5 N is a subset of I-5). Segments in the collection that define the route do not need to constitute a single uninterrupted line, there can be disconnects. The standard feature properties are interpreted as follows: name – Routes should have one or more names. (While unnamed roads certainly exist in the real world, we choose not to create route features for such roads. Instead, the unnamed segments are merely not part of any route.) address – This should always be empty. type – Specifies a particular route subtype, see feature.proto. point – This should always be empty. polyline – This should always be empty. polygon – This should always be empty. child – The pairs of segments that belong to this route (a given route should always reference segments in both travel directions). | integer |
| type | GeostoreSchoolDistrictProto | This protocol buffer holds school district specific attributes for features of TYPE_SCHOOL_DISTRICT. | String | |
| subpath | Specifies a sequence of feature ids of GeoStore segments. The feature ids are ordered. The path “AB” is not the same as the path “BA”. The segments along the path are assumed to be connected via the appropriate intersections. The segment features that are referenced by this subpath refer to this feature back via the road_sign field in segment proto extension. | GeostoreSegmentPathProto | A segment path describes a path through a short set of segments. The segment path can be used for any purpose. At the moment, only TYPE_ROAD_SIGN features can have associated segment paths: The segment path lists the segments that refer to the sign. These are the segments for which the sign is applicable. The sign’s physical location is independent of the segments in the path. | list(GeostoreFeatureIdProto) |
| surface | clang-format on LINT.ThenChange(//depot/google3/geostore/base/proto/lane.proto) Specific lanes may override this segment-level surface type. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | String |
| visibleLandmark | A collection of landmarks that are visible when traveling along this segment and useful for wayfinding to users following routes using this segment. The landmark need not be on the segment. Each segment in a pair of siblings specifies its landmarks independently. A landmark applicable to both appears in both. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | list(GeostoreLandmarkReferenceProto) |
| advisoryMaximumSpeed | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | list(GeostoreAppliedSpeedLimitProto) | |
| constructionStatus | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | String | |
| bicycleFacility | clang-format on | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | String |
| barrier | clang-format on | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | String |
| covered | Whether the segment is covered by a roof etc. If this field is missing, the status is unknown. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | boolean |
| endpointMetadata | Field-level metadata for the endpoint. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | GeostoreFieldMetadataProto |
| distanceToEdgeMetadata | Field-level metadata for distance_to_edge. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | GeostoreFieldMetadataProto |
| pedestrianFacility | clang-format on | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | String |
| constructionBeginDate | If known, the date that construction is scheduled to begin. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | GeostoreDateTimeProto |
| constructionStatusMetadata | Field-level metadata for the construction status. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | GeostoreFieldMetadataProto |
| bicycleSafety | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | String | |
| usage | clang-format on LINT.ThenChange(//depot/google3/maps/pathfinder/pgraph/pgraph-segment-categories.cc) | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | String |
| avgSpeedKphMetadata | Field-level metadata for the average speed. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | GeostoreFieldMetadataProto |
| barrierMetadata | Field-level metadata for the barrier. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | GeostoreFieldMetadataProto |
| roadMonitor | The road monitors that monitor this segment for traffic violations. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | list(GeostoreFeatureIdProto) |
| altitude | RESERVED | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | list(number) |
| sweep | The geometric sweeps between this segment and nearby segments, used for real road width rendering. A sweep describes the surface that connects to segments. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | list(GeostoreSweepProto) |
| maxPermittedSpeedKph | LINT.IfChange(speed_limits) The maximum speed that is permitted on this segment, in kilometers per hour. This should be the segment’s legal speed limit; however, note that it may contain estimated values based on country-wide defaults and other heuristics (see ‘is_max_permitted_speed_derived’ below). Before exposing this field to users as the legal speed limit please consult with Google lawyers. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | number |
| pedestrianGrade | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | String | |
| distanceToEdge | Average distance between the segment’s polyline and edge of the road on this side in meters. It need not be equal to the sum of width of all lanes in this direction. This width includes on-street bicycle lanes but excludes off-street lanes such as sidewalks. The edge of the road is the rightmost edge for segments in right side driving countries and leftmost edge for left side driving countries. Width of the road is sum of this and sibling’s distance_to_edge. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | number |
| pedestrianCrossing | Defines the pedestrian crossing(s) between the end point of this segment and the start point of this segment’s sibling. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | GeostorePedestrianCrossingProto |
| tollRoad | If this segment is part of a toll road. It would be nice to have data about the toll cost, locations of toll booths, and so forth. Sadly, we don’t have this data at this time. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | boolean |
| constructionEndDate | If known, the date that construction is scheduled to end. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | GeostoreDateTimeProto |
| conditionMetadata | Field-level metadata for the condition. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | GeostoreFieldMetadataProto |
| route | The route(s) to which this segment belongs. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | list(GeostoreFeatureIdProto) |
| roadSign | The road sign(s) which this segment refers to. These are features of TYPE_ROAD_SIGN that are applicable to this segment. For example, a sign that says “TO KIRKLAND” might apply to several segments on a freeway off-ramp (until the end of the ramp). Note that this field makes it easy to find the signs for a given road segment. The feature for the sign lists the segments that refer to it. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | list(GeostoreFeatureIdProto) |
| onRight | Specifies whether this segment carries right-hand traffic (cars keep to the right side of the road) instead of left-hand traffic (cars keep to the left side). This is true for US roads and false for UK roads, for example. See go/wikip/Left-_and_right-hand_traffic. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | boolean |
| ramp | May only be set when the segment’s usage is `USAGE_RAMP`. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | GeostoreSegmentProtoRampProto |
| surfaceMetadata | Field-level metadata for the surface. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | GeostoreFieldMetadataProto |
| condition | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | String | |
| edgeFollowsSegmentEndFraction | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | number | |
| routeAssociation | Holds metadata about the associations between this segment and the route features listed in the route field. This metadata need not be present; the only consistency requirement is that every feature ID that appears inside ‘route_association’ must also appear in the repeated ‘route’ field. If a route does not appear in route_association, consumers should assume that it has a default initialized RouteAssociationProto. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | list(GeostoreRouteAssociationProto) |
| internal | Internal-only data. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | GeostoreInternalSegmentProto |
| endpoint | clang-format on | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | String |
| elevationMetadata | Field-level metadata for the elevation. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | GeostoreFieldMetadataProto |
| gradeLevel | Detailed information about grade levels along the segment. If a GradeLevelProto is not present for any point (index) along the segment, the default grade level is zero. In between two points (indexes), the grade level of the segment is taken to be the max of the grade levels on either side of it. See gradelevel.proto for semantics of repeated indexes. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | list(GeostoreGradeLevelProto) |
| priority | LINT.ThenChange(//depot/google3/maps/pathfinder/pgraph/pgraph-segment-categories.cc) | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | String |
| interpolationOffsetMeters | If specified, the perpendicular offset in meters from a road segment to an interpolated address along that road segment. See go/synthetic-address-positions. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | number |
| slope | Each slope instance is tied to a point along the segment polyline (unrelated to the vertices in the segment’s polyline) and represents the slope of the segment between that point and the point tied to the next slope istance, or the end of the segment if it’s the last slope instance. A segment should have at least one slope. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | list(GeostoreSlopeProto) |
| legalMinimumSpeed | LINT.ThenChange(//depot/google3/geostore/base/internal/segment.cc:has_speed_limit) | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | list(GeostoreAppliedSpeedLimitProto) |
| intersection | The intersection feature corresponding to the destination of this segment. Intersections are used to represent the connectivity between segments. Each intersection stores the segment ids of all the incoming and outgoing segments that meet at that intersection. Turns can be made from this segment to any of the outgoing segments of its intersection, unless there is a restriction that explicitly disallows the turn (see below). Every segment has an intersection object, even if there are no other segments to connect to (i.e., a cul-de-sac or dead end). | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | GeostoreFeatureIdProto |
| sibling | The other segment of this segment pair (see above). The segment that is referenced by the sibling field refers to this feature back via the same sibling field. Both segment and sibling should have the same properties such as geometry, country code, elevation, level relation, priority etc. Since routes are required to have segment and sibling at the same time, the set of routes on a segment is same to that of the sibling. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | GeostoreFeatureIdProto |
| isMaxPermittedSpeedDerived | Specifies whether the max_permitted_speed_kph was derived from a heuristic as opposed to coming from an authoritative source. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | boolean |
| lane | Detailed information about each lane in this direction, if available. Lanes are numbered from inside of the road outward, i.e. the lane next to the center line has lane_number 0. Note that lanes that are valid for travel in both directions appear in both segments of a segment pair (left turn lanes, one-lane roads, some passing lanes, reversing lanes). Some lanes may not be usable by cars, such as bike lanes. Also, some lanes may not exist along the entire segment, e.g. left- or right-turn lanes that appear just before the intersection. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | list(GeostoreLaneProto) |
| maxPermittedSpeedKphMetadata | Field-level metadata for the maximum permitted speed. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | GeostoreFieldMetadataProto |
| avgSpeedKph | The average speed that should be expected along this route under normal conditions, in kilometers per hour. (Hopefully we’ll replace this with something a lot more sophisticated.) | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | number |
| separatedRoadways | Indicates whether the segment’s opposing lanes of traffic are separated from this segment, and hence have been represented in a separate feature. This means that there are two pairs of siblings instead of one. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | boolean |
| edgeFollowsSegmentBeginFraction | These indicate for what portion of the segment does the outer curb of the segment follow the segment polyline – i.e., where do the sweep curves connect along the outer curb. If unspecified, may be assumed to be equal to lane retraction, preferring outermost lane. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | number |
| priorityMetadata | Field-level metadata for the priority. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | GeostoreFieldMetadataProto |
| legalMaximumSpeed | The legal maximum, legal minimum, and advisory (recommended but non-legally binding) maximum speed limits that are permitted on this segment. These should be the segment’s legal limits; however, note that it may contain estimated values based on country-wide defaults and other heuristics (see ‘AppliedSpeedLimitProto.trust_level’). Before exposing these fields to users as the legal speed limit please consult with Google lawyers. | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | list(GeostoreAppliedSpeedLimitProto) |
| restriction | The set of restrictions that apply to this segment. Restrictions may make a single segment, turn, or more complex maneuver along a set of segments unroutable for the specified travel modes, or may only add penalties or warnings, depending on the restriction type. Turn restrictions are one example of a restriction. By default, turns are allowed onto all outgoing segments from this segment’s intersection (including the sibling of this segment, i.e. U-turns are allowed by default). If any of these turns are disallowed they will be listed as “subpath restrictions”. A subpath restriction disallows travel on given sequence of segments. In the case of a disallowed turn, the subpath simply consists of the source and destination feature ids. There may also be restrictions that apply to all travel on this segment (e.g. chains required, or closed in winter), or restrictions that just apply to certain lanes (e.g. high occupancy vehicle lanes). | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | list(GeostoreRestrictionProto) |
| elevation | clang-format on | GeostoreSegmentProto | ————————————————————————— WARNING – if you add new fields to SegmentProto (or to other protos used by SegmentProto), you need to: – ensure that the ShortSegmentsMerger class (in geostore/tools/internal/mr-mergesegments.cc) is aware of them, otherwise the new fields will be discarded randomly. – consider whether they should be cleared in the ClearFeature() function (in maps/render/process-high-priority-roads.cc) if they are irrelevant for rendering high priority roads at far-out zoom levels. – update the test cases that ensure these two packages know all the SegmentProto fields in both mr-mergesegments_test.cc and maps/render/process-high-priority-roads_test.cc or you will break the VersaTile build. ————————————————————————— | String |
| maxConnectedPriority | The highest priority of any TYPE_ROAD endpoint segment which is transitively connected to this ramp via other ramp segments. For instance, if we have two roads connected through a series of ramps (omitting intersections): Road(P=96)-> Ramp 1 -> Ramp 2 -> Ramp 3 -> Road(P=122) -> Road(P=144) The `max_connected_priority` of all three intermediary ramps is 122. It’s not 144, since Road(P=144) is connected through another road, not a ramp. This differs from the usual `SegmentProto.priority` field, which contains the lowest priority across any connected road segment. | GeostoreSegmentProtoRampProto | Encapsulates ramp-specific properties. | String |
| servedFeature | The features that make up the service area for this establishment. These features are subject to the following constraints applied by editing middleware (notably, not strictly enforced by lints in storage): 1. The following feature types (and their subtypes) may be used: + TYPE_ISLAND + TYPE_POLITICAL, except the following prohibited subtypes: – TYPE_CONSTITUENCY – TYPE_LAND_PARCEL + TYPE_POSTAL 2. There is a maximum limit (currently 20) to the number of areas which may be provided. This is due to serving efficiency limitations. 3. There are no additional geometry requirements for these features beyond the requirements based on the feature types above. In practice this means that these features will either have polygonal or point-based geometries. 4. These referenced features are generally required to have names, though this is not strictly enforced. | GeostoreServiceAreaProto | This proto represents the geographic area served by an establishment. WARNING: This proto is not meant to be used directly. Please use the provided libraries. http://google3/geostore/base/public/service_area.h http://google3/java/com/google/geostore/base/ServiceArea.java | list(GeostoreFeatureIdProto) |
| id | Reference to a Transit POI feature (gcid:transit_station) or platform compound section (gcid:railway_platform) serviced by the line variant. | GeostoreServicedStopProto | Defines an ordered reference to a line variant’s stop. | GeostoreFeatureIdProto |
| index | An index representing the order in which the above station is serviced by the line variant. | GeostoreServicedStopProto | Defines an ordered reference to a line variant’s stop. | integer |
| type | GeostoreSkiBoundaryProto | This protocol buffer holds attributes for features of TYPE_SKI_BOUNDARY. | String | |
| type | clang-format on | GeostoreSkiLiftProto | This protocol buffer holds attributes for features of TYPE_SKI_LIFT. | String |
| difficulty | GeostoreSkiTrailProto | This protocol buffer holds attributes for features of TYPE_SKI_TRAIL. | String | |
| type | GeostoreSkiTrailProto | This protocol buffer holds attributes for features of TYPE_SKI_TRAIL. | String | |
| slopeValue | Slope value as elevation change divided by horizontal distance, in the format of decimal, e.g., ‘0.1234’ means a 12.34% slope. If a slope_value is unset, it indicates we don’t have enough information to compute slope at this location. | GeostoreSlopeProto | number | |
| startPointFraction | Indicates how far along the segment this slope value starts to apply, in the format of decimal between 0 and 1. | GeostoreSlopeProto | number | |
| baseGaiaId | WARNING: Please do NOT introduce new uses; treat this field as if it were deprecated. | GeostoreSocialReferenceProto | MapFacts GAIA ID assigned to this feature. These values are virtual GAIA IDs from MapFacts, and as such are not stored in Focus. | String |
| claimedGaiaId | GAIA ID used when a business has been claimed. This value is a robot GAIA ID. Robots are a special type of GAIA account used to denote identity for a user or a group of users, but are not logged-in directly by a user. | GeostoreSocialReferenceProto | MapFacts GAIA ID assigned to this feature. These values are virtual GAIA IDs from MapFacts, and as such are not stored in Focus. | String |
| gaiaIdForDisplay | WARNING: Please do NOT introduce new uses; treat this field as if it were deprecated. | GeostoreSocialReferenceProto | MapFacts GAIA ID assigned to this feature. These values are virtual GAIA IDs from MapFacts, and as such are not stored in Focus. | String |
| attributionUrl | This is the URL of a page representing all the data from this source in this feature. It may have be the ultimate source of the data (in case of scraping) or merely the same data styled according the provider’s taste. There is a similar field in DataSourceProto which is NOT cached in this field, since it has a different meaning. | GeostoreSourceInfoProto | Source infos are the canonical way to establish data provenance. They can currently be set on features, edits, and issues. Every feature has a repeated list of SourceInfoProto messages to describe the source data that was used in building this feature. The data includes a feature id that points to additional data about the data source (version, copyright notice, etc), and optional “raw data” that is taken directly from the provider’s format and has not been converted to a canonical form. | list(GeostoreUrlProto) |
| collectionDate | The time that this particular piece of data was collected. If different attributes were collected on different dates, this is the date of the most recent edit. | GeostoreSourceInfoProto | Source infos are the canonical way to establish data provenance. They can currently be set on features, edits, and issues. Every feature has a repeated list of SourceInfoProto messages to describe the source data that was used in building this feature. The data includes a feature id that points to additional data about the data source (version, copyright notice, etc), and optional “raw data” that is taken directly from the provider’s format and has not been converted to a canonical form. | GeostoreDateTimeProto |
| cookie | A source info may have a magic cookie whose content and semantics are defined by the specific import process or third-party feed. For feeds that are processed by Distillery, the cookie, when set, should contain the unique identifier for the feature as provided by the feed. | GeostoreSourceInfoProto | Source infos are the canonical way to establish data provenance. They can currently be set on features, edits, and issues. Every feature has a repeated list of SourceInfoProto messages to describe the source data that was used in building this feature. The data includes a feature id that points to additional data about the data source (version, copyright notice, etc), and optional “raw data” that is taken directly from the provider’s format and has not been converted to a canonical form. | String |
| dataset | The dataset from which this SourceInfoProto was created. The content of this string will be determined by the data provider (e.g. for MultiNet data, “fra” would indicate the dataset for France). This field is unnecessary for providers that deliver a single dataset per release (e.g. Basarsoft). | GeostoreSourceInfoProto | Source infos are the canonical way to establish data provenance. They can currently be set on features, edits, and issues. Every feature has a repeated list of SourceInfoProto messages to describe the source data that was used in building this feature. The data includes a feature id that points to additional data about the data source (version, copyright notice, etc), and optional “raw data” that is taken directly from the provider’s format and has not been converted to a canonical form. | String |
| gaiaId | The Gaia ID of the user who provided us with this data. This field should never be set on source infos present on features, but may be set on source infos present on edits. DEPRECATED: Most clients should use the “user” field instead where Gaia IDs are encrypted. | GeostoreSourceInfoProto | Source infos are the canonical way to establish data provenance. They can currently be set on features, edits, and issues. Every feature has a repeated list of SourceInfoProto messages to describe the source data that was used in building this feature. The data includes a feature id that points to additional data about the data source (version, copyright notice, etc), and optional “raw data” that is taken directly from the provider’s format and has not been converted to a canonical form. | String |
| impersonationUser | Information about an internal user or system that is operating on behalf of `user` by way of impersonation. | GeostoreSourceInfoProto | Source infos are the canonical way to establish data provenance. They can currently be set on features, edits, and issues. Every feature has a repeated list of SourceInfoProto messages to describe the source data that was used in building this feature. The data includes a feature id that points to additional data about the data source (version, copyright notice, etc), and optional “raw data” that is taken directly from the provider’s format and has not been converted to a canonical form. | GeostoreUserProto |
| layer | The name of the layer from which this SourceInfoProto was created. | GeostoreSourceInfoProto | Source infos are the canonical way to establish data provenance. They can currently be set on features, edits, and issues. Every feature has a repeated list of SourceInfoProto messages to describe the source data that was used in building this feature. The data includes a feature id that points to additional data about the data source (version, copyright notice, etc), and optional “raw data” that is taken directly from the provider’s format and has not been converted to a canonical form. | String |
| ogrFid | The OGR feature identifier from which this SourceInfoProto was created. This is an internal OGR record identifier and has nothing to do with any of the feature’s fields or the FeatureIdProto for the FeatureProto containing this SourceInfoProto. This field is present only for debugging purposes and possible use in the match pattern of a FeatureChangeProto designed to fix bad source data very early in the importing process. | GeostoreSourceInfoProto | Source infos are the canonical way to establish data provenance. They can currently be set on features, edits, and issues. Every feature has a repeated list of SourceInfoProto messages to describe the source data that was used in building this feature. The data includes a feature id that points to additional data about the data source (version, copyright notice, etc), and optional “raw data” that is taken directly from the provider’s format and has not been converted to a canonical form. | String |
| provider | The data provider from which this source info was generated. The value must be equal to the one on the TYPE_DATA_SOURCE feature referenced by this source info via the source_id reference (see above). | GeostoreSourceInfoProto | Source infos are the canonical way to establish data provenance. They can currently be set on features, edits, and issues. Every feature has a repeated list of SourceInfoProto messages to describe the source data that was used in building this feature. The data includes a feature id that points to additional data about the data source (version, copyright notice, etc), and optional “raw data” that is taken directly from the provider’s format and has not been converted to a canonical form. | integer |
| rawData | A source info may optionally have a set of key-value pairs that provide “raw data” specific to that source. The types of raw data available will vary from one provider to another and should not be used in production code. Instead, new fields and/or protocol buffers should be defined to represent this information in a canonical form, and the relevant importers should be modified to populate these new fields. | GeostoreSourceInfoProto | Source infos are the canonical way to establish data provenance. They can currently be set on features, edits, and issues. Every feature has a repeated list of SourceInfoProto messages to describe the source data that was used in building this feature. The data includes a feature id that points to additional data about the data source (version, copyright notice, etc), and optional “raw data” that is taken directly from the provider’s format and has not been converted to a canonical form. | list(GeostoreRawDataProto) |
| release | The data release from which this SourceInfoProto was created. The format for this string is provider-dependent (e.g. a MultiNet release would look like “2008.01”). | GeostoreSourceInfoProto | Source infos are the canonical way to establish data provenance. They can currently be set on features, edits, and issues. Every feature has a repeated list of SourceInfoProto messages to describe the source data that was used in building this feature. The data includes a feature id that points to additional data about the data source (version, copyright notice, etc), and optional “raw data” that is taken directly from the provider’s format and has not been converted to a canonical form. | String |
| sourceId | A source info may have a corresponding TYPE_DATA_SOURCE feature that describes it (provider, copyright information, date of release, etc). In the context of edits and issues, this field should not be set. | GeostoreSourceInfoProto | Source infos are the canonical way to establish data provenance. They can currently be set on features, edits, and issues. Every feature has a repeated list of SourceInfoProto messages to describe the source data that was used in building this feature. The data includes a feature id that points to additional data about the data source (version, copyright notice, etc), and optional “raw data” that is taken directly from the provider’s format and has not been converted to a canonical form. | GeostoreFeatureIdProto |
| temporaryData | A place for clients to attach arbitrary data to a source info. Never set in MapFacts. | GeostoreSourceInfoProto | Source infos are the canonical way to establish data provenance. They can currently be set on features, edits, and issues. Every feature has a repeated list of SourceInfoProto messages to describe the source data that was used in building this feature. The data includes a feature id that points to additional data about the data source (version, copyright notice, etc), and optional “raw data” that is taken directly from the provider’s format and has not been converted to a canonical form. | Proto2BridgeMessageSet |
| user | RESERVED | GeostoreSourceInfoProto | Source infos are the canonical way to establish data provenance. They can currently be set on features, edits, and issues. Every feature has a repeated list of SourceInfoProto messages to describe the source data that was used in building this feature. The data includes a feature id that points to additional data about the data source (version, copyright notice, etc), and optional “raw data” that is taken directly from the provider’s format and has not been converted to a canonical form. | GeostoreUserProto |
| level | The level of trust for the source of the observation. | GeostoreSourceTrustProto | Trust related information about the input source (feed or user) to help feature summarization. Typically, the values in this proto are either based on source’s previous observations (e.g., a blocked LBC user or a trusted feed) or their status (Google hired operator or admin user). The proto can later contain a more granular trust score or correctness probabilities. A higher enum value indicates a more trusted source. Leaving room in the value space for adding more granular enums, if they become necessary later. | String |
| category | The type of speed limit. | GeostoreSpeedLimitProto | A speed limit, containing both the limit and the conditions in which it applies. | String |
| condition | The conditions under which this speed limit is applicable. If multiple conditions are set, at least one of them must be true. | GeostoreSpeedLimitProto | A speed limit, containing both the limit and the conditions in which it applies. | list(GeostoreRoadConditionalProto) |
| sourceType | The source of the speed limit. | GeostoreSpeedLimitProto | A speed limit, containing both the limit and the conditions in which it applies. | String |
| speedWithUnit | A constant speed limit. | GeostoreSpeedLimitProto | A speed limit, containing both the limit and the conditions in which it applies. | GeostoreSpeedProto |
| unlimitedSpeed | A speed limit with no limit value. When there is no speed limit in place. | GeostoreSpeedLimitProto | A speed limit, containing both the limit and the conditions in which it applies. | GeostoreUnlimitedSpeedProto |
| variableSpeed | A dynamic speed limit that can vary within a range of values based on road conditions. | GeostoreSpeedLimitProto | A speed limit, containing both the limit and the conditions in which it applies. | GeostoreVariableSpeedProto |
| speed | All speed values are stored in kilometers per hour. | GeostoreSpeedProto | A speed value and unit. | number |
| unit | Mapfacts only allows unit to be KILOMETERS_PER_HOUR. | GeostoreSpeedProto | A speed value and unit. | String |
| fieldPath | A sequence of field selectors to be traversed starting from the root message. | GeostoreStableFieldPathProto | Represents a way to traverse nested fields by referencing their token fields. Everything starts relative to a known root message, specified externally. E.g., suppose we have a feature proto that has a lane with token 0x123 which in turn has a lane connection with token 0x456 for which we want to assert something about flowline altitudes. The field path in that case will look like: field_path: { field_num: 31 # segment } field_path: { field_num: 6 # lane version_token: “0x123” } field_path: { field_num: 8 # lane_connection version_token: “0x456” } field_path: { field_num: 3 # flow } field_path: { field_num: 1 # track } field_path: { # Note: pose is repeated. By not specifying a token we refer to all poses # in a track. field_num: 2 # pose } field_path: { field_num: 4 # altitude } This path could also be represented succinctly in a more human-friendly form as something like: segment.lane[@0x123].lane_connection[@0x456].flow.track.pose[*].altitude | list(GeostoreStableFieldPathProtoStableFieldSelector) |
| fieldNum | Field number to select. | GeostoreStableFieldPathProtoStableFieldSelector | integer | |
| versionToken | Select repeated field entry by its version token. If this is used, then the message referenced by field_num must have a token field annotated with the (version_token) field option. Must be omitted for leaf non-repeated fields. If unset for a repeated field, we consider this selector to apply equally to all descendants. | GeostoreStableFieldPathProtoStableFieldSelector | String | |
| otherSegmentFeatureId | The segment feature connected to this segment via the sweep geometry. | GeostoreSweepProto | This protocol buffer represents the 2D polygon connecting two segments at an intersection. Collectively, sweep polygons represent intersections for real road width rendering. Notes: – Sweeps represent geometry between the *end* of one segment and the *end* of the other segment (modulo retraction values). – Sweeps are strongly referenced, meaning geometry is stored on both segments involved in the sweep. For example, in the diagram below, the sweep between A and B would be stored on both segment A and segment B. | B | v –A–> – Sweeps are not strictly stored on adjacent segments. Disconnected segments (e.g., segments separated by an intersection group) may also contain sweeps. | GeostoreFeatureIdProto |
| polygon | Polygonal geometry representing the area between this segment and the other segment. | GeostoreSweepProto | This protocol buffer represents the 2D polygon connecting two segments at an intersection. Collectively, sweep polygons represent intersections for real road width rendering. Notes: – Sweeps represent geometry between the *end* of one segment and the *end* of the other segment (modulo retraction values). – Sweeps are strongly referenced, meaning geometry is stored on both segments involved in the sweep. For example, in the diagram below, the sweep between A and B would be stored on both segment A and segment B. | B | v –A–> – Sweeps are not strictly stored on adjacent segments. Disconnected segments (e.g., segments separated by an intersection group) may also contain sweeps. | GeostorePolygonProto |
| sweepCurve | Describes parameters for generating the edge of this sweep that starts at edge_follows_segment_end_fraction. The other side of the sweep should be described on the sweep present on the sibling pair. | GeostoreSweepProto | This protocol buffer represents the 2D polygon connecting two segments at an intersection. Collectively, sweep polygons represent intersections for real road width rendering. Notes: – Sweeps represent geometry between the *end* of one segment and the *end* of the other segment (modulo retraction values). – Sweeps are strongly referenced, meaning geometry is stored on both segments involved in the sweep. For example, in the diagram below, the sweep between A and B would be stored on both segment A and segment B. | B | v –A–> – Sweeps are not strictly stored on adjacent segments. Disconnected segments (e.g., segments separated by an intersection group) may also contain sweeps. | GeostoreCurveConnectionProto |
| sweepToken | A token that can be used to identify the version of the data about this sweep. | GeostoreSweepProto | This protocol buffer represents the 2D polygon connecting two segments at an intersection. Collectively, sweep polygons represent intersections for real road width rendering. Notes: – Sweeps represent geometry between the *end* of one segment and the *end* of the other segment (modulo retraction values). – Sweeps are strongly referenced, meaning geometry is stored on both segments involved in the sweep. For example, in the diagram below, the sweep between A and B would be stored on both segment A and segment B. | B | v –A–> – Sweeps are not strictly stored on adjacent segments. Disconnected segments (e.g., segments separated by an intersection group) may also contain sweeps. | String |
| callRate | RESERVED | GeostoreTelephoneProto | This protocol buffer is used to represent telephone numbers and related information. | list(GeostorePriceRangeProto) |
| contactCategory | Disambiguates between the types of information or service a caller might seek when contacting this phone number. | GeostoreTelephoneProto | This protocol buffer is used to represent telephone numbers and related information. | String |
| flag | GeostoreTelephoneProto | This protocol buffer is used to represent telephone numbers and related information. | list(String) | |
| isSharedNumber | True if this phone number is not unique to this establishment and might be shared with other features. In case an establishment shares a phone number with a business chain of which it is a member, and the number canonically belongs to that chain, it should be marked as shared for the establishment but not shared for the chain. | GeostoreTelephoneProto | This protocol buffer is used to represent telephone numbers and related information. | boolean |
| label | RESERVED | GeostoreTelephoneProto | This protocol buffer is used to represent telephone numbers and related information. | list(GeostoreNameProto) |
| language | RESERVED | GeostoreTelephoneProto | This protocol buffer is used to represent telephone numbers and related information. | list(String) |
| metadata | Field-level metadata for this telephone number. | GeostoreTelephoneProto | This protocol buffer is used to represent telephone numbers and related information. | GeostoreFieldMetadataProto |
| number | ** DEPRECATED ** This is deprecated in favor of phone_number below. An internationalized representation of a phone number. See //location/country/telephonenumber.proto | GeostoreTelephoneProto | This protocol buffer is used to represent telephone numbers and related information. | TelephoneNumber |
| phoneNumber | An internationalized representation of a phone number. See //java/com/google/i18n/phonenumbers/phonenumber.proto | GeostoreTelephoneProto | This protocol buffer is used to represent telephone numbers and related information. | I18nPhonenumbersPhoneNumber |
| serviceLocationFeature | The features from which this phone number can be called from. For instance, if a phone number can only be called from Europe, this field will contain a reference to the TYPE_CONTINENT feature of Europe. This field is analogous to http://kg/schema/common/phone_number/service_location. The only valid destination feature types are TYPE_CONTINENT and TYPE_POLITICAL. If empty, this phone number can be called from anywhere in Earth (this is the case for the majority of phones). | GeostoreTelephoneProto | This protocol buffer is used to represent telephone numbers and related information. | list(GeostoreFeatureIdProto) |
| type | GeostoreTelephoneProto | This protocol buffer is used to represent telephone numbers and related information. | String | |
| endAsOfDate | The latest when this closure may end, if the exact date is unknown. If set, the feature is operational again no later than this date. | GeostoreTemporaryClosureProto | This protocol buffer stores information related to temporary closure of a feature. The only allowed precisions for a date is PRECISION_DAY. DateTimeProto.seconds should have the lowest legal value for the desired date/time and precision. E.g. for PRECISION_MONTH, 2019-02-15 21:10:30 is not valid, it should be 2019-02-01 00:00:00 instead. NOTE: Each date is stored in UTC but should be interpreted as being in the local timezone. So clients should convert the DateTimeProto to local (civil) time using UTC+0, and then treat the result as local to the feature. | GeostoreDateTimeProto |
| endDate | RESERVED | GeostoreTemporaryClosureProto | This protocol buffer stores information related to temporary closure of a feature. The only allowed precisions for a date is PRECISION_DAY. DateTimeProto.seconds should have the lowest legal value for the desired date/time and precision. E.g. for PRECISION_MONTH, 2019-02-15 21:10:30 is not valid, it should be 2019-02-01 00:00:00 instead. NOTE: Each date is stored in UTC but should be interpreted as being in the local timezone. So clients should convert the DateTimeProto to local (civil) time using UTC+0, and then treat the result as local to the feature. | GeostoreDateTimeProto |
| startAsOfDate | The latest when this closure may start, if the exact date is unknown. If set, the feature is temporarily closed starting no later than this date. | GeostoreTemporaryClosureProto | This protocol buffer stores information related to temporary closure of a feature. The only allowed precisions for a date is PRECISION_DAY. DateTimeProto.seconds should have the lowest legal value for the desired date/time and precision. E.g. for PRECISION_MONTH, 2019-02-15 21:10:30 is not valid, it should be 2019-02-01 00:00:00 instead. NOTE: Each date is stored in UTC but should be interpreted as being in the local timezone. So clients should convert the DateTimeProto to local (civil) time using UTC+0, and then treat the result as local to the feature. | GeostoreDateTimeProto |
| startDate | RESERVED | GeostoreTemporaryClosureProto | This protocol buffer stores information related to temporary closure of a feature. The only allowed precisions for a date is PRECISION_DAY. DateTimeProto.seconds should have the lowest legal value for the desired date/time and precision. E.g. for PRECISION_MONTH, 2019-02-15 21:10:30 is not valid, it should be 2019-02-01 00:00:00 instead. NOTE: Each date is stored in UTC but should be interpreted as being in the local timezone. So clients should convert the DateTimeProto to local (civil) time using UTC+0, and then treat the result as local to the feature. | GeostoreDateTimeProto |
| language | The external form of a Google International Identifiers Initiative (III) LanguageCode object. See google3/i18n/identifiers/languagecode.h for details. These strings should be treated as opaque blobs. You can use LanguageCodeConverter::FromOther to convert the string to a LanguageCode reference. You can then call methods on the LanguageCode class to extract language/script/region subtags (if any). See also http://g3doc/i18n/identifiers/g3doc/using-iii. We place extra restrictions on languages in addition to what the III library requires. See http://go/geo-schema-reference/feature-properties/languages.md | GeostoreTextAffixProto | Represents text (with an associated language) that is affixed to the beginning and/or end of a primary text. | String |
| prefix | Text to prepend to the primary text, including any necessary trailing whitespace. At least one of prefix or suffix is required. | GeostoreTextAffixProto | Represents text (with an associated language) that is affixed to the beginning and/or end of a primary text. | String |
| suffix | Text to append to the end of the primary text, including any necessary leading whitespace. At least one of prefix or suffix is required. | GeostoreTextAffixProto | Represents text (with an associated language) that is affixed to the beginning and/or end of a primary text. | String |
| pointIndices | Triangle vertex indices, each triple defines a triangle. | GeostoreThreeDimensionalModelProto | list(integer) | |
| points | We store a triangular mesh in indexed format. Points array. | GeostoreThreeDimensionalModelProto | list(GeostorePointWithHeightProto) | |
| durationBasedRate | The rates for this rule. Each duration_based_rate defines the costs associated with a particular duration of a stay. There must be at least one rate with range_start_seconds set to 0 and there cannot be gaps between durations (i.e. there should be no interval uncovered between 0 and the largest range_end_seconds of any duration-based rate). | GeostoreTimeBasedRateProto | A rate which applies based on the precise times of utilization. Defines a rate, as well as restrictions on the start and end times which must be satisfied in order to be eligible for the rate. See go/rate-schema for more details. | list(GeostoreDurationBasedRateProto) |
| taxIncluded | If true, tax is included in the prices in this rate. If false, additional taxes may apply. | GeostoreTimeBasedRateProto | A rate which applies based on the precise times of utilization. Defines a rate, as well as restrictions on the start and end times which must be satisfied in order to be eligible for the rate. See go/rate-schema for more details. | boolean |
| validEndWithin | GeostoreTimeBasedRateProto | A rate which applies based on the precise times of utilization. Defines a rate, as well as restrictions on the start and end times which must be satisfied in order to be eligible for the rate. See go/rate-schema for more details. | GeostoreTimeScheduleProto | |
| validStartWithin | Time period during which utilization of this rate must start in order to be eligible for the rate. If not set, there is no restriction on the time when the utilization starts. | GeostoreTimeBasedRateProto | A rate which applies based on the precise times of utilization. Defines a rate, as well as restrictions on the start and end times which must be satisfied in order to be eligible for the rate. See go/rate-schema for more details. | GeostoreTimeScheduleProto |
| componentType | GeostoreTimeComponentProto | String | ||
| interval | The time component is the intersection of these intervals | GeostoreTimeComponentProto | list(GeostoreTimeIntervalProto) | |
| day | Valid ranges are 0-7, 1-31, and 1-366 (see day_type below) | GeostoreTimeEndpointProto | Not all combinations of optional fields in TimeEndpointProto are allowed. The granularity of time is a path along the directed graph with these edges: second -> minute minute -> hour hour -> day of week hour -> day of month hour -> day of year day of week -> week of month day of week -> week of year day of month -> month day of year -> year week of month -> month week of year -> year month -> year A TimeEndpointProto may not specify two fields that are unordered with respect to each other (“day of year” and “day of week”, for instance). The absence of fields larger than any specified field indicates repetition (e.g. no year indicates that the interval occurs every year). The absence of units that are “smaller” than the largest specified unit indicates a default lowest value (no hour means midnight (0)). When intersecting time intervals, “smaller” units repeat within the “larger” unit as many times as necessary. For example, the intersection of the interval from hour 0 to hour 24 with the interval from second 0 to second 1 is equivalent to the union of the set of intervals which represents the first second of every minute of every hour of every day. —————————————————————————– WARNING – if you add new fields to TimeEndpointProto you need to: – ensure AreTimeEndpointsEquivalent considers the new fields (and update the corresponding tests) —————————————————————————– | integer |
| dayType | GeostoreTimeEndpointProto | Not all combinations of optional fields in TimeEndpointProto are allowed. The granularity of time is a path along the directed graph with these edges: second -> minute minute -> hour hour -> day of week hour -> day of month hour -> day of year day of week -> week of month day of week -> week of year day of month -> month day of year -> year week of month -> month week of year -> year month -> year A TimeEndpointProto may not specify two fields that are unordered with respect to each other (“day of year” and “day of week”, for instance). The absence of fields larger than any specified field indicates repetition (e.g. no year indicates that the interval occurs every year). The absence of units that are “smaller” than the largest specified unit indicates a default lowest value (no hour means midnight (0)). When intersecting time intervals, “smaller” units repeat within the “larger” unit as many times as necessary. For example, the intersection of the interval from hour 0 to hour 24 with the interval from second 0 to second 1 is equivalent to the union of the set of intervals which represents the first second of every minute of every hour of every day. —————————————————————————– WARNING – if you add new fields to TimeEndpointProto you need to: – ensure AreTimeEndpointsEquivalent considers the new fields (and update the corresponding tests) —————————————————————————– | String | |
| hour | Valid range is 0-24. Because it could be unclear what wrapping hours mean in relation to days, 24 is used to denote midnight at the end of a day. | GeostoreTimeEndpointProto | Not all combinations of optional fields in TimeEndpointProto are allowed. The granularity of time is a path along the directed graph with these edges: second -> minute minute -> hour hour -> day of week hour -> day of month hour -> day of year day of week -> week of month day of week -> week of year day of month -> month day of year -> year week of month -> month week of year -> year month -> year A TimeEndpointProto may not specify two fields that are unordered with respect to each other (“day of year” and “day of week”, for instance). The absence of fields larger than any specified field indicates repetition (e.g. no year indicates that the interval occurs every year). The absence of units that are “smaller” than the largest specified unit indicates a default lowest value (no hour means midnight (0)). When intersecting time intervals, “smaller” units repeat within the “larger” unit as many times as necessary. For example, the intersection of the interval from hour 0 to hour 24 with the interval from second 0 to second 1 is equivalent to the union of the set of intervals which represents the first second of every minute of every hour of every day. —————————————————————————– WARNING – if you add new fields to TimeEndpointProto you need to: – ensure AreTimeEndpointsEquivalent considers the new fields (and update the corresponding tests) —————————————————————————– | integer |
| minute | Valid range is 0-59, except when a repetitive minute interval ends at the end of an hour, in which case 60 is a legal end value. | GeostoreTimeEndpointProto | Not all combinations of optional fields in TimeEndpointProto are allowed. The granularity of time is a path along the directed graph with these edges: second -> minute minute -> hour hour -> day of week hour -> day of month hour -> day of year day of week -> week of month day of week -> week of year day of month -> month day of year -> year week of month -> month week of year -> year month -> year A TimeEndpointProto may not specify two fields that are unordered with respect to each other (“day of year” and “day of week”, for instance). The absence of fields larger than any specified field indicates repetition (e.g. no year indicates that the interval occurs every year). The absence of units that are “smaller” than the largest specified unit indicates a default lowest value (no hour means midnight (0)). When intersecting time intervals, “smaller” units repeat within the “larger” unit as many times as necessary. For example, the intersection of the interval from hour 0 to hour 24 with the interval from second 0 to second 1 is equivalent to the union of the set of intervals which represents the first second of every minute of every hour of every day. —————————————————————————– WARNING – if you add new fields to TimeEndpointProto you need to: – ensure AreTimeEndpointsEquivalent considers the new fields (and update the corresponding tests) —————————————————————————– | integer |
| month | GeostoreTimeEndpointProto | Not all combinations of optional fields in TimeEndpointProto are allowed. The granularity of time is a path along the directed graph with these edges: second -> minute minute -> hour hour -> day of week hour -> day of month hour -> day of year day of week -> week of month day of week -> week of year day of month -> month day of year -> year week of month -> month week of year -> year month -> year A TimeEndpointProto may not specify two fields that are unordered with respect to each other (“day of year” and “day of week”, for instance). The absence of fields larger than any specified field indicates repetition (e.g. no year indicates that the interval occurs every year). The absence of units that are “smaller” than the largest specified unit indicates a default lowest value (no hour means midnight (0)). When intersecting time intervals, “smaller” units repeat within the “larger” unit as many times as necessary. For example, the intersection of the interval from hour 0 to hour 24 with the interval from second 0 to second 1 is equivalent to the union of the set of intervals which represents the first second of every minute of every hour of every day. —————————————————————————– WARNING – if you add new fields to TimeEndpointProto you need to: – ensure AreTimeEndpointsEquivalent considers the new fields (and update the corresponding tests) —————————————————————————– | String | |
| second | Valid range is 0-59, except when a repetitive second interval ends at the end of a minute, in which case 60 is a legal end value. | GeostoreTimeEndpointProto | Not all combinations of optional fields in TimeEndpointProto are allowed. The granularity of time is a path along the directed graph with these edges: second -> minute minute -> hour hour -> day of week hour -> day of month hour -> day of year day of week -> week of month day of week -> week of year day of month -> month day of year -> year week of month -> month week of year -> year month -> year A TimeEndpointProto may not specify two fields that are unordered with respect to each other (“day of year” and “day of week”, for instance). The absence of fields larger than any specified field indicates repetition (e.g. no year indicates that the interval occurs every year). The absence of units that are “smaller” than the largest specified unit indicates a default lowest value (no hour means midnight (0)). When intersecting time intervals, “smaller” units repeat within the “larger” unit as many times as necessary. For example, the intersection of the interval from hour 0 to hour 24 with the interval from second 0 to second 1 is equivalent to the union of the set of intervals which represents the first second of every minute of every hour of every day. —————————————————————————– WARNING – if you add new fields to TimeEndpointProto you need to: – ensure AreTimeEndpointsEquivalent considers the new fields (and update the corresponding tests) —————————————————————————– | integer |
| week | Valid ranges are 0-5 and 1-53 (depending on the value of week_type, see below). | GeostoreTimeEndpointProto | Not all combinations of optional fields in TimeEndpointProto are allowed. The granularity of time is a path along the directed graph with these edges: second -> minute minute -> hour hour -> day of week hour -> day of month hour -> day of year day of week -> week of month day of week -> week of year day of month -> month day of year -> year week of month -> month week of year -> year month -> year A TimeEndpointProto may not specify two fields that are unordered with respect to each other (“day of year” and “day of week”, for instance). The absence of fields larger than any specified field indicates repetition (e.g. no year indicates that the interval occurs every year). The absence of units that are “smaller” than the largest specified unit indicates a default lowest value (no hour means midnight (0)). When intersecting time intervals, “smaller” units repeat within the “larger” unit as many times as necessary. For example, the intersection of the interval from hour 0 to hour 24 with the interval from second 0 to second 1 is equivalent to the union of the set of intervals which represents the first second of every minute of every hour of every day. —————————————————————————– WARNING – if you add new fields to TimeEndpointProto you need to: – ensure AreTimeEndpointsEquivalent considers the new fields (and update the corresponding tests) —————————————————————————– | integer |
| weekType | GeostoreTimeEndpointProto | Not all combinations of optional fields in TimeEndpointProto are allowed. The granularity of time is a path along the directed graph with these edges: second -> minute minute -> hour hour -> day of week hour -> day of month hour -> day of year day of week -> week of month day of week -> week of year day of month -> month day of year -> year week of month -> month week of year -> year month -> year A TimeEndpointProto may not specify two fields that are unordered with respect to each other (“day of year” and “day of week”, for instance). The absence of fields larger than any specified field indicates repetition (e.g. no year indicates that the interval occurs every year). The absence of units that are “smaller” than the largest specified unit indicates a default lowest value (no hour means midnight (0)). When intersecting time intervals, “smaller” units repeat within the “larger” unit as many times as necessary. For example, the intersection of the interval from hour 0 to hour 24 with the interval from second 0 to second 1 is equivalent to the union of the set of intervals which represents the first second of every minute of every hour of every day. —————————————————————————– WARNING – if you add new fields to TimeEndpointProto you need to: – ensure AreTimeEndpointsEquivalent considers the new fields (and update the corresponding tests) —————————————————————————– | String | |
| year | GeostoreTimeEndpointProto | Not all combinations of optional fields in TimeEndpointProto are allowed. The granularity of time is a path along the directed graph with these edges: second -> minute minute -> hour hour -> day of week hour -> day of month hour -> day of year day of week -> week of month day of week -> week of year day of month -> month day of year -> year week of month -> month week of year -> year month -> year A TimeEndpointProto may not specify two fields that are unordered with respect to each other (“day of year” and “day of week”, for instance). The absence of fields larger than any specified field indicates repetition (e.g. no year indicates that the interval occurs every year). The absence of units that are “smaller” than the largest specified unit indicates a default lowest value (no hour means midnight (0)). When intersecting time intervals, “smaller” units repeat within the “larger” unit as many times as necessary. For example, the intersection of the interval from hour 0 to hour 24 with the interval from second 0 to second 1 is equivalent to the union of the set of intervals which represents the first second of every minute of every hour of every day. —————————————————————————– WARNING – if you add new fields to TimeEndpointProto you need to: – ensure AreTimeEndpointsEquivalent considers the new fields (and update the corresponding tests) —————————————————————————– | integer | |
| begin | Begin and end are used to specify a range of times: [begin, end). If one is present, the other must be present as well. Additionally, both must have matching time granularities – all fields specified in the begin TimeEndpointProto must be present in the end TimeEndpointProto and vice-versa. Hours are not allowed to wrap (begin.hour() <= end.hour()). | GeostoreTimeIntervalProto | GeostoreTimeEndpointProto | |
| end | GeostoreTimeIntervalProto | GeostoreTimeEndpointProto | ||
| inverted | If true, then this interval actually encodes the complement of the specified occasion or range. For example, the following TimeIntervalProto encodes all times other than the month of May. TimeIntervalProto[ type = TYPE_RANGE inverted = true begin = TimeEndpointProto[ month = MAY ] end = TimeEndpointProto[ month = JUNE ] ] | GeostoreTimeIntervalProto | boolean | |
| occasion | clang-format on | GeostoreTimeIntervalProto | String | |
| type | GeostoreTimeIntervalProto | String | ||
| component | The schedule is the union of these components. | GeostoreTimeScheduleProto | list(GeostoreTimeComponentProto) | |
| id | i18n recognized time zone identifier. For the full list of identifiers, see google3/i18n/identifiers/data/timezones.txt. | GeostoreTimezoneProto | A TimezoneProto holds information about a feature’s related time zone. | String |
| metadata | Field-level metadata for this relation. | GeostoreTimezoneProto | A TimezoneProto holds information about a feature’s related time zone. | GeostoreFieldMetadataProto |
| intersection | The list of gcid:toll_intersection features that this toll cluster. A toll cluster can consist of either a single or a group of intersection points called toll intersections at the end of various road segments in MapFacts that represent one or more lanes passing through a toll fixture that all go to the same routing destination. This relationship is reciprocal, as a toll intersection also stores a reference to the toll cluster it belongs to. A toll cluster must have a reference to one or more toll interections (i.e. toll_cluster.intersection should always be populated). | GeostoreTollClusterProto | A collection of information that applies to a toll cluster. | list(GeostoreFeatureIdProto) |
| tollClusterSequence | Details the /geo/type/toll_cluster features which constitute this toll path. | GeostoreTollPathProto | A TollPathProto describes the sequential travel across one or more /geo/type/toll_cluster features. Traveling across a toll path may entail paying a fee, buying a toll pass, etc (although we don’t model this in FeatureProto). To travel across a toll path, one must travel between toll clusters in the exact order specified. See go/geo-schema:toll-paths for more information. | GeostoreTollPathProtoTollClusterSequence |
| cluster | The /geo/type/toll_cluster feature at this position. | GeostoreTollPathProtoIndexedTollCluster | A /geo/type/toll_cluster and its position along a toll path. | GeostoreFeatureIdProto |
| index | The position along the path where this cluster appears. | GeostoreTollPathProtoIndexedTollCluster | A /geo/type/toll_cluster and its position along a toll path. | integer |
| indexedTollClusters | There must be at least one toll cluster in a toll path, and there may not be duplicates. For ordering, one should rely on `IndexedTollClusterProto.index`, rather than the repeated field ordering (elements may be shuffled). This is a unidirectional reference – toll clusters do not reference the toll paths they’re a part of. The toll clusters themselves may be part of multiple toll paths. | GeostoreTollPathProtoTollClusterSequence | The set of toll clusters in a toll path, along with their position in the path. | list(GeostoreTollPathProtoIndexedTollCluster) |
| index | The index of this TrackProto in a list of TrackProtos. | GeostoreTrackProto | integer | |
| pose | The instantaneous pose of points along this track. The fields set inside each pose must be set consistently along the track. | GeostoreTrackProto | list(GeostorePoseProto) | |
| agency | The transit agencies responsible for operating this line. All lines should have at least one agency, and most will have exactly one. The following cases are reasons for multiple agencies: – Code share: Two or more agencies share trips – Alternations: Each trip is run by one of multiple agencies – Additional: All trips run by one agency, but a second one sells tickets In all cases the order has no meaning. Clarification comes from the trips. | GeostoreTransitLineProto | A transit line is a named set of transit trips that are advertised to passengers under a common name, and a number of attributes that are true for all those trips. There is no requirement for each trip to travel through the same list of stops or use the same legs, so a line can contain trips in opposite directions or with variations in the sequence of stops. See go/oysterpedia for an overview of the transit feature types. The standard feature properties are interpreted as follows: name – The names of this line, including both long and short names, if available. Short names like “10” or “Blue” should carry the FLAG_ABBREVIATED, long names like “Dublin/Pleasanton line” should not. The preferred name (one per language) for displaying the line on its own (e.g., as a search result for the line) should carry the FLAG_PREFERRED. website – The official web page describing this line. Repeated if multilingual. Line features have no geometry (neither points nor polylines nor polygons). Within Transit Oyster, geometry can be found in legs. Additional data only in Transit Oyster: child – The legs of this line, in no particular order. source_info – Specifies the GTFS routes that match this feature. Each is given as a PROVIDER_GOOGLE_TRANSIT source_info where dataset is the feed name and cookie is the route_id. | list(GeostoreFeatureIdProto) |
| labelBackgroundColor | The background color of labels for that transit line. The encoding is like in HTML or CSS, eg. 0x11ff00 means a bit of red, full green, no blue, in sRGB color space. The most significant byte must be zero, i.e. no transparency. | GeostoreTransitLineProto | A transit line is a named set of transit trips that are advertised to passengers under a common name, and a number of attributes that are true for all those trips. There is no requirement for each trip to travel through the same list of stops or use the same legs, so a line can contain trips in opposite directions or with variations in the sequence of stops. See go/oysterpedia for an overview of the transit feature types. The standard feature properties are interpreted as follows: name – The names of this line, including both long and short names, if available. Short names like “10” or “Blue” should carry the FLAG_ABBREVIATED, long names like “Dublin/Pleasanton line” should not. The preferred name (one per language) for displaying the line on its own (e.g., as a search result for the line) should carry the FLAG_PREFERRED. website – The official web page describing this line. Repeated if multilingual. Line features have no geometry (neither points nor polylines nor polygons). Within Transit Oyster, geometry can be found in legs. Additional data only in Transit Oyster: child – The legs of this line, in no particular order. source_info – Specifies the GTFS routes that match this feature. Each is given as a PROVIDER_GOOGLE_TRANSIT source_info where dataset is the feed name and cookie is the route_id. | integer |
| labelTextColor | The text color of labels for that transit line. Encoding like label_background_color. | GeostoreTransitLineProto | A transit line is a named set of transit trips that are advertised to passengers under a common name, and a number of attributes that are true for all those trips. There is no requirement for each trip to travel through the same list of stops or use the same legs, so a line can contain trips in opposite directions or with variations in the sequence of stops. See go/oysterpedia for an overview of the transit feature types. The standard feature properties are interpreted as follows: name – The names of this line, including both long and short names, if available. Short names like “10” or “Blue” should carry the FLAG_ABBREVIATED, long names like “Dublin/Pleasanton line” should not. The preferred name (one per language) for displaying the line on its own (e.g., as a search result for the line) should carry the FLAG_PREFERRED. website – The official web page describing this line. Repeated if multilingual. Line features have no geometry (neither points nor polylines nor polygons). Within Transit Oyster, geometry can be found in legs. Additional data only in Transit Oyster: child – The legs of this line, in no particular order. source_info – Specifies the GTFS routes that match this feature. Each is given as a PROVIDER_GOOGLE_TRANSIT source_info where dataset is the feed name and cookie is the route_id. | integer |
| stations | The transit stations (establishment POIs with gcid:transit_station) which this transit line can go through, in no particular order. Usage note: The source of truth are the transit leg features in Transit Oyster. In MapFacts, that information is cached in two locations: in this field, and in transit station attachments on POIs. Do not assume these locations are always up to date and/or synchronized with each other. | GeostoreTransitLineProto | A transit line is a named set of transit trips that are advertised to passengers under a common name, and a number of attributes that are true for all those trips. There is no requirement for each trip to travel through the same list of stops or use the same legs, so a line can contain trips in opposite directions or with variations in the sequence of stops. See go/oysterpedia for an overview of the transit feature types. The standard feature properties are interpreted as follows: name – The names of this line, including both long and short names, if available. Short names like “10” or “Blue” should carry the FLAG_ABBREVIATED, long names like “Dublin/Pleasanton line” should not. The preferred name (one per language) for displaying the line on its own (e.g., as a search result for the line) should carry the FLAG_PREFERRED. website – The official web page describing this line. Repeated if multilingual. Line features have no geometry (neither points nor polylines nor polygons). Within Transit Oyster, geometry can be found in legs. Additional data only in Transit Oyster: child – The legs of this line, in no particular order. source_info – Specifies the GTFS routes that match this feature. Each is given as a PROVIDER_GOOGLE_TRANSIT source_info where dataset is the feed name and cookie is the route_id. | list(GeostoreFeatureIdProto) |
| vehicleType | The type of vehicle that applies to all trips that use this line. | GeostoreTransitLineProto | A transit line is a named set of transit trips that are advertised to passengers under a common name, and a number of attributes that are true for all those trips. There is no requirement for each trip to travel through the same list of stops or use the same legs, so a line can contain trips in opposite directions or with variations in the sequence of stops. See go/oysterpedia for an overview of the transit feature types. The standard feature properties are interpreted as follows: name – The names of this line, including both long and short names, if available. Short names like “10” or “Blue” should carry the FLAG_ABBREVIATED, long names like “Dublin/Pleasanton line” should not. The preferred name (one per language) for displaying the line on its own (e.g., as a search result for the line) should carry the FLAG_PREFERRED. website – The official web page describing this line. Repeated if multilingual. Line features have no geometry (neither points nor polylines nor polygons). Within Transit Oyster, geometry can be found in legs. Additional data only in Transit Oyster: child – The legs of this line, in no particular order. source_info – Specifies the GTFS routes that match this feature. Each is given as a PROVIDER_GOOGLE_TRANSIT source_info where dataset is the feed name and cookie is the route_id. | String |
| lineConcept | Reference to the line variant’s line concept. | GeostoreTransitLineVariantProto | A line variant is a specific instantiation of a line concept, denoted by the ordered set of stops and collection of segments that it traverses. Line variants are modeled as TYPE_ROUTE features with gcid:transit_line_variant. This proto stores line-variant-specific information that is not generally applicable to all routes. Schema Design Doc: go/transit-line-concepts-and-variants | GeostoreFeatureIdProto |
| stops | Ordered list of stations or platforms serviced by this line variant. The order is captured by the ServicedStopProto.index field. | GeostoreTransitLineVariantProto | A line variant is a specific instantiation of a line concept, denoted by the ordered set of stops and collection of segments that it traverses. Line variants are modeled as TYPE_ROUTE features with gcid:transit_line_variant. This proto stores line-variant-specific information that is not generally applicable to all routes. Schema Design Doc: go/transit-line-concepts-and-variants | list(GeostoreServicedStopProto) |
| agencyAssociations | All the transit agencies which service this station. A station can be serviced by multiple stations. There may only be one agency association per transit agency. See go/transit-agency-relation-migration for more details. | GeostoreTransitStationProto | Encapsulates information related to an individual transit station. | list(GeostoreTransitStationProtoTransitAgencyAssociationProto) |
| agency | The transit agency which services this station. | GeostoreTransitStationProtoTransitAgencyAssociationProto | The association between this station and the agency which services this station. | GeostoreFeatureIdProto |
| stationCode | A station code uniquely identifies a transit station within the transit agency’s network. | GeostoreTransitStationProtoTransitAgencyAssociationProto | The association between this station and the agency which services this station. | String |
| sourceTrust | Trust signals for the source of a given observation, typically based on historical evidences or status (like internal Google operator). | GeostoreTrustSignalsProto | GeostoreSourceTrustProto | |
| url | GeostoreUrlListProto | Hold a list of URLs, usually to contain translations of a single URL. | list(GeostoreUrlProto) | |
| language | The external form of a Google International Identifiers Initiative (III) LanguageCode object. See google3/i18n/identifiers/languagecode.h for details. We place extra restrictions on languages in addition to what the III library requires. See http://go/geo-schema-reference/feature-properties/languages.md This field represents the language of the content of the web site. It may be missing if the web site is language-independent or if the language is unknown. | GeostoreUrlProto | A web location for a Feature. URLs should always be stored in repeated fields because some objects (eg. transit schedules in Brussels) have different URLs for different languages. | String |
| metadata | Field-level metadata for this URL. NOTE: there are multiple UrlProto fields in the Geo Schema. Metadata here is only expected to be present on FeatureProto.website[]. | GeostoreUrlProto | A web location for a Feature. URLs should always be stored in repeated fields because some objects (eg. transit schedules in Brussels) have different URLs for different languages. | GeostoreFieldMetadataProto |
| pagerank | ** DEPRECATED ** The pagerank of this URL. Valid values [0, 65535] See http://wiki/Main/NearestSeeds for more information. | GeostoreUrlProto | A web location for a Feature. URLs should always be stored in repeated fields because some objects (eg. transit schedules in Brussels) have different URLs for different languages. | integer |
| url | The URL. | GeostoreUrlProto | A web location for a Feature. URLs should always be stored in repeated fields because some objects (eg. transit schedules in Brussels) have different URLs for different languages. | String |
| encryptedGaiaId | The user Gaia ID in encrypted form. Wipeout ids take value of “” in bytes. | GeostoreUserProto | UserProto identifies a (human) user of Geo Data. Its primary use is in describing the source of pieces of data (e.g. edits). It could be a simple identifier, but isn’t so that we can store it in the clear while still preventing correlation between a user’s contribution. | String |
| encryptionKeyName | Required. The name of the key used to encrypt the Gaia ID. | GeostoreUserProto | UserProto identifies a (human) user of Geo Data. Its primary use is in describing the source of pieces of data (e.g. edits). It could be a simple identifier, but isn’t so that we can store it in the clear while still preventing correlation between a user’s contribution. | String |
| keystoreConfigId | Required (valid default provided). The config ID of the owner of the above encryption_key_name. This field must be set if the encryption key name is *not* “mapfacts_gaia_id_encryption_key”. | GeostoreUserProto | UserProto identifies a (human) user of Geo Data. Its primary use is in describing the source of pieces of data (e.g. edits). It could be a simple identifier, but isn’t so that we can store it in the clear while still preventing correlation between a user’s contribution. | integer |
| username | If possible, writers should set this to a full user email, including the domain. Readers should not assume that this is a well-formed email address. This field may only be set by Atlas, Pushpin and OneRing because they are internal tools which have a PWG exception to store textual usernames in the clear. | GeostoreUserProto | UserProto identifies a (human) user of Geo Data. Its primary use is in describing the source of pieces of data (e.g. edits). It could be a simple identifier, but isn’t so that we can store it in the clear while still preventing correlation between a user’s contribution. | String |
| axleCount | A repeated value here is treated as an AND operation. This allows for ranges to be represented by two values (ex: “count < 4" AND "count >= 2″ means “2 <= count < 4"). | GeostoreVehicleAttributeFilterProto | A set of vehicle attribute conditionals (ex: weight >= 20T && num_trailers = 2) used to define a slice of all possible vehicles. This can be useful for filtering one or more vehicles by a predicate. | list(GeostoreCountComparisonProto) |
| hasTrailer | Whether the applied vehicle types have a trailer attached to them. | GeostoreVehicleAttributeFilterProto | A set of vehicle attribute conditionals (ex: weight >= 20T && num_trailers = 2) used to define a slice of all possible vehicles. This can be useful for filtering one or more vehicles by a predicate. | boolean |
| hazardousGoods | List of prohibited hazardous goods for a vehicle to carry. A repeated value here is treated as an OR operation, meaning that they may not carry ANY of the goods listed. | GeostoreVehicleAttributeFilterProto | A set of vehicle attribute conditionals (ex: weight >= 20T && num_trailers = 2) used to define a slice of all possible vehicles. This can be useful for filtering one or more vehicles by a predicate. | list(String) |
| numTrailers | A repeated value here is treated as an AND operation. This allows for ranges to be represented by two values (ex: “count <= 4" AND "count > 2″ means “2 < count <= 4"). | GeostoreVehicleAttributeFilterProto | A set of vehicle attribute conditionals (ex: weight >= 20T && num_trailers = 2) used to define a slice of all possible vehicles. This can be useful for filtering one or more vehicles by a predicate. | list(GeostoreCountComparisonProto) |
| trailerLength | A repeated value here is treated as an AND operation. This allows for ranges to be represented by two values (ex: “length <= 53ft" AND "length > 48ft” means “48ft < length <= 53ft"). | GeostoreVehicleAttributeFilterProto | A set of vehicle attribute conditionals (ex: weight >= 20T && num_trailers = 2) used to define a slice of all possible vehicles. This can be useful for filtering one or more vehicles by a predicate. | list(GeostoreDimensionComparisonProto) |
| vehicleHeight | A repeated value here is treated as an AND operation. This allows for ranges to be represented by two values (ex: “height > 3m” AND “height <= 5m" means "3m < height <= 5m"). | GeostoreVehicleAttributeFilterProto | A set of vehicle attribute conditionals (ex: weight >= 20T && num_trailers = 2) used to define a slice of all possible vehicles. This can be useful for filtering one or more vehicles by a predicate. | list(GeostoreDimensionComparisonProto) |
| vehicleLength | A repeated value here is treated as an AND operation. This allows for ranges to be represented by two values (ex: “length <= 40m" AND "length > 35m” means “35m < length <= 40m"). | GeostoreVehicleAttributeFilterProto | A set of vehicle attribute conditionals (ex: weight >= 20T && num_trailers = 2) used to define a slice of all possible vehicles. This can be useful for filtering one or more vehicles by a predicate. | list(GeostoreDimensionComparisonProto) |
| vehicleWeight | A repeated value here is treated as an AND operation. This allows for ranges to be represented by two values (ex: “weight < 8T" AND "weight >= 3T” means “3T <= weight < 8T"). | GeostoreVehicleAttributeFilterProto | A set of vehicle attribute conditionals (ex: weight >= 20T && num_trailers = 2) used to define a slice of all possible vehicles. This can be useful for filtering one or more vehicles by a predicate. | list(GeostoreWeightComparisonProto) |
| vehicleWidth | A repeated value here is treated as an AND operation. This allows for ranges to be represented by two values (ex: “width < 4m" AND "width >= 2m” means “2m <= width < 4m"). | GeostoreVehicleAttributeFilterProto | A set of vehicle attribute conditionals (ex: weight >= 20T && num_trailers = 2) used to define a slice of all possible vehicles. This can be useful for filtering one or more vehicles by a predicate. | list(GeostoreDimensionComparisonProto) |
| level | The level represents the relative vertical ordering of a feature among all overlapping features. For example, we may have features along freeway surface have level = 0, and features on an overpass have level = 1. NOTE: It’s assumed that all features have level 0 by default, so that it’s not necessary for all overlapping features to have this set. | GeostoreVerticalOrderingProto | A proto representing a vertical ordering of a feature. NOTE: This shouldn’t be used if a more specific field can be used instead. E.g., for TYPE_SEGMENT features grade_level field should be preferred. For indoor features RELATION_ON_LEVEL should be preferred. See go/aboutgrades for comparison of various types of levels available. | number |
| comparison | GeostoreWeightComparisonProto | A weight value tagged with a comparison operator. | String | |
| comparisonOperator | GeostoreWeightComparisonProto | A weight value tagged with a comparison operator. | String | |
| weightWithUnit | GeostoreWeightComparisonProto | A weight value tagged with a comparison operator. | GeostoreWeightProto | |
| unit | GeostoreWeightProto | A weight with a numerical value and unit. | String | |
| weight | GeostoreWeightProto | A weight with a numerical value and unit. | number | |
| Anchor | There is a generic method for composing such strings. Please take a look at GoodocUtils::GenerateUniqueAnchorName(…) in ocr/goodoc/goodoc-utils.h. | GoodocAnchorLabel | An anchor label can be attached to any element to give it a reference address. LogicalEntity links (see goodoc-semantics.proto) may use anchor labels to point to goodoc elements (they may also use indices to locate the element, but the indices could become invalid if the goodocs are allowed to mutate). Multiple elements may have the same anchor. | String |
| anchorScope | GoodocAnchorLabel | An anchor label can be attached to any element to give it a reference address. LogicalEntity links (see goodoc-semantics.proto) may use anchor labels to point to goodoc elements (they may also use indices to locate the element, but the indices could become invalid if the goodocs are allowed to mutate). Multiple elements may have the same anchor. | integer | |
| Height | GoodocBoundingBox | Bounding box for page structural elements: pictures, paragraphs, characters, etc. | integer | |
| Label | Optional magic label, so objects can be sorted on bounding box dimensions easily | GoodocBoundingBox | Bounding box for page structural elements: pictures, paragraphs, characters, etc. | integer |
| Left | BoundingBox coordinates and sizes are expressed in pixels | GoodocBoundingBox | Bounding box for page structural elements: pictures, paragraphs, characters, etc. | integer |
| Top | GoodocBoundingBox | Bounding box for page structural elements: pictures, paragraphs, characters, etc. | integer | |
| Width | GoodocBoundingBox | Bounding box for page structural elements: pictures, paragraphs, characters, etc. | integer | |
| direction | GoodocBoxPartitions | A way to specify a simple partitioning of a BoundingBox into a sequence of sub-boxes. +—————————————————-+ | | | | | | | span(0) | (1) | (2) | (3) | (4) | | | | | | | +—————————————————-+ This representation can, for example, be used to store coarse Symbol boundaries within a Word (see Word.CompactSymbolBoxes below) instead of per-Symbol BoundingBoxes, for saving space. | integer | |
| span | “span” is width or height, determined by “direction”. If there are k partitions, then there are k – 1 “span” values, one for each except the last symbol (which is redundant). | GoodocBoxPartitions | A way to specify a simple partitioning of a BoundingBox into a sequence of sub-boxes. +—————————————————-+ | | | | | | | span(0) | (1) | (2) | (3) | (4) | | | | | | | +—————————————————-+ This representation can, for example, be used to store coarse Symbol boundaries within a Word (see Word.CompactSymbolBoxes below) instead of per-Symbol BoundingBoxes, for saving space. | list(integer) |
| BreakLabelType | GoodocBreakLabel | Break label | integer | |
| isPrefix | True if break prepends the element | GoodocBreakLabel | Break label | boolean |
| BaseLine | The shift of a character from the base line of the string in pixels | GoodocCharLabel | Font label | integer |
| CharacterHeight | Height of small characters in pixels on the source image | GoodocCharLabel | Font label | integer |
| Color | The foreground color of the symbol; the default color is 0 (black) | GoodocCharLabel | Font label | integer |
| Confidence | Symbol recognition confidence from OCR. Range depends upon OCR Engine. | GoodocCharLabel | Font label | integer |
| FontId | The font ID refers to the fonts table in the document header | GoodocCharLabel | Font label | integer |
| FontSize | Size in points (JFYI: point is 1/72″). This is rounded to the nearest whole number. | GoodocCharLabel | Font label | integer |
| FontSizeFloat | Size in points represented as float. | GoodocCharLabel | Font label | number |
| FontType | GoodocCharLabel | Font label | integer | |
| HasUncertainHeight | If CharacterHeight is defined uncertainly | GoodocCharLabel | Font label | boolean |
| HorizontalScale | The horizontal scaling for a character, in percents. The default value for this property is 100, which corresponds to no scaling. | GoodocCharLabel | Font label | integer |
| IsBold | GoodocCharLabel | Font label | boolean | |
| IsItalic | GoodocCharLabel | Font label | boolean | |
| IsSmallCaps | GoodocCharLabel | Font label | boolean | |
| IsStrikeout | GoodocCharLabel | Font label | boolean | |
| IsSubscript | GoodocCharLabel | Font label | boolean | |
| IsSuperscript | GoodocCharLabel | Font label | boolean | |
| IsSuspicious | If OCR Engine marked the character as “suspicious” (this character is likely to be recognized incorrectly). | GoodocCharLabel | Font label | boolean |
| IsUnderlined | GoodocCharLabel | Font label | boolean | |
| NotOcrablePerQA | True if a QA operator has marked this as not OCRable. This is used for complex equations, scripts that the operator can’t type, or handwriting. | GoodocCharLabel | Font label | boolean |
| Penalty | Symbol-level penalty from the garbage text detector. Lower is better; range = [0,100]. | GoodocCharLabel | Font label | integer |
| SerifProbability | The probability that a character is written with a Serif font | GoodocCharLabel | Font label | integer |
| EditingHistory | Debug info, recording the history of any editing done through the interface in goodoc-editing.h. The strings look like “MoveParagraph(page_index = 0, source_block_index = 3, …); | GoodocDocument | Top-level representation of OCRed document | list(String) |
| LogicalEntity | Logical entities are stored as blobs. Depending on the kind of thing this is a goodoc of, a separate .proto file is expected to define the logical entity structure. Hence we can still parse this as a goodoc for people who dont care about this, and people who care about this can parse it specifically. ocr/goodoc/logical-entity-utils.h has methods to read and write these. See Goodoc++ doc | GoodocDocument | Top-level representation of OCRed document | list(String) |
| LogicalEntityMessageName | The names of the proto messages serialized in LogicalEntity, one for each LogicalEntity. The repetitions should number 0 to leave this unspecified, or they should equal the number of LogicalEntity strings. | GoodocDocument | Top-level representation of OCRed document | list(String) |
| SubDocuments | For multi-goodoc documents | GoodocDocument | Top-level representation of OCRed document | list(GoodocDocument) |
| header | GoodocDocument | Top-level representation of OCRed document | GoodocDocumentHeader | |
| page | GoodocDocument | Top-level representation of OCRed document | list(GoodocDocumentPage) | |
| OcrEngineId | GoodocDocumentHeader | String | ||
| OcrEngineVersion | GoodocDocumentHeader | String | ||
| font | GoodocDocumentHeader | list(GoodocDocumentHeaderFont) | ||
| FontId | GoodocDocumentHeaderFont | integer | ||
| FontName | GoodocDocumentHeaderFont | String | ||
| GarbageDetectorChangeList | If the garbage text detector was run, the changelist that the binary was sync’ed to (or -1 if unknown), and whether the settings had their production values (or false if unknown). | GoodocDocumentPage | integer | |
| GarbageDetectorWasProduction | GoodocDocumentPage | boolean | ||
| Height | Height in pixels | GoodocDocumentPage | integer | |
| HorizontalDpi | Horizontal resolution in DPI. | GoodocDocumentPage | integer | |
| Label | GoodocDocumentPage | GoodocLabel | ||
| PornScore | Score of porn classifier from analyzing images on page. Note: This should be named porn_score, but we use PornScore as the name in order to be consistent with the rest of this proto. | GoodocDocumentPage | float | |
| TextConfidence | Page text recognition confidence. Range depends on the algorithm but should be consistent in a given volume. 0 is bad, 100 is good. | GoodocDocumentPage | integer | |
| VerticalDpi | Vertical resolution in DPI. | GoodocDocumentPage | integer | |
| Width | Width in pixels | GoodocDocumentPage | integer | |
| block | GoodocDocumentPage | list(GoodocDocumentPageBlock) | ||
| mergedpageinfo | GoodocDocumentPage | list(GoodocDocumentPageMergedPageInfo) | ||
| postOcrConfidence | Whether page-level text confidences and other summary data were computed by PostOcrUtils instead of the now-obsolete GarbageTextDetector | GoodocDocumentPage | boolean | |
| stats | Page level stats (font size, line spacing, etc.) | GoodocDocumentPage | GoodocSummaryStats | |
| BlockType | GoodocDocumentPageBlock | integer | ||
| Box | GoodocDocumentPageBlock | GoodocBoundingBox | ||
| Label | GoodocDocumentPageBlock | GoodocLabel | ||
| OrientationLabel | Which way is upright for this block, and what is the reading order (applicable if there is text here). | GoodocDocumentPageBlock | GoodocOrientationLabel | |
| Paragraph | GoodocDocumentPageBlock | list(GoodocParagraph) | ||
| RotatedBox | If RotatedBox is set, Box must be set as well. See RotatedBoundingBox. | GoodocDocumentPageBlock | GoodocRotatedBoundingBox | |
| TextConfidence | Block text recognition confidence. Range depends on the algorithm but should be consistent in a given volume. 0 is bad, 100 is good. | GoodocDocumentPageBlock | integer | |
| OcrEngineId | GoodocDocumentPageMergedPageInfo | If we have merged text from another goodoc into this one (for example, from a PDF text layer goodoc into an OCR’d goodoc), we record some source goodoc info here. | String | |
| OcrEngineVersion | GoodocDocumentPageMergedPageInfo | If we have merged text from another goodoc into this one (for example, from a PDF text layer goodoc into an OCR’d goodoc), we record some source goodoc info here. | String | |
| fontId | CharLabel.FontId and FontSize | GoodocFontSizeStats | Statistics about a particular font size (from CharLabel.FontSize) aggregated over a range of symbols | integer |
| fontSize | GoodocFontSizeStats | Statistics about a particular font size (from CharLabel.FontSize) aggregated over a range of symbols | integer | |
| medianHeight | The measurements are in pixels | GoodocFontSizeStats | Statistics about a particular font size (from CharLabel.FontSize) aggregated over a range of symbols | integer |
| medianLineHeight | top to bottom | GoodocFontSizeStats | Statistics about a particular font size (from CharLabel.FontSize) aggregated over a range of symbols | integer |
| medianLineSpace | bottom to next top in para | GoodocFontSizeStats | Statistics about a particular font size (from CharLabel.FontSize) aggregated over a range of symbols | integer |
| medianLineSpan | top to next top in para | GoodocFontSizeStats | Statistics about a particular font size (from CharLabel.FontSize) aggregated over a range of symbols | integer |
| medianWidth | GoodocFontSizeStats | Statistics about a particular font size (from CharLabel.FontSize) aggregated over a range of symbols | integer | |
| numLineSpaces | Lines (out of num_lines) that have a successor line within their para | GoodocFontSizeStats | Statistics about a particular font size (from CharLabel.FontSize) aggregated over a range of symbols | integer |
| numLines | Line stats for this font. “top” corresponds to the highest ascender and “bottom” to the lowest descender. num_lines = # lines with > 50% symbols having this font | GoodocFontSizeStats | Statistics about a particular font size (from CharLabel.FontSize) aggregated over a range of symbols | integer |
| numSymbols | GoodocFontSizeStats | Statistics about a particular font size (from CharLabel.FontSize) aggregated over a range of symbols | integer | |
| AnchorLabel | AnchorLabel identifies a link target. | GoodocLabel | Label aggregates all kinds of optional characteristics of page elements. | list(GoodocAnchorLabel) |
| BreakLabel | GoodocLabel | Label aggregates all kinds of optional characteristics of page elements. | GoodocBreakLabel | |
| CharLabel | CharLabel is specifically intended for symbols | GoodocLabel | Label aggregates all kinds of optional characteristics of page elements. | GoodocCharLabel |
| LanguageLabel | Languages used in the element (page, block, paragraph or word). Ordered by dominant-language first. Note: content scanjobs processed by the garbage_text_detector before CL 9223538 (Dec. 2008) have LanguageLabels in arbitrary order (within Page and Block elements) — the confidence value should be inspected to find the dominant language guess for these, rather than just taking the first. | GoodocLabel | Label aggregates all kinds of optional characteristics of page elements. | list(GoodocLanguageLabel) |
| SemanticLabel | SemanticLabel is defined in goodoc-semantics.proto, it allows rich annotation of content, identifying the nature of page elements. | GoodocLabel | Label aggregates all kinds of optional characteristics of page elements. | GoodocSemanticLabel |
| bcp47Tag | Bcp47 language code. Note, this is not the same as OceanCode used by goodoc::Document. | GoodocLanguageCombinationLanguage | Weighted language | String |
| weight | Weight of language. This specifies how likely it is to see the language in the input text. The values don’t have to add up to 1. | GoodocLanguageCombinationLanguage | Weighted language | number |
| ClosestLanguageId | Closest id from i18n/languages/proto/languages.proto; caveat: may not accurately capture the language. GoodocLanguageCodeToLanguage() declared in ocr/goodoc/goodoc-utils.h may be used to convert a Language enum (i18n/languages/proto/languages.proto) to a string suitable for this field. | GoodocLanguageLabel | Language label | integer |
| Confidence | Confidence level on that language, between 0 and 100 | GoodocLanguageLabel | Language label | integer |
| LanguageCode | Old (Ocean) Language Code Usage: The language code is inferred during the running of the Garbage Text Detector and gets set at the paragraph, block and page level. Language code is a string of 3 or more characters. The first 3 letters specify the language, according to ISO 639. Optionally, the 3-letter code can be extended with an underscore and a language variant specifier. Specifiers exist for regional variants or for different forms of language spelling. The regional variants are specified as 2-letter country code, according to ISO 3166. Some examples: Standard “por” – Portuguese, standard “rus” – Russian, standard Regional variants: “por_br” – Portuguese, Brazilian “eng_us” – English, United States Variants of spelling: “rus_old” – Russian, old spelling “chi_tra” – Chinese, traditional “ger_new” – German, new spelling LanguageToGoodocLanguageCode() declared in ocr/goodoc/goodoc-utils.h may be used to convert a Language enum (i18n/languages/proto/languages.proto) to a string suitable for this field. New Language Code Usage: Most of the usages described above were standardized in BCP 47, and these codes are the new stanadard to be used in this field. To load either new or old language codes to form LanguageCode objects, use the function FromOceanCode() in ocr/quality/lang_util.h Note that the function ocr::FromOceanCode is capable of transforming either version of the LanguageCode to a C++ i18n_identifiers::LanguageCode. | GoodocLanguageLabel | Language label | String |
| Metadata | GoodocLogicalEntity | A logical entity in the abstract is just a group of links to the goodoc. Depending on the kind of item, a separate proto file should extend this to define the logical structure for that kind. For example. newspapers.proto defines the logical entity for newspapers. LogicalEntity is also used within some SemanticLabels, for example, for a table-of-contents link. | String | |
| link | GoodocLogicalEntity | A logical entity in the abstract is just a group of links to the goodoc. Depending on the kind of item, a separate proto file should extend this to define the logical structure for that kind. For example. newspapers.proto defines the logical entity for newspapers. LogicalEntity is also used within some SemanticLabels, for example, for a table-of-contents link. | list(GoodocLogicalEntityLink) | |
| Anchor | The preferred way to link to an element is to create an AnchorLabel in the target element and name it here. Multiple elements may contain the same Anchor string. | GoodocLogicalEntityLink | NOTE(gponcin) 2008/11 This is repeated for articles where we may have multiple links in one entity. From Vivek (Atlantis): “The block segmenter outputs a list of headlines on a page as a single logical entity that we attach to the logicalentity(1) for the goodoc.” | String |
| BlockId | GoodocLogicalEntityLink | NOTE(gponcin) 2008/11 This is repeated for articles where we may have multiple links in one entity. From Vivek (Atlantis): “The block segmenter outputs a list of headlines on a page as a single logical entity that we attach to the logicalentity(1) for the goodoc.” | integer | |
| DocId | Links may also specifically locate the target element with the following indices. Note that during the course of layout analysis, goodoc elements may move around, so such hard links should be created only very late (or not at all — Anchors would be more reliable target addresses). | GoodocLogicalEntityLink | NOTE(gponcin) 2008/11 This is repeated for articles where we may have multiple links in one entity. From Vivek (Atlantis): “The block segmenter outputs a list of headlines on a page as a single logical entity that we attach to the logicalentity(1) for the goodoc.” | integer |
| PageId | GoodocLogicalEntityLink | NOTE(gponcin) 2008/11 This is repeated for articles where we may have multiple links in one entity. From Vivek (Atlantis): “The block segmenter outputs a list of headlines on a page as a single logical entity that we attach to the logicalentity(1) for the goodoc.” | integer | |
| ParagraphId | GoodocLogicalEntityLink | NOTE(gponcin) 2008/11 This is repeated for articles where we may have multiple links in one entity. From Vivek (Atlantis): “The block segmenter outputs a list of headlines on a page as a single logical entity that we attach to the logicalentity(1) for the goodoc.” | integer | |
| RouteId | GoodocLogicalEntityLink | NOTE(gponcin) 2008/11 This is repeated for articles where we may have multiple links in one entity. From Vivek (Atlantis): “The block segmenter outputs a list of headlines on a page as a single logical entity that we attach to the logicalentity(1) for the goodoc.” | integer | |
| SymbolId | GoodocLogicalEntityLink | NOTE(gponcin) 2008/11 This is repeated for articles where we may have multiple links in one entity. From Vivek (Atlantis): “The block segmenter outputs a list of headlines on a page as a single logical entity that we attach to the logicalentity(1) for the goodoc.” | integer | |
| Url | If not defined, link points to the current doc | GoodocLogicalEntityLink | NOTE(gponcin) 2008/11 This is repeated for articles where we may have multiple links in one entity. From Vivek (Atlantis): “The block segmenter outputs a list of headlines on a page as a single logical entity that we attach to the logicalentity(1) for the goodoc.” | String |
| WordId | GoodocLogicalEntityLink | NOTE(gponcin) 2008/11 This is repeated for articles where we may have multiple links in one entity. From Vivek (Atlantis): “The block segmenter outputs a list of headlines on a page as a single logical entity that we attach to the logicalentity(1) for the goodoc.” | integer | |
| implicit | GoodocOrdinal | An Ordinal message represents a single ordinal component of a page number. It encodes the printed or inferred numbering style (Roman, ASCII, etc.) and the ordinal value of the component. An optional set of variable is defined in order to express a sectioned ordinal. A sectioned ordinal may appear in certain page numbering styles, for example “12-1” where “12” identifies a chapter and “1” identifies the page within it. This case will be encoded with value 1 and section_value 12 both of type ASCII. | String | |
| sectionStringValue | GoodocOrdinal | An Ordinal message represents a single ordinal component of a page number. It encodes the printed or inferred numbering style (Roman, ASCII, etc.) and the ordinal value of the component. An optional set of variable is defined in order to express a sectioned ordinal. A sectioned ordinal may appear in certain page numbering styles, for example “12-1” where “12” identifies a chapter and “1” identifies the page within it. This case will be encoded with value 1 and section_value 12 both of type ASCII. | String | |
| sectionValue | GoodocOrdinal | An Ordinal message represents a single ordinal component of a page number. It encodes the printed or inferred numbering style (Roman, ASCII, etc.) and the ordinal value of the component. An optional set of variable is defined in order to express a sectioned ordinal. A sectioned ordinal may appear in certain page numbering styles, for example “12-1” where “12” identifies a chapter and “1” identifies the page within it. This case will be encoded with value 1 and section_value 12 both of type ASCII. | integer | |
| sectionValueType | The following vars describe the section component of an ordinal (if exists). They are used to express situation where a page number has a section component, usually denoating the chapter number. For example pages 5-14, 5-15 will both have the common section 5. (If exists). The semantcis of the section variables correspond to that of the primary part of the ordinal. (Described above). | GoodocOrdinal | An Ordinal message represents a single ordinal component of a page number. It encodes the printed or inferred numbering style (Roman, ASCII, etc.) and the ordinal value of the component. An optional set of variable is defined in order to express a sectioned ordinal. A sectioned ordinal may appear in certain page numbering styles, for example “12-1” where “12” identifies a chapter and “1” identifies the page within it. This case will be encoded with value 1 and section_value 12 both of type ASCII. | String |
| stringValue | The string page value. | GoodocOrdinal | An Ordinal message represents a single ordinal component of a page number. It encodes the printed or inferred numbering style (Roman, ASCII, etc.) and the ordinal value of the component. An optional set of variable is defined in order to express a sectioned ordinal. A sectioned ordinal may appear in certain page numbering styles, for example “12-1” where “12” identifies a chapter and “1” identifies the page within it. This case will be encoded with value 1 and section_value 12 both of type ASCII. | String |
| value | The numeric page value. | GoodocOrdinal | An Ordinal message represents a single ordinal component of a page number. It encodes the printed or inferred numbering style (Roman, ASCII, etc.) and the ordinal value of the component. An optional set of variable is defined in order to express a sectioned ordinal. A sectioned ordinal may appear in certain page numbering styles, for example “12-1” where “12” identifies a chapter and “1” identifies the page within it. This case will be encoded with value 1 and section_value 12 both of type ASCII. | integer |
| valueDelta | The delta in which the value increases between pages. | GoodocOrdinal | An Ordinal message represents a single ordinal component of a page number. It encodes the printed or inferred numbering style (Roman, ASCII, etc.) and the ordinal value of the component. An optional set of variable is defined in order to express a sectioned ordinal. A sectioned ordinal may appear in certain page numbering styles, for example “12-1” where “12” identifies a chapter and “1” identifies the page within it. This case will be encoded with value 1 and section_value 12 both of type ASCII. | String |
| valueType | A value type from the Type enum above. | GoodocOrdinal | An Ordinal message represents a single ordinal component of a page number. It encodes the printed or inferred numbering style (Roman, ASCII, etc.) and the ordinal value of the component. An optional set of variable is defined in order to express a sectioned ordinal. A sectioned ordinal may appear in certain page numbering styles, for example “12-1” where “12” identifies a chapter and “1” identifies the page within it. This case will be encoded with value 1 and section_value 12 both of type ASCII. | String |
| deskewAngle | After rotating so that the text orientation is upright, how many radians does one have to rotate the block anti-clockwise for it to be level? We guarantee: -Pi/4 <= deskew_angle <= Pi/4 | GoodocOrientationLabel | OrientationLabel groups the details about orientation and reading order. | number |
| mirrored | Whether a text line is mirrored (e.g. reflected in a shiny surface or seen through the opposite side of a storefront window). The intent is that this is a quality of the text line image. It needs to be reflected according to a vertical axis along the direction of upright characters to make it readable. This does not affect the shape of the bounding box. A mirrored line with top to bottom writing remains top to bottom. A mirrored horizontal line will flip left to right. However any child entities (symbols) will remain in the same order, and the writing direction imposed by the language (ltr or rtl) will remain the same. | GoodocOrientationLabel | OrientationLabel groups the details about orientation and reading order. | boolean |
| orientation | GoodocOrientationLabel | OrientationLabel groups the details about orientation and reading order. | String | |
| textlineOrder | GoodocOrientationLabel | OrientationLabel groups the details about orientation and reading order. | String | |
| writingDirection | GoodocOrientationLabel | OrientationLabel groups the details about orientation and reading order. | String | |
| blockImagination | For text blocks only: do not allow this block to be turned into an image when rendering, even if your algorithms want to do so: | GoodocOverrides | This message specifies structure “overrides” to apply: it can be used to force certain kinds of GoodocToHTML renderings of elements. | String |
| doNotExpandGraphicBox | For graphic blocks, we often expand the block a bit for rendering, to compensate for bad image segmentation. do_not_expand_graphic_box forces this behavior to be turned off. | GoodocOverrides | This message specifies structure “overrides” to apply: it can be used to force certain kinds of GoodocToHTML renderings of elements. | boolean |
| fullPageAsImage | For Pages only: explicitly specify whether or not this page should be rendered fully as an image | GoodocOverrides | This message specifies structure “overrides” to apply: it can be used to force certain kinds of GoodocToHTML renderings of elements. | String |
| fullPageLineated | For Pages only: explicitly specify whether or not all text on this page should be treated as “LINEATED” | GoodocOverrides | This message specifies structure “overrides” to apply: it can be used to force certain kinds of GoodocToHTML renderings of elements. | String |
| fullPageSkipped | For Pages only: explicitly specify whether or not this page should be skipped. | GoodocOverrides | This message specifies structure “overrides” to apply: it can be used to force certain kinds of GoodocToHTML renderings of elements. | String |
| needNotSuppressPhoto | This GRAPHIC block’s image can be shown even when GoodocToHTMLOptions.suppress_photos_with_this is specified. | GoodocOverrides | This message specifies structure “overrides” to apply: it can be used to force certain kinds of GoodocToHTML renderings of elements. | boolean |
| pageBreakBefore | For blocks: explicitly specify whether or not this block should get a page-break before it. | GoodocOverrides | This message specifies structure “overrides” to apply: it can be used to force certain kinds of GoodocToHTML renderings of elements. | String |
| style | GoodocOverrides | This message specifies structure “overrides” to apply: it can be used to force certain kinds of GoodocToHTML renderings of elements. | list(GoodocOverridesStyle) | |
| wordHtml | For Words only: replace the rendered HTML by this: | GoodocOverrides | This message specifies structure “overrides” to apply: it can be used to force certain kinds of GoodocToHTML renderings of elements. | String |
| name | css attribute name: “margin-left”, for eg. | GoodocOverridesStyle | Extra css styles to apply | String |
| value | css attribute vale: “1em”, for eg. | GoodocOverridesStyle | Extra css styles to apply | String |
| Box | GoodocParagraph | Represents a paragraph of text in OCRed content. | GoodocBoundingBox | |
| FirstLineIndent | GoodocParagraph | Represents a paragraph of text in OCRed content. | integer | |
| Label | GoodocParagraph | Represents a paragraph of text in OCRed content. | GoodocLabel | |
| LeftIndent | GoodocParagraph | Represents a paragraph of text in OCRed content. | integer | |
| LineSpacing | GoodocParagraph | Represents a paragraph of text in OCRed content. | integer | |
| OrientationLabel | Which way is upright for this paragraph and what is the dominant reading order? | GoodocParagraph | Represents a paragraph of text in OCRed content. | GoodocOrientationLabel |
| RightIndent | GoodocParagraph | Represents a paragraph of text in OCRed content. | integer | |
| RotatedBox | If RotatedBox is set, Box must be set as well. See RotatedBoundingBox. | GoodocParagraph | Represents a paragraph of text in OCRed content. | GoodocRotatedBoundingBox |
| SpaceAfter | GoodocParagraph | Represents a paragraph of text in OCRed content. | integer | |
| SpaceBefore | GoodocParagraph | Represents a paragraph of text in OCRed content. | integer | |
| SubsumedParagraphProperties | If we merge any paragraphs into this one (through the MergeParagraphWithNext() interface in goodoc-editing.h), then we append the properties of the merged paragraph here, for debugging and to avoid losing any info. Note that the SubsumedParagraphProperties Paragraphs do not contain Routes. | GoodocParagraph | Represents a paragraph of text in OCRed content. | list(GoodocParagraph) |
| TextConfidence | Paragraph text recognition confidence. Range depends on the algorithm but should be consistent in a given volume. 0 is bad, 100 is good. | GoodocParagraph | Represents a paragraph of text in OCRed content. | integer |
| Width | GoodocParagraph | Represents a paragraph of text in OCRed content. | integer | |
| alignment | GoodocParagraph | Represents a paragraph of text in OCRed content. | integer | |
| droppedcap | GoodocParagraph | Represents a paragraph of text in OCRed content. | GoodocParagraphDroppedCap | |
| route | GoodocParagraph | Represents a paragraph of text in OCRed content. | list(GoodocParagraphRoute) | |
| Box | GoodocParagraphDroppedCap | Information about the paragraph’s dropped capital letter | GoodocBoundingBox | |
| LettersCount | GoodocParagraphDroppedCap | Information about the paragraph’s dropped capital letter | integer | |
| EndPoint | Route end point | GoodocParagraphRoute | GoodocRoutePoint | |
| StartPoint | Route start point | GoodocParagraphRoute | GoodocRoutePoint | |
| Weight | Route weight, i.e. route | GoodocParagraphRoute | integer | |
| Word | The array of words on this route | GoodocParagraphRoute | list(GoodocWord) | |
| Angle | Angle of rotation of the original non-rotated box around the top left corner of the original non-rotated box, in clockwise degrees from the horizontal. | GoodocRotatedBoundingBox | Similar to goodoc.BoundingBox, but containing an angle of rotation, thus able to represent non-axis-aligned boxes. RotatedBoundingBox can be used in combination with BoundingBox to better represent non-axis-aligned page structural elements. In such case, two bounding boxes can be used per element. A RotatedBoundingBox that is rotated to tightly encompass the element; embedded (as tightly as possible) inside an axis-aligned BoundingBox. Note that there is some amount of ambiguity regarding what angle and vertex to use. Consider a square with axis-aligned diagonals: B / \\ A C \\ / D This can either be represented as a -45 degree rotation around A, a 45 degree rotation around B, a 135 degree rotation around C, or a -135 degree rotation around D. Which one you use depends on your use case, but one recommendation is to use the vertex that would be top left if the reader was reading it in the ‘natural’ orientation. | number |
| Height | GoodocRotatedBoundingBox | Similar to goodoc.BoundingBox, but containing an angle of rotation, thus able to represent non-axis-aligned boxes. RotatedBoundingBox can be used in combination with BoundingBox to better represent non-axis-aligned page structural elements. In such case, two bounding boxes can be used per element. A RotatedBoundingBox that is rotated to tightly encompass the element; embedded (as tightly as possible) inside an axis-aligned BoundingBox. Note that there is some amount of ambiguity regarding what angle and vertex to use. Consider a square with axis-aligned diagonals: B / \\ A C \\ / D This can either be represented as a -45 degree rotation around A, a 45 degree rotation around B, a 135 degree rotation around C, or a -135 degree rotation around D. Which one you use depends on your use case, but one recommendation is to use the vertex that would be top left if the reader was reading it in the ‘natural’ orientation. | integer | |
| Left | Coordinates and sizes are expressed in pixels, where the top-left pixel is (0, 0). The coordinates refer to the corner of the top-left vertex of the unrotated version of the box. | GoodocRotatedBoundingBox | Similar to goodoc.BoundingBox, but containing an angle of rotation, thus able to represent non-axis-aligned boxes. RotatedBoundingBox can be used in combination with BoundingBox to better represent non-axis-aligned page structural elements. In such case, two bounding boxes can be used per element. A RotatedBoundingBox that is rotated to tightly encompass the element; embedded (as tightly as possible) inside an axis-aligned BoundingBox. Note that there is some amount of ambiguity regarding what angle and vertex to use. Consider a square with axis-aligned diagonals: B / \\ A C \\ / D This can either be represented as a -45 degree rotation around A, a 45 degree rotation around B, a 135 degree rotation around C, or a -135 degree rotation around D. Which one you use depends on your use case, but one recommendation is to use the vertex that would be top left if the reader was reading it in the ‘natural’ orientation. | integer |
| Top | GoodocRotatedBoundingBox | Similar to goodoc.BoundingBox, but containing an angle of rotation, thus able to represent non-axis-aligned boxes. RotatedBoundingBox can be used in combination with BoundingBox to better represent non-axis-aligned page structural elements. In such case, two bounding boxes can be used per element. A RotatedBoundingBox that is rotated to tightly encompass the element; embedded (as tightly as possible) inside an axis-aligned BoundingBox. Note that there is some amount of ambiguity regarding what angle and vertex to use. Consider a square with axis-aligned diagonals: B / \\ A C \\ / D This can either be represented as a -45 degree rotation around A, a 45 degree rotation around B, a 135 degree rotation around C, or a -135 degree rotation around D. Which one you use depends on your use case, but one recommendation is to use the vertex that would be top left if the reader was reading it in the ‘natural’ orientation. | integer | |
| Width | GoodocRotatedBoundingBox | Similar to goodoc.BoundingBox, but containing an angle of rotation, thus able to represent non-axis-aligned boxes. RotatedBoundingBox can be used in combination with BoundingBox to better represent non-axis-aligned page structural elements. In such case, two bounding boxes can be used per element. A RotatedBoundingBox that is rotated to tightly encompass the element; embedded (as tightly as possible) inside an axis-aligned BoundingBox. Note that there is some amount of ambiguity regarding what angle and vertex to use. Consider a square with axis-aligned diagonals: B / \\ A C \\ / D This can either be represented as a -45 degree rotation around A, a 45 degree rotation around B, a 135 degree rotation around C, or a -135 degree rotation around D. Which one you use depends on your use case, but one recommendation is to use the vertex that would be top left if the reader was reading it in the ‘natural’ orientation. | integer | |
| RouteIndex | The sequential route number, starts at 0 | GoodocRoutePoint | integer | |
| WordIndex | The sequential word number, starts at 0 | GoodocRoutePoint | integer | |
| AlternateText | Alternate text for a sequence of the Goodoc, just for the element containing this label, or for a sequence starting from this element to the EndOfSpanningLabel. Typically this is inserted by automatic or manual OCR correction. We use text instead of editing the Goodoc directly since we dont usually have accurate symbol level bboxes for the alternate text. Also the original values from OCR are preserved. It is upto the application to do anything more intelligent like mapping words and finding potential symbol/word bboxes. | GoodocSemanticLabel | Label identifying a logical part of the page content. This applies mostly at Block level or Paragraph level (but can apply to Words or to arbitrary spans if needed). | String |
| Attribute | Page elements can be given Attributes refining meaning/role. We keep this flexible by using strings instead of pre-determined enum values. But it is useful to list all such Attributes in use in ocr/goodoc/goodoc-semantics-attributes.h | GoodocSemanticLabel | Label identifying a logical part of the page content. This applies mostly at Block level or Paragraph level (but can apply to Words or to arbitrary spans if needed). | list(String) |
| ChapterStart | Blocks that are at the beginning of chapters have this set: | GoodocSemanticLabel | Label identifying a logical part of the page content. This applies mostly at Block level or Paragraph level (but can apply to Words or to arbitrary spans if needed). | boolean |
| CleanupAnnotation | GoodocSemanticLabel | Label identifying a logical part of the page content. This applies mostly at Block level or Paragraph level (but can apply to Words or to arbitrary spans if needed). | list(integer) | |
| ContinuesFromPreviousPage | GoodocSemanticLabel | Label identifying a logical part of the page content. This applies mostly at Block level or Paragraph level (but can apply to Words or to arbitrary spans if needed). | boolean | |
| ContinuesFromPreviousPageHyphenated | When ContinuesFromPreviousPage=true, this bit can be set to note that the word fragment on the previous page ends in a hyphen. | GoodocSemanticLabel | Label identifying a logical part of the page content. This applies mostly at Block level or Paragraph level (but can apply to Words or to arbitrary spans if needed). | boolean |
| ContinuesOnNextPage | Paragraphs that span across pages can be identified with the following flags. Note that flows just connect Blocks across pages. These continuation flags imply something more specific — the case of a single logical paragraph split over pages. Only the last Paragraph in the last Block within a given FlowThread() on a page can have ContinuesOnNextPage set. Similarly, only the first Paragraph in the first Block with a given FlowThread() on a page may have ContinuesFromPreviousPage set. | GoodocSemanticLabel | Label identifying a logical part of the page content. This applies mostly at Block level or Paragraph level (but can apply to Words or to arbitrary spans if needed). | boolean |
| EndOfSpanningLabel | Normally, a SemanticLabel applies exactly to the goodoc element that it is contained in (usually Block or Paragraph, sometimes Word). Occasionally, we need a SemanticLabel to span across the boundary or end before the boundary. For example, a URL may just be a few words within a Paragraph. In such cases, the SemanticLabel is added to the first element of the span and contains this LogicalEntity pointing to the last element of the span: | GoodocSemanticLabel | Label identifying a logical part of the page content. This applies mostly at Block level or Paragraph level (but can apply to Words or to arbitrary spans if needed). | GoodocLogicalEntity |
| ExperimentalData | Message set for experimental algorithm data. Use case: We keep a set of features that was computed for the unsupervised caption extraction and store it here. Agora question producer will consume this message set to be embedded in a question. The experimental feature set can then be used later to pair up with ground truth labels for designing a supervised algorithm. Currently holding: o ocean/analysis/content/caption_data.proto’s TextualElement | GoodocSemanticLabel | Label identifying a logical part of the page content. This applies mostly at Block level or Paragraph level (but can apply to Words or to arbitrary spans if needed). | Proto2BridgeMessageSet |
| Flow | Flow identifies a single sequential unit of text (or other content). It is only set on Blocks — a flow identifies a sequence of Blocks. The default, main flow is just the empty string. The “FlowThread” of a block is the flow (if non-empty), suffixed with the block appearance. This is computed by GoodocUtils::FlowThread(). Paragraphs may be split over blocks in the same FlowThread, across pages. The following table shows how FlowThread gets computed: ## Flow Appearance FlowThread (empty) UNSPECIFIED “UNSPECIFIED” foo BODY “foo:BODY” Please use lower-case strings for flows (such as article-33-box). One useful way to think of flows is this: A logical unit of interest in a a Document (for example, an article) would be identified by a starting block, an ending block, and a list of flows of interest within the [start, end) span. message Article { (page#, block#): article_start; (page#, block#): article_end; repeated string flows; } The reading order of blocks, paragraphs/etc within this article would be the same order as present in the goodoc itself. Some applications (such as rendering) may want to process the article by running over all the flows together, others (such as indexing) may want to deal with the FlowThreads one after the other. | GoodocSemanticLabel | Label identifying a logical part of the page content. This applies mostly at Block level or Paragraph level (but can apply to Words or to arbitrary spans if needed). | String |
| ModificationRecord | This field can be used to record the steps by which AlternateText for a sequence of the Goodoc is generated. | GoodocSemanticLabel | Label identifying a logical part of the page content. This applies mostly at Block level or Paragraph level (but can apply to Words or to arbitrary spans if needed). | String |
| PageNumberOrdinal | If Appearence is PAGE_NUMBER: | GoodocSemanticLabel | Label identifying a logical part of the page content. This applies mostly at Block level or Paragraph level (but can apply to Words or to arbitrary spans if needed). | GoodocOrdinal |
| appearance | GoodocSemanticLabel | Label identifying a logical part of the page content. This applies mostly at Block level or Paragraph level (but can apply to Words or to arbitrary spans if needed). | integer | |
| columndetails | GoodocSemanticLabel | Label identifying a logical part of the page content. This applies mostly at Block level or Paragraph level (but can apply to Words or to arbitrary spans if needed). | GoodocSemanticLabelColumnDetails | |
| contentlink | GoodocSemanticLabel | Label identifying a logical part of the page content. This applies mostly at Block level or Paragraph level (but can apply to Words or to arbitrary spans if needed). | GoodocSemanticLabelContentLink | |
| editcorrectioncandidate | GoodocSemanticLabel | Label identifying a logical part of the page content. This applies mostly at Block level or Paragraph level (but can apply to Words or to arbitrary spans if needed). | list(GoodocSemanticLabelEditCorrectionCandidate) | |
| overrides | Structure overrides: typically manual corrections to goodoc renderings. | GoodocSemanticLabel | Label identifying a logical part of the page content. This applies mostly at Block level or Paragraph level (but can apply to Words or to arbitrary spans if needed). | GoodocOverrides |
| snippetfilter | GoodocSemanticLabel | Label identifying a logical part of the page content. This applies mostly at Block level or Paragraph level (but can apply to Words or to arbitrary spans if needed). | list(GoodocSemanticLabelSnippetFilter) | |
| tablecelldetails | GoodocSemanticLabel | Label identifying a logical part of the page content. This applies mostly at Block level or Paragraph level (but can apply to Words or to arbitrary spans if needed). | GoodocSemanticLabelTableCellDetails | |
| tabledetails | GoodocSemanticLabel | Label identifying a logical part of the page content. This applies mostly at Block level or Paragraph level (but can apply to Words or to arbitrary spans if needed). | GoodocSemanticLabelTableDetails | |
| Column | GoodocSemanticLabelColumnDetails | If Appearance is COLUMN: | integer | |
| Columns | GoodocSemanticLabelColumnDetails | If Appearance is COLUMN: | integer | |
| UrlTarget | For URL labels, we note the url here directly (it’s also available by grabbing all text symbols within the labeled span). SCHOLARLY_CITATION labels or even CAPTION labels may occasionally contain URLs. | GoodocSemanticLabelContentLink | If the label is for something that links to another piece of content (in this volume, outside, a url, a citation, etc.). | String |
| citationtarget | GoodocSemanticLabelContentLink | If the label is for something that links to another piece of content (in this volume, outside, a url, a citation, etc.). | GoodocSemanticLabelContentLinkCitationTarget | |
| involumetarget | GoodocSemanticLabelContentLink | If the label is for something that links to another piece of content (in this volume, outside, a url, a citation, etc.). | GoodocSemanticLabelContentLinkInVolumeTarget | |
| Authors | separated by semicolons | GoodocSemanticLabelContentLinkCitationTarget | For SCHOLARLY_CITATION labels: | String |
| BibKey | GoodocSemanticLabelContentLinkCitationTarget | For SCHOLARLY_CITATION labels: | String | |
| Confidence | GoodocSemanticLabelContentLinkCitationTarget | For SCHOLARLY_CITATION labels: | float | |
| Title | GoodocSemanticLabelContentLinkCitationTarget | For SCHOLARLY_CITATION labels: | String | |
| Year | GoodocSemanticLabelContentLinkCitationTarget | For SCHOLARLY_CITATION labels: | integer | |
| Confidence | GoodocSemanticLabelContentLinkInVolumeTarget | For CAPTION or FOOTNOTE_POINTER or TOC_ENTRY or INDEX_ENTRY or CONTINUATION labels: | float | |
| LogicalEntity | The CAPTION label typically targets the previous or the next Block. The FOOTNOTE_POINTER label typically targets a paragraph in a FOOTNOTE Block. TOC_ENTRY and INDEX_ENTRY labels are links that point to a different page within the volume. CONTINUATION labels also are links that point to a different page within the volume, or maybe even a particular block or paragraph. | GoodocSemanticLabelContentLinkInVolumeTarget | For CAPTION or FOOTNOTE_POINTER or TOC_ENTRY or INDEX_ENTRY or CONTINUATION labels: | GoodocLogicalEntity |
| EditedWord | GoodocSemanticLabelEditCorrectionCandidate | If there is more than one edit correction candidate, store all the candidates here. This helps a manual correction utility fire the right kind of question with the relevant options. | String | |
| Probability | GoodocSemanticLabelEditCorrectionCandidate | If there is more than one edit correction candidate, store all the candidates here. This helps a manual correction utility fire the right kind of question with the relevant options. | float | |
| badwordFraction | GoodocSemanticLabelSnippetFilter | Recording the output of the snippet filter. We run through a series of snippet filters and store all the conditions that this article passed. A condition is denoted by the “badword_fraction_allowed” in a running window of size – “window_size”. If ARTICLE_SNIPPET_NOT_CLEAN annotation is set, this group has 0 items. It can be a part of article logicalentity, but keeping it here for consistency and coherence as SemanticLabel holds all other article metadata. | float | |
| windowSize | GoodocSemanticLabelSnippetFilter | Recording the output of the snippet filter. We run through a series of snippet filters and store all the conditions that this article passed. A condition is denoted by the “badword_fraction_allowed” in a running window of size – “window_size”. If ARTICLE_SNIPPET_NOT_CLEAN annotation is set, this group has 0 items. It can be a part of article logicalentity, but keeping it here for consistency and coherence as SemanticLabel holds all other article metadata. | integer | |
| Column | GoodocSemanticLabelTableCellDetails | If Appearance is TABLE_CELL: | integer | |
| ColumnSpan | GoodocSemanticLabelTableCellDetails | If Appearance is TABLE_CELL: | integer | |
| Row | Row and Column are 0-based | GoodocSemanticLabelTableCellDetails | If Appearance is TABLE_CELL: | integer |
| RowSpan | GoodocSemanticLabelTableCellDetails | If Appearance is TABLE_CELL: | integer | |
| Columns | GoodocSemanticLabelTableDetails | If Appearance is TABLE: | integer | |
| Rows | GoodocSemanticLabelTableDetails | If Appearance is TABLE: | integer | |
| numParagraphs | —— Paragraph stats Median symbols and words omit junk, header and footer blocks; they are intended to be a measure of the typical “content” paragraph. There can still be substantial differences between means and medians, particularly if a table is present (every cell is a paragraph). | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer |
| medianSymbolsPerParagraph | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer | |
| estimatedFontSizes | This flag is set if the histogram above has been derived by estimating font sizes from CharLabel.CharacterHeight; that happens if the FontSize field is constant, as has happened with Abbyy 9. | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | boolean |
| numLineSpaces | Lines (out of num_lines) that have a successor line within their para | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer |
| medianSymbolsPerBlock | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer | |
| numWords | #NAME? | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer |
| medianSymbolsPerWord | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer | |
| meanSymbolsPerWord | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer | |
| numNonGraphicBlocks | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer | |
| medianFullOddPrintedBox | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | GoodocBoundingBox | |
| medianWordsPerLine | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer | |
| medianLineSpan | top to next top in para | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer |
| medianWidth | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer | |
| medianWordsPerParagraph | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer | |
| meanWordsPerBlock | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer | |
| medianParagraphIndent | leading space on first line | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer |
| medianOddPrintedBox | 1,3,5.. | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | GoodocBoundingBox |
| medianSymbolsPerLine | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer | |
| meanSymbolsPerLine | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer | |
| numLines | —— Line stats “top” corresponds to the highest ascender and “bottom” to the lowest descender. | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer |
| medianParagraphSpace | bottom to next top in block | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer |
| numParagraphSpaces | paras that have a successor para within their block | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer |
| medianPrintedBox | Each median*_printed_box excludes page header/footer and all graphic blocks | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | GoodocBoundingBox |
| numPages | #NAME? | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer |
| medianHorizontalDpi | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer | |
| meanSymbolsPerParagraph | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer | |
| medianVerticalDpi | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer | |
| medianFullPrintedBox | Each median_full*_printed_box includes page header/footer but still excludes all graphic blocks | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | GoodocBoundingBox |
| fontSizeHistogram | Symbol counts (and other attributes) for each distinct CharLabel.FontId and FontSize; histogram is in decreasing order of symbol count | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | list(GoodocFontSizeStats) |
| medianBlockSpace | bottom to next top in flow on page | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer |
| medianLineHeight | top to bottom | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer |
| medianHeight | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer | |
| medianFullEvenPrintedBox | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | GoodocBoundingBox | |
| meanWordsPerParagraph | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer | |
| meanWordsPerLine | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer | |
| medianEvenPrintedBox | 0,2,4.. | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | GoodocBoundingBox |
| medianLineSpace | bottom to next top in para | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer |
| numSymbols | #NAME? | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer |
| numBlocks | —— Block stats Median symbols and words omit junk, header and footer blocks; they are intended to be a measure of the typical “content” block. There can still be substantial differences between means and medians; however, block values will generally exceed paragraph values (not the case when headers and footers are included). | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer |
| medianWordsPerBlock | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer | |
| numBlockSpaces | blocks that have a successor block within their flow on their page | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer |
| meanSymbolsPerBlock | GoodocSummaryStats | Goodoc stats for a range of elements, such as one page or a whole book. These stats can be computed using the SummaryStatsCollector class. Some range stats are pre-computed and stored in goodocs/volumes (eg., Page.stats below, and Ocean’s CA_VolumeResult.goodoc_stats). | integer | |
| Box | GoodocSymbol | A single symbol representation | GoodocBoundingBox | |
| Code | The unicode character code in UTF-32 | GoodocSymbol | A single symbol representation | integer |
| Label | GoodocSymbol | A single symbol representation | GoodocLabel | |
| RotatedBox | If RotatedBox is set, Box must be set as well. See RotatedBoundingBox. | GoodocSymbol | A single symbol representation | GoodocRotatedBoundingBox |
| symbolvariant | GoodocSymbol | A single symbol representation | list(GoodocSymbolSymbolVariant) | |
| Code | GoodocSymbolSymbolVariant | integer | ||
| Confidence | GoodocSymbolSymbolVariant | integer | ||
| Baseline | The baseline’s y-axis offset from the bottom of the word’s bounding box, given in pixels. (A value of 2, for instance, indicates the baseline is 2px above the bottom of the box.) | GoodocWord | A word representation | integer |
| Box | GoodocWord | A word representation | GoodocBoundingBox | |
| Capline | The capline is the y-axis offset from the top of the word bounding box. A positive value n indicates that capline is n-pixels above the top of this word. | GoodocWord | A word representation | integer |
| CompactSymbolBoxes | For space efficiency, we sometimes skip the detailed per-symbol bounding boxes in Symbol.Box, and use this coarser representation instead, where we just store Symbol boundaries within the Word box. Most client code should not have to worry directly about this, it should be handled in the deepest layers of writing/reading goodocs (for example, see Compress() and Uncompress() in ocean/goodoc/goovols-bigtable-volume.h). Note(viresh): I experimented with this compression, and here are some numbers for reference. If the zlib-compressed page goodoc string size was 100 to start with, then this compaction makes it 65. As a possible future relaxation to consider: if we add in, for each symbol, a “top” and “bottom” box offset then the size would be 75 (that’s with “repeated int32 top/bottom_offset” fields inside BoxPartitions, instead of inside each symbol). | GoodocWord | A word representation | GoodocBoxPartitions |
| Confidence | Word recognition confidence. Range depends upon OCR Engine. | GoodocWord | A word representation | integer |
| IsFromDictionary | word. The meaning and range depends on the OCR engine or subsequent processing. Specifies whether the word was found | GoodocWord | A word representation | boolean |
| IsIdentifier | a number True if word represents | GoodocWord | A word representation | boolean |
| IsLastInSentence | True if the word is the last word in any sub-paragraph unit that functions at the same level of granularity as a sentence. Examples: “She hit the ball.” (regular sentence) “Dewey defeats Truman” (heading) “The more, the merrier.” (no verb) Note: not currently used. Code to set this was introduced in CL 7038338 and removed in OCL=10678722. | GoodocWord | A word representation | boolean |
| IsNumeric | in the dictionary True if the word represents | GoodocWord | A word representation | boolean |
| Label | GoodocWord | A word representation | GoodocLabel | |
| Penalty | Penalty for discordance of characters in a | GoodocWord | A word representation | integer |
| RotatedBox | If RotatedBox is set, Box must be set as well. See RotatedBoundingBox. | GoodocWord | A word representation | GoodocRotatedBoundingBox |
| Symbol | Word characters, the text may | GoodocWord | A word representation | list(GoodocSymbol) |
| alternates | GoodocWord | A word representation | GoodocWordAlternates | |
| text | As a shortcut, the content API provides the text of words instead of individual symbols (NOTE: this is experimental). This is UTF8. And the main font for the word is stored in Label.CharLabel. | GoodocWord | A word representation | String |
| writingDirection | Writing direction for this word. | GoodocWord | A word representation | String |
| ErrorProbability | The probability that the main OCR engine (Abbyy) string is incorrect; range is 0 (definitely correct) to 100 (definitely incorrect). | GoodocWordAlternates | Alternate OCR words for Ptolemy OCR Correction. This is the output of the Ptolemy error estimator. See http://go/Ptolemy. | integer |
| alternate | GoodocWordAlternates | Alternate OCR words for Ptolemy OCR Correction. This is the output of the Ptolemy error estimator. See http://go/Ptolemy. | list(GoodocWordAlternatesAlternate) | |
| OcrEngineId | See Document.Header | GoodocWordAlternatesAlternate | An alternate word provided by another OCR engine, used for OCR Correction. This iteration only supports simple substitution errors (exhanging one word for another), but with minor modifications (e.g. adding a word count for each alternate), it could support repairing word segmentation and text detection errors. | String |
| OcrEngineVersion | See Document.Header | GoodocWordAlternatesAlternate | An alternate word provided by another OCR engine, used for OCR Correction. This iteration only supports simple substitution errors (exhanging one word for another), but with minor modifications (e.g. adding a word count for each alternate), it could support repairing word segmentation and text detection errors. | String |
| Word | In order to compile, this recursive message needs to be optional, even though it’s within an optional group. | GoodocWordAlternatesAlternate | An alternate word provided by another OCR engine, used for OCR Correction. This iteration only supports simple substitution errors (exhanging one word for another), but with minor modifications (e.g. adding a word count for each alternate), it could support repairing word segmentation and text detection errors. | GoodocWord |
| billingAccount | Name of the billing account. For example `billingAccounts/012345-567890-ABCDEF`. | GoogleApiServiceconsumermanagementV1BillingConfig | Describes the billing configuration for a new tenant project. | String |
| members | Uses the same format as in IAM policy. `member` must include both a prefix and ID. For example, `user:{emailId}`, `serviceAccount:{emailId}`, `group:{emailId}`. | GoogleApiServiceconsumermanagementV1PolicyBinding | Translates to IAM Policy bindings (without auditing at this level) | list(String) |
| role | Role. (https://cloud.google.com/iam/docs/understanding-roles) For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | GoogleApiServiceconsumermanagementV1PolicyBinding | Translates to IAM Policy bindings (without auditing at this level) | String |
| audioMode | Current audio mode on the device while issuing the query. | GoogleAssistantAccessoryV1AudioOutConfig | Specifies the desired format for the server to use when it returns `audio_out` messages. | String |
| audioRoutingMode | Current audio routing on the device while issuing the query. | GoogleAssistantAccessoryV1AudioOutConfig | Specifies the desired format for the server to use when it returns `audio_out` messages. | String |
| encoding | *Required* The encoding of audio data to be returned in all `audio_out` messages. | GoogleAssistantAccessoryV1AudioOutConfig | Specifies the desired format for the server to use when it returns `audio_out` messages. | String |
| preferredBitrateBps | *Optional* Specifies preferred encoding bitrate (bits-per-second). Currently this is only implemented for OGG_OPUS for bitrates of 12000, 16000, 24000, 32000. If not specified, OGG_OPUS defaults to 32000. | GoogleAssistantAccessoryV1AudioOutConfig | Specifies the desired format for the server to use when it returns `audio_out` messages. | integer |
| deviceModelCapabilitiesOverride | Device model capabilities from client to override capabilities in the primary device model. | GoogleAssistantAccessoryV1DeviceConfig | *Required* Fields that identify the device to the Assistant. See also: * [Register a Device – REST API](https: //developers.google.com/assistant/sdk/re // ference/device-registration/register-device-manual) * [Device Model and Instance Schemas](https: //developers.google.com/assistant/sdk/re // ference/device-registration/model-and-instance-schemas) * [Device Proto](https: //developers.google.com/assistant/sdk/re // ference/rpc/google.assistant.devices.v1#device) | GoogleAssistantEmbeddedV1DeviceModelCapabilitiesOverride |
| heterodyneToken | *Optional* An encrypted heterodyne_experiment_token containing the list of experiment_ids (go/ph-server-tokens). | GoogleAssistantAccessoryV1DeviceConfig | *Required* Fields that identify the device to the Assistant. See also: * [Register a Device – REST API](https: //developers.google.com/assistant/sdk/re // ference/device-registration/register-device-manual) * [Device Model and Instance Schemas](https: //developers.google.com/assistant/sdk/re // ference/device-registration/model-and-instance-schemas) * [Device Proto](https: //developers.google.com/assistant/sdk/re // ference/rpc/google.assistant.devices.v1#device) | String |
| surfaceIdentity | *Required* Identifier for the device which sent the request. | GoogleAssistantAccessoryV1DeviceConfig | *Required* Fields that identify the device to the Assistant. See also: * [Register a Device – REST API](https: //developers.google.com/assistant/sdk/re // ference/device-registration/register-device-manual) * [Device Model and Instance Schemas](https: //developers.google.com/assistant/sdk/re // ference/device-registration/model-and-instance-schemas) * [Device Proto](https: //developers.google.com/assistant/sdk/re // ference/rpc/google.assistant.devices.v1#device) | GoogleAssistantEmbeddedV1SurfaceIdentity |
| alarmState | *Optional* Information about on-device alarms. For devices that support alarms, all on-device alarms must be sent up with the DeviceState in order for Assistant Server to be able to perform operations on them. | GoogleAssistantAccessoryV1DeviceState | Information about the state of the device. This contains any state that Assistant may need to know about in order to fulfill requests, for example which timers and alarms are set. Next ID: 13 | GoogleAssistantEmbeddedV1Alarms |
| contextParams | Other context params to be sent to Assistant. This is a assistant.embedded.v1.ContextParams message in serialized binary proto format. | GoogleAssistantAccessoryV1DeviceState | Information about the state of the device. This contains any state that Assistant may need to know about in order to fulfill requests, for example which timers and alarms are set. Next ID: 13 | String |
| deviceTime | A timestamp of the current device time when the request was made. This field is required if your device supports alarms or timers. This ensures that requests are fulfilled relative to the current device time and regardless of any clock skew between the client and the server. | GoogleAssistantAccessoryV1DeviceState | Information about the state of the device. This contains any state that Assistant may need to know about in order to fulfill requests, for example which timers and alarms are set. Next ID: 13 | DateTime |
| deviceTimeZone | The time zone where the device is currently located. This helps the Assistant answer time-related queries relative to the device’s time zone. Generally speaking, mobile devices that support alarms or timers should supply device_time_zone. This field is required if your device supports alarms or timers and the device’s location cannot reliably be determined. (See the comment above google.assistant.embedded.v1.DeviceLocation for a description of how the device’s location is determined.) If the time zone cannot be determined, some queries for creating or modifying timers or alarms may fail with a generic error such as, “Sorry, I don’t know how to help with that.” | GoogleAssistantAccessoryV1DeviceState | Information about the state of the device. This contains any state that Assistant may need to know about in order to fulfill requests, for example which timers and alarms are set. Next ID: 13 | GoogleTypeTimeZone |
| doNotDisturb | Indicate whether do not disturb mode is turned on. | GoogleAssistantAccessoryV1DeviceState | Information about the state of the device. This contains any state that Assistant may need to know about in order to fulfill requests, for example which timers and alarms are set. Next ID: 13 | boolean |
| fitnessActivitiesState | Information about on-device fitness activities. For devices that support fitness activities, all on-device fitness activities must be sent up with the DeviceState in order for Assistant Server to be able to perform operations on them. | GoogleAssistantAccessoryV1DeviceState | Information about the state of the device. This contains any state that Assistant may need to know about in order to fulfill requests, for example which timers and alarms are set. Next ID: 13 | GoogleAssistantEmbeddedV1FitnessActivities |
| installedApps | Information about apps currently installed on device. | GoogleAssistantAccessoryV1DeviceState | Information about the state of the device. This contains any state that Assistant may need to know about in order to fulfill requests, for example which timers and alarms are set. Next ID: 13 | GoogleAssistantAccessoryV1DeviceStateInstalledAppsState |
| installedAppsZlib | This contains a zlib-compressed binary-encoded `InstalledAppsState` proto message. | GoogleAssistantAccessoryV1DeviceState | Information about the state of the device. This contains any state that Assistant may need to know about in order to fulfill requests, for example which timers and alarms are set. Next ID: 13 | String |
| timerState | *Optional* Information about on-device timers. For devices that support timers, all on-device timers must be sent up with the DeviceState in order for Assistant Server to be able to perform operations on them. | GoogleAssistantAccessoryV1DeviceState | Information about the state of the device. This contains any state that Assistant may need to know about in order to fulfill requests, for example which timers and alarms are set. Next ID: 13 | GoogleAssistantEmbeddedV1Timers |
| unavailableSettings | This indicates which specific settings are currently unavailable for modification, despite being listed as a supported setting. Assistant can use this field to trigger unavailability messages, rather than claiming that a setting is entirely unsupported on device. | GoogleAssistantAccessoryV1DeviceState | Information about the state of the device. This contains any state that Assistant may need to know about in order to fulfill requests, for example which timers and alarms are set. Next ID: 13 | list(String) |
| apps | List of apps currently installed on the device. | GoogleAssistantAccessoryV1DeviceStateInstalledAppsState | State of the apps currently installed on the device. | list(AssistantApiCoreTypesProvider) |
| audioOutConfig | Specifies the current audio mode on the device. | GoogleAssistantAccessoryV1ResponseConfig | Configuration for the response. Next Id: 11 | GoogleAssistantAccessoryV1AudioOutConfig |
| deviceConfig | Configuration related to a specific device. | GoogleAssistantAccessoryV1ResponseConfig | Configuration for the response. Next Id: 11 | GoogleAssistantAccessoryV1DeviceConfig |
| deviceInteraction | The client interaction to be sent to Assistant. This is a assistant.embedded.v1.DeviceInteraction message in serialized binary proto format. | GoogleAssistantAccessoryV1ResponseConfig | Configuration for the response. Next Id: 11 | String |
| deviceState | Device state to pass to the Assistant server to use in calculating the response. | GoogleAssistantAccessoryV1ResponseConfig | Configuration for the response. Next Id: 11 | GoogleAssistantAccessoryV1DeviceState |
| initialAudioBytes | Specifies the initial bytes of TTS audio to send. | GoogleAssistantAccessoryV1ResponseConfig | Configuration for the response. Next Id: 11 | integer |
| isNewConversation | If true, the server will treat the request as a new conversation and not use state from the prior request. Set this field to true when the conversation should be restarted, such as after a device reboot, or after a significant lapse of time since the prior query. | GoogleAssistantAccessoryV1ResponseConfig | Configuration for the response. Next Id: 11 | boolean |
| outputSampleRateHz | Specifies the desired audio sample rate of the output TTS stream in Hz. | GoogleAssistantAccessoryV1ResponseConfig | Configuration for the response. Next Id: 11 | integer |
| responseType | Specifies the requested response type. | GoogleAssistantAccessoryV1ResponseConfig | Configuration for the response. Next Id: 11 | String |
| screenOutConfig | Specifies the desired format to use when server returns a visual screen response. | GoogleAssistantAccessoryV1ResponseConfig | Configuration for the response. Next Id: 11 | GoogleAssistantAccessoryV1ScreenOutConfig |
| dimensions | Device dimensions. | GoogleAssistantAccessoryV1ScreenOutConfig | Specifies the desired format for the server to use when it returns `screen_out` response. | GoogleAssistantAccessoryV1ScreenOutConfigDimensions |
| fontScaleFactor | The scale factor used to convert Scalable Pixel (SP) units to Density-independent Pixel (DP) units (DP = SP * scale factor). Fonts are measured in units of SP, and on some platforms such as Android the SP to DP scale factor can be affected by the font size a user selects in accessibility settings. | GoogleAssistantAccessoryV1ScreenOutConfig | Specifies the desired format for the server to use when it returns `screen_out` response. | number |
| screenDpi | Dots (pixels) per inch of the screen. | GoogleAssistantAccessoryV1ScreenOutConfigDimensions | This contains physical and logical characteristics about the device (e.g. screen size and DPI, etc). | number |
| screenHeightPx | Height of the device’s screen in pixels. If 0 or not specified, it’s assumed to be the same as screen_width_px. For a square or round screen, it’s recommended to leave this field empty as a bandwidth optimization. | GoogleAssistantAccessoryV1ScreenOutConfigDimensions | This contains physical and logical characteristics about the device (e.g. screen size and DPI, etc). | integer |
| screenShape | The shape of the device’s screen | GoogleAssistantAccessoryV1ScreenOutConfigDimensions | This contains physical and logical characteristics about the device (e.g. screen size and DPI, etc). | String |
| screenWidthPx | Width of the device’s screen in pixels. | GoogleAssistantAccessoryV1ScreenOutConfigDimensions | This contains physical and logical characteristics about the device (e.g. screen size and DPI, etc). | integer |
| alarmId | A string key used as an identifier to this alarm. This key needs to be unique amongst all alarms on the device. The client can choose a mechanism of its choice to ensure this. If the server suggests an alarm_id, the client can either use the suggestion or create a new unique alarm_id of its choosing. | GoogleAssistantEmbeddedV1Alarm | Alarms are clocks that ring at a specified time on one or more days. The client schedules a time to ring based on the date/time pattern. When it rings, it may be rescheduled off the original time by snoozing or it may be replaced by the next occurrence. | String |
| alarmSource | The entity that created this alarm. Note this may be different from the device that reported this alarm. In particular, this field is meant for remote alarms which have been synced to the current device by the Clock app. Synced alarms exist in each device’s Clock app and can be managed by either device; this field indicates their origin. | GoogleAssistantEmbeddedV1Alarm | Alarms are clocks that ring at a specified time on one or more days. The client schedules a time to ring based on the date/time pattern. When it rings, it may be rescheduled off the original time by snoozing or it may be replaced by the next occurrence. | String |
| datePattern | For single alarms: the one date the alarm should next be scheduled for. | GoogleAssistantEmbeddedV1Alarm | Alarms are clocks that ring at a specified time on one or more days. The client schedules a time to ring based on the date/time pattern. When it rings, it may be rescheduled off the original time by snoozing or it may be replaced by the next occurrence. | GoogleTypeDate |
| label | A user-provided name for this alarm. | GoogleAssistantEmbeddedV1Alarm | Alarms are clocks that ring at a specified time on one or more days. The client schedules a time to ring based on the date/time pattern. When it rings, it may be rescheduled off the original time by snoozing or it may be replaced by the next occurrence. | String |
| recurrencePattern | For recurring alarms: a description of the dates when the alarm should recur. | GoogleAssistantEmbeddedV1Alarm | Alarms are clocks that ring at a specified time on one or more days. The client schedules a time to ring based on the date/time pattern. When it rings, it may be rescheduled off the original time by snoozing or it may be replaced by the next occurrence. | GoogleAssistantEmbeddedV1AlarmRecurrence |
| scheduledTime | When SCHEDULED or SNOOZED, the absolute time the alarm will fire next. When SNOOZED, this time includes the additional time added by snoozing the alarm. When FIRING, the absolute time the alarm had been scheduled to fire. When DISABLED, this field is undefined and should be ignored. | GoogleAssistantEmbeddedV1Alarm | Alarms are clocks that ring at a specified time on one or more days. The client schedules a time to ring based on the date/time pattern. When it rings, it may be rescheduled off the original time by snoozing or it may be replaced by the next occurrence. | DateTime |
| status | Describes the part of the lifecycle that an alarm is in. | GoogleAssistantEmbeddedV1Alarm | Alarms are clocks that ring at a specified time on one or more days. The client schedules a time to ring based on the date/time pattern. When it rings, it may be rescheduled off the original time by snoozing or it may be replaced by the next occurrence. | String |
| timePattern | The time of day the alarm should be scheduled for. This value does not change when an alarm enters the SNOOZED state; instead the scheduled_time field should be adjusted to the new alarm time. | GoogleAssistantEmbeddedV1Alarm | Alarms are clocks that ring at a specified time on one or more days. The client schedules a time to ring based on the date/time pattern. When it rings, it may be rescheduled off the original time by snoozing or it may be replaced by the next occurrence. | GoogleTypeTimeOfDay |
| dayOfWeek | Specifies a weekly or daily recurrence. Constraint: The date falls on one of these days of the week, in 0…6 (Sunday…Saturday). Should not be empty. | GoogleAssistantEmbeddedV1AlarmRecurrence | A description of the dates when an alarm should recur. | list(String) |
| alarms | Information about all on-device alarms. | GoogleAssistantEmbeddedV1Alarms | Contains information about on-device alarms for devices that support alarms. | list(GoogleAssistantEmbeddedV1Alarm) |
| snoozeDuration | The amount of time for which alarms should be snoozed. If not specified, the productivity vertical applies a default snooze duration, which may be seen here: http://google3/assistant/verticals/productivity/utils/alarm_utils.cc;l=2734;rcl=415933085 | GoogleAssistantEmbeddedV1Alarms | Contains information about on-device alarms for devices that support alarms. | String |
| stateFetchError | Indicates if an error occurred while fetching alarm state. If this value is missing, it can be assumed that the state fetch was successful. | GoogleAssistantEmbeddedV1Alarms | Contains information about on-device alarms for devices that support alarms. | String |
| deviceModelCapabilities | Device model capabilities from client. | GoogleAssistantEmbeddedV1DeviceModelCapabilitiesOverride | Device model capabilities override from client. | String |
| updateMask | If present, overrides only fields specified in the mask. When doing so, selected message and repeated fields will be replaced rather than merged. Performs a regular proto MergeFrom if no mask is specified. | GoogleAssistantEmbeddedV1DeviceModelCapabilitiesOverride | Device model capabilities override from client. | String |
| fitnessActivities | Information about all on-device activities. | GoogleAssistantEmbeddedV1FitnessActivities | Contains information about on-device fitness activities for devices that support fitness. | list(GoogleAssistantEmbeddedV1FitnessActivity) |
| activityId | Required A string key used as an identifier for this activity. This key needs to be unique amongst all activities on the device. The client can choose a mechanism of its choice to ensure this. If the server suggests an activity_id, the client can either use the suggestion or create a new unique activity_id of its choosing. | GoogleAssistantEmbeddedV1FitnessActivity | Describes a particular fitness activity, its current state, and other data fields associated with that activity (e.g. elapsed time). LINT.IfChange | String |
| mostRecentStartTime | DEPRECATED: The most recent time this activity was switched to the ACTIVE state. | GoogleAssistantEmbeddedV1FitnessActivity | Describes a particular fitness activity, its current state, and other data fields associated with that activity (e.g. elapsed time). LINT.IfChange | DateTime |
| previouslyAccumulatedDuration | DEPRECATED: The total amount of time this activity has spent in the ACTIVE state until the most recent start time. The total time spent active may be computed by summing (now – most_recent_start_time) with previously_accumulated_duration. | GoogleAssistantEmbeddedV1FitnessActivity | Describes a particular fitness activity, its current state, and other data fields associated with that activity (e.g. elapsed time). LINT.IfChange | String |
| state | The current state of this activity. | GoogleAssistantEmbeddedV1FitnessActivity | Describes a particular fitness activity, its current state, and other data fields associated with that activity (e.g. elapsed time). LINT.IfChange | String |
| type | The type of activity being done. | GoogleAssistantEmbeddedV1FitnessActivity | Describes a particular fitness activity, its current state, and other data fields associated with that activity (e.g. elapsed time). LINT.IfChange | String |
| surfaceType | Surface type that the device identifies as. | GoogleAssistantEmbeddedV1SurfaceIdentity | Contains fields to identify the device which sent the request. | String |
| userAgentSuffix | * Fully formed user agent suffix string. | GoogleAssistantEmbeddedV1SurfaceIdentity | Contains fields to identify the device which sent the request. | String |
| expireTime | The time the timer is scheduled to expire. google.protobuf.Timestamp is a Unix epoch time with a granularity of 1 nanosecond. | GoogleAssistantEmbeddedV1Timer | Conceptually, timers are clocks that count down from an initial duration and ring when they reach 0. In practice, as a timer is running, it holds a stable expiration time and computes the remaining duration using the current time. When a timer is paused, it holds a stable remaining duration. | DateTime |
| label | A user-provided name for this timer. | GoogleAssistantEmbeddedV1Timer | Conceptually, timers are clocks that count down from an initial duration and ring when they reach 0. In practice, as a timer is running, it holds a stable expiration time and computes the remaining duration using the current time. When a timer is paused, it holds a stable remaining duration. | String |
| originalDuration | The duration of the timer when it was started. For the ADD_TIME action, this field contains the amount of time to add to the timer with the given timer_id. | GoogleAssistantEmbeddedV1Timer | Conceptually, timers are clocks that count down from an initial duration and ring when they reach 0. In practice, as a timer is running, it holds a stable expiration time and computes the remaining duration using the current time. When a timer is paused, it holds a stable remaining duration. | String |
| remainingDuration | The remaining duration for the timer. | GoogleAssistantEmbeddedV1Timer | Conceptually, timers are clocks that count down from an initial duration and ring when they reach 0. In practice, as a timer is running, it holds a stable expiration time and computes the remaining duration using the current time. When a timer is paused, it holds a stable remaining duration. | String |
| status | Describes the part of the lifecycle a timer is in. | GoogleAssistantEmbeddedV1Timer | Conceptually, timers are clocks that count down from an initial duration and ring when they reach 0. In practice, as a timer is running, it holds a stable expiration time and computes the remaining duration using the current time. When a timer is paused, it holds a stable remaining duration. | String |
| timerId | A string key used as an identifier to this timer. This key needs to be unique amongst all timers on the device. The client can choose a mechanism of its choice to ensure this. If the server suggests a timer_id, the client can either use the suggestion or create a new unique timer_id of its choosing. | GoogleAssistantEmbeddedV1Timer | Conceptually, timers are clocks that count down from an initial duration and ring when they reach 0. In practice, as a timer is running, it holds a stable expiration time and computes the remaining duration using the current time. When a timer is paused, it holds a stable remaining duration. | String |
| stateFetchError | Indicates if an error occurred while fetching timer state. If this value is missing, it can be assumed that the state fetch was successful. | GoogleAssistantEmbeddedV1Timers | Contains information about on-device timers for devices that support timers. | String |
| timers | Information about all on-device timers. | GoogleAssistantEmbeddedV1Timers | Contains information about on-device timers for devices that support timers. | list(GoogleAssistantEmbeddedV1Timer) |
| operationType | Identifies the type of operation. | GoogleCloudContentwarehouseV1AccessControlAction | Represents the action responsible for access control list management operations. | String |
| policy | Represents the new policy from which bindings are added, removed or replaced based on the type of the operation. the policy is limited to a few 10s of KB. | GoogleCloudContentwarehouseV1AccessControlAction | Represents the action responsible for access control list management operations. | GoogleIamV1Policy |
| accessControl | Action triggering access control operations. | GoogleCloudContentwarehouseV1Action | Represents the action triggered by Rule Engine when the rule is true. | GoogleCloudContentwarehouseV1AccessControlAction |
| actionId | ID of the action. Managed internally. | GoogleCloudContentwarehouseV1Action | Represents the action triggered by Rule Engine when the rule is true. | String |
| addToFolder | Action triggering create document link operation. | GoogleCloudContentwarehouseV1Action | Represents the action triggered by Rule Engine when the rule is true. | GoogleCloudContentwarehouseV1AddToFolderAction |
| dataUpdate | Action triggering data update operations. | GoogleCloudContentwarehouseV1Action | Represents the action triggered by Rule Engine when the rule is true. | GoogleCloudContentwarehouseV1DataUpdateAction |
| dataValidation | Action triggering data validation operations. | GoogleCloudContentwarehouseV1Action | Represents the action triggered by Rule Engine when the rule is true. | GoogleCloudContentwarehouseV1DataValidationAction |
| deleteDocumentAction | Action deleting the document. | GoogleCloudContentwarehouseV1Action | Represents the action triggered by Rule Engine when the rule is true. | GoogleCloudContentwarehouseV1DeleteDocumentAction |
| publishToPubSub | Action publish to Pub/Sub operation. | GoogleCloudContentwarehouseV1Action | Represents the action triggered by Rule Engine when the rule is true. | GoogleCloudContentwarehouseV1PublishAction |
| removeFromFolderAction | Action removing a document from a folder. | GoogleCloudContentwarehouseV1Action | Represents the action triggered by Rule Engine when the rule is true. | GoogleCloudContentwarehouseV1RemoveFromFolderAction |
| ruleActionsPairs | List of rule and corresponding actions result. | GoogleCloudContentwarehouseV1ActionExecutorOutput | Represents the output of the Action Executor. | list(GoogleCloudContentwarehouseV1RuleActionsPair) |
| actionId | ID of the action. | GoogleCloudContentwarehouseV1ActionOutput | Represents the result of executing an action. | String |
| actionState | State of an action. | GoogleCloudContentwarehouseV1ActionOutput | Represents the result of executing an action. | String |
| outputMessage | Action execution output message. | GoogleCloudContentwarehouseV1ActionOutput | Represents the result of executing an action. | String |
| folders | Names of the folder under which new document is to be added. Format: projects/{project_number}/locations/{location}/documents/{document_id}. | GoogleCloudContentwarehouseV1AddToFolderAction | Represents the action responsible for adding document under a folder. | list(String) |
| message | The message of the project initialization process. | GoogleCloudContentwarehouseV1beta1InitializeProjectResponse | Response message for projectService.InitializeProject | String |
| state | The state of the project initialization process. | GoogleCloudContentwarehouseV1beta1InitializeProjectResponse | Response message for projectService.InitializeProject | String |
| customizedEntitiesPropertiesConversions | If set, only selected entities will be converted to properties. | GoogleCloudContentwarehouseV1CloudAIDocumentOption | Request Option for processing Cloud AI Document in CW Document. | map |
| enableEntitiesConversions | Whether to convert all the entities to properties. | GoogleCloudContentwarehouseV1CloudAIDocumentOption | Request Option for processing Cloud AI Document in CW Document. | boolean |
| documentLink | Required. Document links associated with the source documents (source_document_id). | GoogleCloudContentwarehouseV1CreateDocumentLinkRequest | Request message for DocumentLinkService.CreateDocumentLink. | GoogleCloudContentwarehouseV1DocumentLink |
| requestMetadata | The meta information collected about the document creator, used to enforce access control for the service. | GoogleCloudContentwarehouseV1CreateDocumentLinkRequest | Request message for DocumentLinkService.CreateDocumentLink. | GoogleCloudContentwarehouseV1RequestMetadata |
| cloudAiDocumentOption | Request Option for processing Cloud AI Document in Document Warehouse. This field offers limited support for mapping entities from Cloud AI Document to Warehouse Document. Please consult with product team before using this field and other available options. | GoogleCloudContentwarehouseV1CreateDocumentRequest | Request message for DocumentService.CreateDocument. | GoogleCloudContentwarehouseV1CloudAIDocumentOption |
| createMask | Field mask for creating Document fields. If mask path is empty, it means all fields are masked. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. | GoogleCloudContentwarehouseV1CreateDocumentRequest | Request message for DocumentService.CreateDocument. | String |
| document | Required. The document to create. | GoogleCloudContentwarehouseV1CreateDocumentRequest | Request message for DocumentService.CreateDocument. | GoogleCloudContentwarehouseV1Document |
| policy | Default document policy during creation. This refers to an Identity and Access (IAM) policy, which specifies access controls for the Document. Conditions defined in the policy will be ignored. | GoogleCloudContentwarehouseV1CreateDocumentRequest | Request message for DocumentService.CreateDocument. | GoogleIamV1Policy |
| requestMetadata | The meta information collected about the end user, used to enforce access control for the service. | GoogleCloudContentwarehouseV1CreateDocumentRequest | Request message for DocumentService.CreateDocument. | GoogleCloudContentwarehouseV1RequestMetadata |
| document | Document created after executing create request. | GoogleCloudContentwarehouseV1CreateDocumentResponse | Response message for DocumentService.CreateDocument. | GoogleCloudContentwarehouseV1Document |
| longRunningOperations | post-processing LROs | GoogleCloudContentwarehouseV1CreateDocumentResponse | Response message for DocumentService.CreateDocument. | list(GoogleLongrunningOperation) |
| metadata | Additional information for the API invocation, such as the request tracking id. | GoogleCloudContentwarehouseV1CreateDocumentResponse | Response message for DocumentService.CreateDocument. | GoogleCloudContentwarehouseV1ResponseMetadata |
| ruleEngineOutput | Output from Rule Engine recording the rule evaluator and action executor’s output. Refer format in: google/cloud/contentwarehouse/v1/rule_engine.proto | GoogleCloudContentwarehouseV1CreateDocumentResponse | Response message for DocumentService.CreateDocument. | GoogleCloudContentwarehouseV1RuleEngineOutput |
| weightedSchemaProperties | List of schema and property name. Allows a maximum of 10 schemas to be specified for relevance boosting. | GoogleCloudContentwarehouseV1CustomWeightsMetadata | To support the custom weighting across document schemas. | list(GoogleCloudContentwarehouseV1WeightedSchemaProperty) |
| entries | Map of (K, V) -> (valid name of the field, new value of the field) E.g., (“age”, “60”) entry triggers update of field age with a value of 60. If the field is not present then new entry is added. During update action execution, value strings will be casted to appropriate types. | GoogleCloudContentwarehouseV1DataUpdateAction | Represents the action responsible for properties update operations. | map |
| conditions | Map of (K, V) -> (field, string condition to be evaluated on the field) E.g., (“age”, “age > 18 && age < 60") entry triggers validation of field age with the given condition. Map entries will be ANDed during validation. | GoogleCloudContentwarehouseV1DataValidationAction | Represents the action responsible for data validation operations. | map |
| values | List of datetime values. Both OffsetDateTime and ZonedDateTime are supported. | GoogleCloudContentwarehouseV1DateTimeArray | DateTime values. | list(GoogleTypeDateTime) |
| enableHardDelete | Boolean field to select between hard vs soft delete options. Set ‘true’ for ‘hard delete’ and ‘false’ for ‘soft delete’. | GoogleCloudContentwarehouseV1DeleteDocumentAction | Represents the action responsible for deleting the document. | boolean |
| requestMetadata | The meta information collected about the document creator, used to enforce access control for the service. | GoogleCloudContentwarehouseV1DeleteDocumentLinkRequest | Request message for DocumentLinkService.DeleteDocumentLink. | GoogleCloudContentwarehouseV1RequestMetadata |
| requestMetadata | The meta information collected about the end user, used to enforce access control for the service. | GoogleCloudContentwarehouseV1DeleteDocumentRequest | Request message for DocumentService.DeleteDocument. | GoogleCloudContentwarehouseV1RequestMetadata |
| cloudAiDocument | Document AI format to save the structured content, including OCR. | GoogleCloudContentwarehouseV1Document | Defines the structure for content warehouse document proto. | GoogleCloudDocumentaiV1Document |
| contentCategory | Indicates the category (image, audio, video etc.) of the original content. | GoogleCloudContentwarehouseV1Document | Defines the structure for content warehouse document proto. | String |
| createTime | Output only. The time when the document is created. | GoogleCloudContentwarehouseV1Document | Defines the structure for content warehouse document proto. | DateTime |
| creator | The user who creates the document. | GoogleCloudContentwarehouseV1Document | Defines the structure for content warehouse document proto. | String |
| displayName | Required. Display name of the document given by the user. This name will be displayed in the UI. Customer can populate this field with the name of the document. This differs from the ‘title’ field as ‘title’ is optional and stores the top heading in the document. | GoogleCloudContentwarehouseV1Document | Defines the structure for content warehouse document proto. | String |
| displayUri | Uri to display the document, for example, in the UI. | GoogleCloudContentwarehouseV1Document | Defines the structure for content warehouse document proto. | String |
| dispositionTime | Output only. If linked to a Collection with RetentionPolicy, the date when the document becomes mutable. | GoogleCloudContentwarehouseV1Document | Defines the structure for content warehouse document proto. | DateTime |
| documentSchemaName | The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. | GoogleCloudContentwarehouseV1Document | Defines the structure for content warehouse document proto. | String |
| inlineRawDocument | Raw document content. | GoogleCloudContentwarehouseV1Document | Defines the structure for content warehouse document proto. | String |
| legalHold | Output only. Indicates if the document has a legal hold on it. | GoogleCloudContentwarehouseV1Document | Defines the structure for content warehouse document proto. | boolean |
| name | The resource name of the document. Format: projects/{project_number}/locations/{location}/documents/{document_id}. The name is ignored when creating a document. | GoogleCloudContentwarehouseV1Document | Defines the structure for content warehouse document proto. | String |
| plainText | Other document format, such as PPTX, XLXS | GoogleCloudContentwarehouseV1Document | Defines the structure for content warehouse document proto. | String |
| properties | List of values that are user supplied metadata. | GoogleCloudContentwarehouseV1Document | Defines the structure for content warehouse document proto. | list(GoogleCloudContentwarehouseV1Property) |
| rawDocumentFileType | This is used when DocAI was not used to load the document and parsing/ extracting is needed for the inline_raw_document. For example, if inline_raw_document is the byte representation of a PDF file, then this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF. | GoogleCloudContentwarehouseV1Document | Defines the structure for content warehouse document proto. | String |
| rawDocumentPath | Raw document file in Cloud Storage path. | GoogleCloudContentwarehouseV1Document | Defines the structure for content warehouse document proto. | String |
| referenceId | The reference ID set by customers. Must be unique per project and location. | GoogleCloudContentwarehouseV1Document | Defines the structure for content warehouse document proto. | String |
| textExtractionDisabled | If true, text extraction will not be performed. | GoogleCloudContentwarehouseV1Document | Defines the structure for content warehouse document proto. | boolean |
| textExtractionEnabled | If true, text extraction will be performed. | GoogleCloudContentwarehouseV1Document | Defines the structure for content warehouse document proto. | boolean |
| title | Title that describes the document. This can be the top heading or text that describes the document. | GoogleCloudContentwarehouseV1Document | Defines the structure for content warehouse document proto. | String |
| updateTime | Output only. The time when the document is last updated. | GoogleCloudContentwarehouseV1Document | Defines the structure for content warehouse document proto. | DateTime |
| updater | The user who lastly updates the document. | GoogleCloudContentwarehouseV1Document | Defines the structure for content warehouse document proto. | String |
| createTime | Output only. The time when the documentLink is created. | GoogleCloudContentwarehouseV1DocumentLink | A document-link between source and target document. | DateTime |
| description | Description of this document-link. | GoogleCloudContentwarehouseV1DocumentLink | A document-link between source and target document. | String |
| name | Name of this document-link. It is required that the parent derived form the name to be consistent with the source document reference. Otherwise an exception will be thrown. Format: projects/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}. | GoogleCloudContentwarehouseV1DocumentLink | A document-link between source and target document. | String |
| sourceDocumentReference | Document references of the source document. | GoogleCloudContentwarehouseV1DocumentLink | A document-link between source and target document. | GoogleCloudContentwarehouseV1DocumentReference |
| state | The state of the documentlink. If target node has been deleted, the link is marked as invalid. Removing a source node will result in removal of all associated links. | GoogleCloudContentwarehouseV1DocumentLink | A document-link between source and target document. | String |
| targetDocumentReference | Document references of the target document. | GoogleCloudContentwarehouseV1DocumentLink | A document-link between source and target document. | GoogleCloudContentwarehouseV1DocumentReference |
| updateTime | Output only. The time when the documentLink is last updated. | GoogleCloudContentwarehouseV1DocumentLink | A document-link between source and target document. | DateTime |
| customPropertyFilter | This filter specifies a structured syntax to match against the [PropertyDefinition].is_filterable marked as `true`. The syntax for this expression is a subset of SQL syntax. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the left of the operator is a property name and the right of the operator is a number or a quoted string. You must escape backslash (\\\\) and quote (\\”) characters. Supported functions are `LOWER([property_name])` to perform a case insensitive match and `EMPTY([property_name])` to filter on the existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, “((A AND B AND C) OR NOT D) AND E”), a maximum of 100 comparisons or functions are allowed in the expression. The expression must be < 6000 bytes in length. Sample Query: `(LOWER(driving_license)="class \\"a\\"" OR EMPTY(driving_license)) AND driving_years > 10` | GoogleCloudContentwarehouseV1DocumentQuery | String | |
| customWeightsMetadata | To support the custom weighting across document schemas, customers need to provide the properties to be used to boost the ranking in the search request. For a search query with CustomWeightsMetadata specified, only the RetrievalImportance for the properties in the CustomWeightsMetadata will be honored. | GoogleCloudContentwarehouseV1DocumentQuery | GoogleCloudContentwarehouseV1CustomWeightsMetadata | |
| documentCreatorFilter | The exact creator(s) of the documents to search against. If a value isn’t specified, documents within the search results are associated with any creator. If multiple values are specified, documents within the search results may be associated with any of the specified creators. | GoogleCloudContentwarehouseV1DocumentQuery | list(String) | |
| documentNameFilter | Search the documents in the list. Format: projects/{project_number}/locations/{location}/documents/{document_id}. | GoogleCloudContentwarehouseV1DocumentQuery | list(String) | |
| documentSchemaNames | This filter specifies the exact document schema Document.document_schema_name of the documents to search against. If a value isn’t specified, documents within the search results are associated with any schema. If multiple values are specified, documents within the search results may be associated with any of the specified schemas. At most 20 document schema names are allowed. | GoogleCloudContentwarehouseV1DocumentQuery | list(String) | |
| fileTypeFilter | This filter specifies the types of files to return: ALL, FOLDER, or FILE. If FOLDER or FILE is specified, then only either folders or files will be returned, respectively. If ALL is specified, both folders and files will be returned. If no value is specified, ALL files will be returned. | GoogleCloudContentwarehouseV1DocumentQuery | GoogleCloudContentwarehouseV1FileTypeFilter | |
| folderNameFilter | Search all the documents under this specified folder. Format: projects/{project_number}/locations/{location}/documents/{document_id}. | GoogleCloudContentwarehouseV1DocumentQuery | String | |
| isNlQuery | Experimental, do not use. If the query is a natural language question. False by default. If true, then the question-answering feature will be used instead of search, and `result_count` in SearchDocumentsRequest must be set. In addition, all other input fields related to search (pagination, histograms, etc.) will be ignored. | GoogleCloudContentwarehouseV1DocumentQuery | boolean | |
| propertyFilter | This filter specifies a structured syntax to match against the PropertyDefinition.is_filterable marked as `true`. The relationship between the PropertyFilters is OR. | GoogleCloudContentwarehouseV1DocumentQuery | list(GoogleCloudContentwarehouseV1PropertyFilter) | |
| query | The query string that matches against the full text of the document and the searchable properties. The query partially supports [Google AIP style syntax](https://google.aip.dev/160). Specifically, the query supports literals, logical operators, negation operators, comparison operators, and functions. Literals: A bare literal value (examples: “42”, “Hugo”) is a value to be matched against. It searches over the full text of the document and the searchable properties. Logical operators: “AND”, “and”, “OR”, and “or” are binary logical operators (example: “engineer OR developer”). Negation operators: “NOT” and “!” are negation operators (example: “NOT software”). Comparison operators: support the binary comparison operators =, !=, <, >, <= and >= for string, numeric, enum, boolean. Also support like operator `~~` for string. It provides semantic search functionality by parsing, stemming and doing synonyms expansion against the input query. To specify a property in the query, the left hand side expression in the comparison must be the property ID including the parent. The right hand side must be literals. For example: “\\”projects/123/locations/us\\”.property_a < 1" matches results whose "property_a" is less than 1 in project 123 and us location. The literals and comparison expression can be connected in a single query (example: "software engineer \\"projects/123/locations/us\\".salary > 100″). Functions: supported functions are `LOWER([property_name])` to perform a case insensitive match and `EMPTY([property_name])` to filter on the existence of a key. Support nested expressions connected using parenthesis and logical operators. The default logical operators is `AND` if there is no operators between expressions. The query can be used with other filters e.g. `time_filters` and `folder_name_filter`. They are connected with `AND` operator under the hood. The maximum number of allowed characters is 255. | GoogleCloudContentwarehouseV1DocumentQuery | String | |
| queryContext | For custom synonyms. Customers provide the synonyms based on context. One customer can provide multiple set of synonyms based on different context. The search query will be expanded based on the custom synonyms of the query context set. By default, no custom synonyms wll be applied if no query context is provided. It is not supported for CMEK compliant deployment. | GoogleCloudContentwarehouseV1DocumentQuery | list(String) | |
| timeFilters | Documents created/updated within a range specified by this filter are searched against. | GoogleCloudContentwarehouseV1DocumentQuery | list(GoogleCloudContentwarehouseV1TimeFilter) | |
| createTime | Output only. The time when the document is created. | GoogleCloudContentwarehouseV1DocumentReference | References to the documents. | DateTime |
| deleteTime | Output only. The time when the document is deleted. | GoogleCloudContentwarehouseV1DocumentReference | References to the documents. | DateTime |
| displayName | display_name of the referenced document; this name does not need to be consistent to the display_name in the Document proto, depending on the ACL constraint. | GoogleCloudContentwarehouseV1DocumentReference | References to the documents. | String |
| documentIsFolder | The document type of the document being referenced. | GoogleCloudContentwarehouseV1DocumentReference | References to the documents. | boolean |
| documentIsLegalHoldFolder | Document is a folder with legal hold. | GoogleCloudContentwarehouseV1DocumentReference | References to the documents. | boolean |
| documentIsRetentionFolder | Document is a folder with retention policy. | GoogleCloudContentwarehouseV1DocumentReference | References to the documents. | boolean |
| documentName | Required. Name of the referenced document. | GoogleCloudContentwarehouseV1DocumentReference | References to the documents. | String |
| snippet | Stores the subset of the referenced document’s content. This is useful to allow user peek the information of the referenced document. | GoogleCloudContentwarehouseV1DocumentReference | References to the documents. | String |
| updateTime | Output only. The time when the document is last updated. | GoogleCloudContentwarehouseV1DocumentReference | References to the documents. | DateTime |
| createTime | Output only. The time when the document schema is created. | GoogleCloudContentwarehouseV1DocumentSchema | A document schema used to define document structure. | DateTime |
| description | Schema description. | GoogleCloudContentwarehouseV1DocumentSchema | A document schema used to define document structure. | String |
| displayName | Required. Name of the schema given by the user. Must be unique per project. | GoogleCloudContentwarehouseV1DocumentSchema | A document schema used to define document structure. | String |
| documentIsFolder | Document Type, true refers the document is a folder, otherwise it is a typical document. | GoogleCloudContentwarehouseV1DocumentSchema | A document schema used to define document structure. | boolean |
| name | The resource name of the document schema. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. The name is ignored when creating a document schema. | GoogleCloudContentwarehouseV1DocumentSchema | A document schema used to define document structure. | String |
| propertyDefinitions | Document details. | GoogleCloudContentwarehouseV1DocumentSchema | A document schema used to define document structure. | list(GoogleCloudContentwarehouseV1PropertyDefinition) |
| updateTime | Output only. The time when the document schema is last updated. | GoogleCloudContentwarehouseV1DocumentSchema | A document schema used to define document structure. | DateTime |
| values | List of enum values. | GoogleCloudContentwarehouseV1EnumArray | Enum values. | list(String) |
| possibleValues | Required. List of possible enum values. | GoogleCloudContentwarehouseV1EnumTypeOptions | Configurations for an enum/categorical property. | list(String) |
| validationCheckDisabled | Make sure the Enum property value provided in the document is in the possile value list during document creation. The validation check runs by default. | GoogleCloudContentwarehouseV1EnumTypeOptions | Configurations for an enum/categorical property. | boolean |
| value | String value of the enum field. This must match defined set of enums in document schema using EnumTypeOptions. | GoogleCloudContentwarehouseV1EnumValue | Represents the string value of the enum field. | String |
| docAiDataset | Optional. The CDW dataset resource name. This field is optional. If not set, the documents will be exported to Cloud Storage only. Format: projects/{project}/locations/{location}/processors/{processor}/dataset | GoogleCloudContentwarehouseV1ExportToCdwPipeline | The configuration of exporting documents from the Document Warehouse to CDW pipeline. | String |
| documents | The list of all the resource names of the documents to be processed. Format: projects/{project_number}/locations/{location}/documents/{document_id}. | GoogleCloudContentwarehouseV1ExportToCdwPipeline | The configuration of exporting documents from the Document Warehouse to CDW pipeline. | list(String) |
| exportFolderPath | The Cloud Storage folder path used to store the exported documents before being sent to CDW. Format: `gs:///`. | GoogleCloudContentwarehouseV1ExportToCdwPipeline | The configuration of exporting documents from the Document Warehouse to CDW pipeline. | String |
| trainingSplitRatio | Ratio of training dataset split. When importing into Document AI Workbench, documents will be automatically split into training and test split category with the specified ratio. This field is required if doc_ai_dataset is set. | GoogleCloudContentwarehouseV1ExportToCdwPipeline | The configuration of exporting documents from the Document Warehouse to CDW pipeline. | number |
| projectOwner | For Get Project ACL only. Authorization check for end user will be ignored when project_owner=true. | GoogleCloudContentwarehouseV1FetchAclRequest | Request message for DocumentService.FetchAcl | boolean |
| requestMetadata | The meta information collected about the end user, used to enforce access control for the service. | GoogleCloudContentwarehouseV1FetchAclRequest | Request message for DocumentService.FetchAcl | GoogleCloudContentwarehouseV1RequestMetadata |
| metadata | Additional information for the API invocation, such as the request tracking id. | GoogleCloudContentwarehouseV1FetchAclResponse | Response message for DocumentService.FetchAcl. | GoogleCloudContentwarehouseV1ResponseMetadata |
| policy | The IAM policy. | GoogleCloudContentwarehouseV1FetchAclResponse | Response message for DocumentService.FetchAcl. | GoogleIamV1Policy |
| fileType | The type of files to return. | GoogleCloudContentwarehouseV1FileTypeFilter | Filter for the specific types of documents returned. | String |
| values | List of float values. | GoogleCloudContentwarehouseV1FloatArray | Float values. | list(number) |
| inputPath | The input Cloud Storage folder. All files under this folder will be imported to Document Warehouse. Format: `gs:///`. | GoogleCloudContentwarehouseV1GcsIngestPipeline | The configuration of the Cloud Storage Ingestion pipeline. | String |
| pipelineConfig | Optional. The config for the Cloud Storage Ingestion pipeline. It provides additional customization options to run the pipeline and can be skipped if it is not applicable. | GoogleCloudContentwarehouseV1GcsIngestPipeline | The configuration of the Cloud Storage Ingestion pipeline. | GoogleCloudContentwarehouseV1IngestPipelineConfig |
| processorType | The Doc AI processor type name. Only used when the format of ingested files is Doc AI Document proto format. | GoogleCloudContentwarehouseV1GcsIngestPipeline | The configuration of the Cloud Storage Ingestion pipeline. | String |
| schemaName | The Document Warehouse schema resource name. All documents processed by this pipeline will use this schema. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. | GoogleCloudContentwarehouseV1GcsIngestPipeline | The configuration of the Cloud Storage Ingestion pipeline. | String |
| skipIngestedDocuments | The flag whether to skip ingested documents. If it is set to true, documents in Cloud Storage contains key “status” with value “status=ingested” in custom metadata will be skipped to ingest. | GoogleCloudContentwarehouseV1GcsIngestPipeline | The configuration of the Cloud Storage Ingestion pipeline. | boolean |
| extractProcessorInfos | The extract processors information. One matched extract processor will be used to process documents based on the classify processor result. If no classify processor is specified, the first extract processor will be used. | GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline | The configuration of the Cloud Storage Ingestion with DocAI Processors pipeline. | list(GoogleCloudContentwarehouseV1ProcessorInfo) |
| inputPath | The input Cloud Storage folder. All files under this folder will be imported to Document Warehouse. Format: `gs:///`. | GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline | The configuration of the Cloud Storage Ingestion with DocAI Processors pipeline. | String |
| pipelineConfig | Optional. The config for the Cloud Storage Ingestion with DocAI Processors pipeline. It provides additional customization options to run the pipeline and can be skipped if it is not applicable. | GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline | The configuration of the Cloud Storage Ingestion with DocAI Processors pipeline. | GoogleCloudContentwarehouseV1IngestPipelineConfig |
| processorResultsFolderPath | The Cloud Storage folder path used to store the raw results from processors. Format: `gs:///`. | GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline | The configuration of the Cloud Storage Ingestion with DocAI Processors pipeline. | String |
| skipIngestedDocuments | The flag whether to skip ingested documents. If it is set to true, documents in Cloud Storage contains key “status” with value “status=ingested” in custom metadata will be skipped to ingest. | GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline | The configuration of the Cloud Storage Ingestion with DocAI Processors pipeline. | boolean |
| splitClassifyProcessorInfo | The split and classify processor information. The split and classify result will be used to find a matched extract processor. | GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline | The configuration of the Cloud Storage Ingestion with DocAI Processors pipeline. | GoogleCloudContentwarehouseV1ProcessorInfo |
| requestMetadata | The meta information collected about the end user, used to enforce access control for the service. | GoogleCloudContentwarehouseV1GetDocumentRequest | Request message for DocumentService.GetDocument. | GoogleCloudContentwarehouseV1RequestMetadata |
| filters | Optional. Filter the result of histogram query by the property names. It only works with histogram query count(‘FilterableProperties’). It is an optional. It will perform histogram on all the property names for all the document schemas. Setting this field will have a better performance. | GoogleCloudContentwarehouseV1HistogramQuery | The histogram request. | GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter |
| histogramQuery | An expression specifies a histogram request against matching documents for searches. See SearchDocumentsRequest.histogram_queries for details about syntax. | GoogleCloudContentwarehouseV1HistogramQuery | The histogram request. | String |
| requirePreciseResultSize | Controls if the histogram query requires the return of a precise count. Enable this flag may adversely impact performance. Defaults to true. | GoogleCloudContentwarehouseV1HistogramQuery | The histogram request. | boolean |
| documentSchemas | This filter specifies the exact document schema(s) Document.document_schema_name to run histogram query against. It is optional. It will perform histogram for property names for all the document schemas if it is not set. At most 10 document schema names are allowed. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. | GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter | list(String) | |
| propertyNames | It is optional. It will perform histogram for all the property names if it is not set. The properties need to be defined with the is_filterable flag set to true and the name of the property should be in the format: “schemaId.propertyName”. The property needs to be defined in the schema. Example: the schema id is abc. Then the name of property for property MORTGAGE_TYPE will be “abc.MORTGAGE_TYPE”. | GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter | list(String) | |
| yAxis | By default, the y_axis is HISTOGRAM_YAXIS_DOCUMENT if this field is not set. | GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter | String | |
| histogram | A map from the values of the facet associated with distinct values to the number of matching entries with corresponding value. The key format is: * (for string histogram) string values stored in the field. | GoogleCloudContentwarehouseV1HistogramQueryResult | Histogram result that matches HistogramQuery specified in searches. | map |
| histogramQuery | Requested histogram expression. | GoogleCloudContentwarehouseV1HistogramQueryResult | Histogram result that matches HistogramQuery specified in searches. | String |
| cloudFunction | The Cloud Function resource name. The Cloud Function needs to live inside consumer project and is accessible to Document AI Warehouse P4SA. Only Cloud Functions V2 is supported. Cloud function execution should complete within 5 minutes or this file ingestion may fail due to timeout. Format: `https://{region}-{project_id}.cloudfunctions.net/{cloud_function}` The following keys are available the request json payload. * display_name * properties * plain_text * reference_id * document_schema_name * raw_document_path * raw_document_file_type The following keys from the cloud function json response payload will be ingested to the Document AI Warehouse as part of Document proto content and/or related information. The original values will be overridden if any key is present in the response. * display_name * properties * plain_text * document_acl_policy * folder | GoogleCloudContentwarehouseV1IngestPipelineConfig | The ingestion pipeline config. | String |
| documentAclPolicy | The document level acl policy config. This refers to an Identity and Access (IAM) policy, which specifies access controls for all documents ingested by the pipeline. The role and members under the policy needs to be specified. The following roles are supported for document level acl control: * roles/contentwarehouse.documentAdmin * roles/contentwarehouse.documentEditor * roles/contentwarehouse.documentViewer The following members are supported for document level acl control: * user:[email protected] * group:[email protected] Note that for documents searched with LLM, only single level user or group acl check is supported. | GoogleCloudContentwarehouseV1IngestPipelineConfig | The ingestion pipeline config. | GoogleIamV1Policy |
| enableDocumentTextExtraction | The document text extraction enabled flag. If the flag is set to true, DWH will perform text extraction on the raw document. | GoogleCloudContentwarehouseV1IngestPipelineConfig | The ingestion pipeline config. | boolean |
| folder | Optional. The name of the folder to which all ingested documents will be linked during ingestion process. Format is `projects/{project}/locations/{location}/documents/{folder_id}` | GoogleCloudContentwarehouseV1IngestPipelineConfig | The ingestion pipeline config. | String |
| accessControlMode | Required. The access control mode for accessing the customer data | GoogleCloudContentwarehouseV1InitializeProjectRequest | Request message for projectService.InitializeProject | String |
| databaseType | Required. The type of database used to store customer data | GoogleCloudContentwarehouseV1InitializeProjectRequest | Request message for projectService.InitializeProject | String |
| documentCreatorDefaultRole | Optional. The default role for the person who create a document. | GoogleCloudContentwarehouseV1InitializeProjectRequest | Request message for projectService.InitializeProject | String |
| enableCalUserEmailLogging | Optional. Whether to enable CAL user email logging. | GoogleCloudContentwarehouseV1InitializeProjectRequest | Request message for projectService.InitializeProject | boolean |
| kmsKey | Optional. The KMS key used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key is left empty, no encryption will be enforced. | GoogleCloudContentwarehouseV1InitializeProjectRequest | Request message for projectService.InitializeProject | String |
| message | The message of the project initialization process. | GoogleCloudContentwarehouseV1InitializeProjectResponse | Response message for projectService.InitializeProject | String |
| state | The state of the project initialization process. | GoogleCloudContentwarehouseV1InitializeProjectResponse | Response message for projectService.InitializeProject | String |
| values | List of integer values. | GoogleCloudContentwarehouseV1IntegerArray | Integer values. | list(integer) |
| error | Validation error on a parsed expression. | GoogleCloudContentwarehouseV1InvalidRule | A triggered rule that failed the validation check(s) after parsing. | String |
| rule | Triggered rule. | GoogleCloudContentwarehouseV1InvalidRule | A triggered rule that failed the validation check(s) after parsing. | GoogleCloudContentwarehouseV1Rule |
| documentSchemas | The document schemas from the specified parent. | GoogleCloudContentwarehouseV1ListDocumentSchemasResponse | Response message for DocumentSchemaService.ListDocumentSchemas. | list(GoogleCloudContentwarehouseV1DocumentSchema) |
| nextPageToken | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | GoogleCloudContentwarehouseV1ListDocumentSchemasResponse | Response message for DocumentSchemaService.ListDocumentSchemas. | String |
| pageSize | The maximum number of document-links to return. The service may return fewer than this value. If unspecified, at most 50 document-links will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. | GoogleCloudContentwarehouseV1ListLinkedSourcesRequest | Response message for DocumentLinkService.ListLinkedSources. | integer |
| pageToken | A page token, received from a previous `ListLinkedSources` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListLinkedSources` must match the call that provided the page token. | GoogleCloudContentwarehouseV1ListLinkedSourcesRequest | Response message for DocumentLinkService.ListLinkedSources. | String |
| requestMetadata | The meta information collected about the document creator, used to enforce access control for the service. | GoogleCloudContentwarehouseV1ListLinkedSourcesRequest | Response message for DocumentLinkService.ListLinkedSources. | GoogleCloudContentwarehouseV1RequestMetadata |
| documentLinks | Source document-links. | GoogleCloudContentwarehouseV1ListLinkedSourcesResponse | Response message for DocumentLinkService.ListLinkedSources. | list(GoogleCloudContentwarehouseV1DocumentLink) |
| nextPageToken | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | GoogleCloudContentwarehouseV1ListLinkedSourcesResponse | Response message for DocumentLinkService.ListLinkedSources. | String |
| requestMetadata | The meta information collected about the document creator, used to enforce access control for the service. | GoogleCloudContentwarehouseV1ListLinkedTargetsRequest | Request message for DocumentLinkService.ListLinkedTargets. | GoogleCloudContentwarehouseV1RequestMetadata |
| documentLinks | Target document-links. | GoogleCloudContentwarehouseV1ListLinkedTargetsResponse | Response message for DocumentLinkService.ListLinkedTargets. | list(GoogleCloudContentwarehouseV1DocumentLink) |
| nextPageToken | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | GoogleCloudContentwarehouseV1ListLinkedTargetsResponse | Response message for DocumentLinkService.ListLinkedTargets. | String |
| nextPageToken | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | GoogleCloudContentwarehouseV1ListRuleSetsResponse | Response message for RuleSetService.ListRuleSets. | String |
| ruleSets | The rule sets from the specified parent. | GoogleCloudContentwarehouseV1ListRuleSetsResponse | Response message for RuleSetService.ListRuleSets. | list(GoogleCloudContentwarehouseV1RuleSet) |
| nextPageToken | A page token, received from a previous `ListSynonymSets` call. Provide this to retrieve the subsequent page. | GoogleCloudContentwarehouseV1ListSynonymSetsResponse | Response message for SynonymSetService.ListSynonymSets. | String |
| synonymSets | The synonymSets from the specified parent. | GoogleCloudContentwarehouseV1ListSynonymSetsResponse | Response message for SynonymSetService.ListSynonymSets. | list(GoogleCloudContentwarehouseV1SynonymSet) |
| collectionId | The collection the document connects to. | GoogleCloudContentwarehouseV1LockDocumentRequest | Request message for DocumentService.LockDocument. | String |
| lockingUser | The user information who locks the document. | GoogleCloudContentwarehouseV1LockDocumentRequest | Request message for DocumentService.LockDocument. | GoogleCloudContentwarehouseV1UserInfo |
| replaceMessageFields | When merging message fields, the default behavior is to merge the content of two message fields together. If you instead want to use the field from the source message to replace the corresponding field in the destination message, set this flag to true. When this flag is set, specified submessage fields that are missing in source will be cleared in destination. | GoogleCloudContentwarehouseV1MergeFieldsOptions | Options for merging updated fields. | boolean |
| replaceRepeatedFields | When merging repeated fields, the default behavior is to append entries from the source repeated field to the destination repeated field. If you instead want to keep only the entries from the source repeated field, set this flag to true. If you want to replace a repeated field within a message field on the destination message, you must set both replace_repeated_fields and replace_message_fields to true, otherwise the repeated fields will be appended. | GoogleCloudContentwarehouseV1MergeFieldsOptions | Options for merging updated fields. | boolean |
| documentType | The processor will process the documents with this document type. | GoogleCloudContentwarehouseV1ProcessorInfo | The DocAI processor information. | String |
| processorName | The processor resource name. Format is `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` | GoogleCloudContentwarehouseV1ProcessorInfo | The DocAI processor information. | String |
| schemaName | The Document schema resource name. All documents processed by this processor will use this schema. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. | GoogleCloudContentwarehouseV1ProcessorInfo | The DocAI processor information. | String |
| documents | The list of all the resource names of the documents to be processed. Format: projects/{project_number}/locations/{location}/documents/{document_id}. | GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline | The configuration of processing documents in Document Warehouse with DocAi processors pipeline. | list(String) |
| exportFolderPath | The Cloud Storage folder path used to store the exported documents before being sent to CDW. Format: `gs:///`. | GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline | The configuration of processing documents in Document Warehouse with DocAi processors pipeline. | String |
| processorInfo | The CDW processor information. | GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline | The configuration of processing documents in Document Warehouse with DocAi processors pipeline. | GoogleCloudContentwarehouseV1ProcessorInfo |
| processorResultsFolderPath | The Cloud Storage folder path used to store the raw results from processors. Format: `gs:///`. | GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline | The configuration of processing documents in Document Warehouse with DocAi processors pipeline. | String |
| accessControlMode | Access control mode. | GoogleCloudContentwarehouseV1ProjectStatus | Status of a project, including the project state, dbType, aclMode and etc. | String |
| databaseType | Database type. | GoogleCloudContentwarehouseV1ProjectStatus | Status of a project, including the project state, dbType, aclMode and etc. | String |
| documentCreatorDefaultRole | The default role for the person who create a document. | GoogleCloudContentwarehouseV1ProjectStatus | Status of a project, including the project state, dbType, aclMode and etc. | String |
| location | The location of the queried project. | GoogleCloudContentwarehouseV1ProjectStatus | Status of a project, including the project state, dbType, aclMode and etc. | String |
| qaEnabled | If the qa is enabled on this project. | GoogleCloudContentwarehouseV1ProjectStatus | Status of a project, including the project state, dbType, aclMode and etc. | boolean |
| state | State of the project. | GoogleCloudContentwarehouseV1ProjectStatus | Status of a project, including the project state, dbType, aclMode and etc. | String |
| dateTimeValues | Date time property values. It is not supported by CMEK compliant deployment. | GoogleCloudContentwarehouseV1Property | Property of a document. | GoogleCloudContentwarehouseV1DateTimeArray |
| enumValues | Enum property values. | GoogleCloudContentwarehouseV1Property | Property of a document. | GoogleCloudContentwarehouseV1EnumArray |
| floatValues | Float property values. | GoogleCloudContentwarehouseV1Property | Property of a document. | GoogleCloudContentwarehouseV1FloatArray |
| integerValues | Integer property values. | GoogleCloudContentwarehouseV1Property | Property of a document. | GoogleCloudContentwarehouseV1IntegerArray |
| mapProperty | Map property values. | GoogleCloudContentwarehouseV1Property | Property of a document. | GoogleCloudContentwarehouseV1MapProperty |
| name | Required. Must match the name of a PropertyDefinition in the DocumentSchema. | GoogleCloudContentwarehouseV1Property | Property of a document. | String |
| propertyValues | Nested structured data property values. | GoogleCloudContentwarehouseV1Property | Property of a document. | GoogleCloudContentwarehouseV1PropertyArray |
| textValues | String/text property values. | GoogleCloudContentwarehouseV1Property | Property of a document. | GoogleCloudContentwarehouseV1TextArray |
| timestampValues | Timestamp property values. It is not supported by CMEK compliant deployment. | GoogleCloudContentwarehouseV1Property | Property of a document. | GoogleCloudContentwarehouseV1TimestampArray |
| properties | List of property values. | GoogleCloudContentwarehouseV1PropertyArray | Property values. | list(GoogleCloudContentwarehouseV1Property) |
| dateTimeTypeOptions | Date time property. It is not supported by CMEK compliant deployment. | GoogleCloudContentwarehouseV1PropertyDefinition | Defines the metadata for a schema property. | GoogleCloudContentwarehouseV1DateTimeTypeOptions |
| displayName | The display-name for the property, used for front-end. | GoogleCloudContentwarehouseV1PropertyDefinition | Defines the metadata for a schema property. | String |
| enumTypeOptions | Enum/categorical property. | GoogleCloudContentwarehouseV1PropertyDefinition | Defines the metadata for a schema property. | GoogleCloudContentwarehouseV1EnumTypeOptions |
| floatTypeOptions | Float property. | GoogleCloudContentwarehouseV1PropertyDefinition | Defines the metadata for a schema property. | GoogleCloudContentwarehouseV1FloatTypeOptions |
| integerTypeOptions | Integer property. | GoogleCloudContentwarehouseV1PropertyDefinition | Defines the metadata for a schema property. | GoogleCloudContentwarehouseV1IntegerTypeOptions |
| isFilterable | Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable. | GoogleCloudContentwarehouseV1PropertyDefinition | Defines the metadata for a schema property. | boolean |
| isMetadata | Whether the property is user supplied metadata. This out-of-the box placeholder setting can be used to tag derived properties. Its value and interpretation logic should be implemented by API user. | GoogleCloudContentwarehouseV1PropertyDefinition | Defines the metadata for a schema property. | boolean |
| isRepeatable | Whether the property can have multiple values. | GoogleCloudContentwarehouseV1PropertyDefinition | Defines the metadata for a schema property. | boolean |
| isRequired | Whether the property is mandatory. Default is ‘false’, i.e. populating property value can be skipped. If ‘true’ then user must populate the value for this property. | GoogleCloudContentwarehouseV1PropertyDefinition | Defines the metadata for a schema property. | boolean |
| isSearchable | Indicates that the property should be included in a global search. | GoogleCloudContentwarehouseV1PropertyDefinition | Defines the metadata for a schema property. | boolean |
| mapTypeOptions | Map property. | GoogleCloudContentwarehouseV1PropertyDefinition | Defines the metadata for a schema property. | GoogleCloudContentwarehouseV1MapTypeOptions |
| name | Required. The name of the metadata property. Must be unique within a document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, _, and . | GoogleCloudContentwarehouseV1PropertyDefinition | Defines the metadata for a schema property. | String |
| propertyTypeOptions | Nested structured data property. | GoogleCloudContentwarehouseV1PropertyDefinition | Defines the metadata for a schema property. | GoogleCloudContentwarehouseV1PropertyTypeOptions |
| retrievalImportance | The retrieval importance of the property during search. | GoogleCloudContentwarehouseV1PropertyDefinition | Defines the metadata for a schema property. | String |
| schemaSources | The mapping information between this property to another schema source. | GoogleCloudContentwarehouseV1PropertyDefinition | Defines the metadata for a schema property. | list(GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource) |
| textTypeOptions | Text/string property. | GoogleCloudContentwarehouseV1PropertyDefinition | Defines the metadata for a schema property. | GoogleCloudContentwarehouseV1TextTypeOptions |
| timestampTypeOptions | Timestamp property. It is not supported by CMEK compliant deployment. | GoogleCloudContentwarehouseV1PropertyDefinition | Defines the metadata for a schema property. | GoogleCloudContentwarehouseV1TimestampTypeOptions |
| name | The schema name in the source. | GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource | The schema source information. | String |
| processorType | The Doc AI processor type name. | GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource | The schema source information. | String |
| condition | The filter condition. The syntax for this expression is a subset of SQL syntax. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, `>=`, and `~~` where the left of the operator is a property name and the right of the operator is a number or a quoted string. You must escape backslash (\\\\) and quote (\\”) characters. `~~` is the LIKE operator. The right of the operator must be a string. The only supported property data type for LIKE is text_values. It provides semantic search functionality by parsing, stemming and doing synonyms expansion against the input query. It matches if the property contains semantic similar content to the query. It is not regex matching or wildcard matching. For example, “property.company ~~ \\”google\\”” will match records whose property `property.compnay` have values like “Google Inc.”, “Google LLC” or “Google Company”. Supported functions are `LOWER([property_name])` to perform a case insensitive match and `EMPTY([property_name])` to filter on the existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, “((A AND B AND C) OR NOT D) AND E”), a maximum of 100 comparisons or functions are allowed in the expression. The expression must be < 6000 bytes in length. Only properties that are marked filterable are allowed (PropertyDefinition.is_filterable). Property names do not need to be prefixed by the document schema id (as is the case with histograms), however property names will need to be prefixed by its parent hierarchy, if any. For example: top_property_name.sub_property_name. Sample Query: `(LOWER(driving_license)="class \\"a\\"" OR EMPTY(driving_license)) AND driving_years > 10` CMEK compliant deployment only supports: * Operators: `=`, `<`, `<=`, `>`, and `>=`. * Boolean expressions: AND and OR. | GoogleCloudContentwarehouseV1PropertyFilter | String | |
| documentSchemaName | The Document schema name Document.document_schema_name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. | GoogleCloudContentwarehouseV1PropertyFilter | String | |
| propertyDefinitions | Required. List of property definitions. | GoogleCloudContentwarehouseV1PropertyTypeOptions | Configurations for a nested structured data property. | list(GoogleCloudContentwarehouseV1PropertyDefinition) |
| messages | Messages to be published. | GoogleCloudContentwarehouseV1PublishAction | Represents the action responsible for publishing messages to a Pub/Sub topic. | list(String) |
| topicId | The topic id in the Pub/Sub service for which messages will be published to. | GoogleCloudContentwarehouseV1PublishAction | Represents the action responsible for publishing messages to a Pub/Sub topic. | String |
| confidenceScore | The calibrated confidence score for this document, in the range [0., 1.]. This represents the confidence level for whether the returned document and snippet answers the user’s query. | GoogleCloudContentwarehouseV1QAResult | Additional result info for the question-answering feature. | number |
| highlights | Highlighted sections in the snippet. | GoogleCloudContentwarehouseV1QAResult | Additional result info for the question-answering feature. | list(GoogleCloudContentwarehouseV1QAResultHighlight) |
| endIndex | End index of the highlight, exclusive. | GoogleCloudContentwarehouseV1QAResultHighlight | A text span in the search text snippet that represents a highlighted section (answer context, highly relevant sentence, etc.). | integer |
| startIndex | Start index of the highlight. | GoogleCloudContentwarehouseV1QAResultHighlight | A text span in the search text snippet that represents a highlighted section (answer context, highly relevant sentence, etc.). | integer |
| condition | Condition of the action to be executed. | GoogleCloudContentwarehouseV1RemoveFromFolderAction | Represents the action responsible for remove a document from a specific folder. | String |
| folder | Name of the folder under which new document is to be added. Format: projects/{project_number}/locations/{location}/documents/{document_id}. | GoogleCloudContentwarehouseV1RemoveFromFolderAction | Represents the action responsible for remove a document from a specific folder. | String |
| userInfo | Provides user unique identification and groups information. | GoogleCloudContentwarehouseV1RequestMetadata | Meta information is used to improve the performance of the service. | GoogleCloudContentwarehouseV1UserInfo |
| requestId | A unique id associated with this call. This id is logged for tracking purpose. | GoogleCloudContentwarehouseV1ResponseMetadata | Additional information returned to client, such as debugging information. | String |
| actions | List of actions that are executed when the rule is satisfied. | GoogleCloudContentwarehouseV1Rule | Represents the rule for a content warehouse trigger. | list(GoogleCloudContentwarehouseV1Action) |
| condition | Represents the conditional expression to be evaluated. Expression should evaluate to a boolean result. When the condition is true actions are executed. Example: user_role = “hsbc_role_1” AND doc.salary > 20000 | GoogleCloudContentwarehouseV1Rule | Represents the rule for a content warehouse trigger. | String |
| description | Short description of the rule and its context. | GoogleCloudContentwarehouseV1Rule | Represents the rule for a content warehouse trigger. | String |
| ruleId | ID of the rule. It has to be unique across all the examples. This is managed internally. | GoogleCloudContentwarehouseV1Rule | Represents the rule for a content warehouse trigger. | String |
| triggerType | Identifies the trigger type for running the policy. | GoogleCloudContentwarehouseV1Rule | Represents the rule for a content warehouse trigger. | String |
| actionOutputs | Outputs of executing the actions associated with the above rule. | GoogleCloudContentwarehouseV1RuleActionsPair | Represents a rule and outputs of associated actions. | list(GoogleCloudContentwarehouseV1ActionOutput) |
| rule | Represents the rule. | GoogleCloudContentwarehouseV1RuleActionsPair | Represents a rule and outputs of associated actions. | GoogleCloudContentwarehouseV1Rule |
| actionExecutorOutput | Output from Action Executor containing rule and corresponding actions execution result. | GoogleCloudContentwarehouseV1RuleEngineOutput | Records the output of Rule Engine including rule evaluation and actions result. | GoogleCloudContentwarehouseV1ActionExecutorOutput |
| documentName | Name of the document against which the rules and actions were evaluated. | GoogleCloudContentwarehouseV1RuleEngineOutput | Records the output of Rule Engine including rule evaluation and actions result. | String |
| ruleEvaluatorOutput | Output from Rule Evaluator containing matched, unmatched and invalid rules. | GoogleCloudContentwarehouseV1RuleEngineOutput | Records the output of Rule Engine including rule evaluation and actions result. | GoogleCloudContentwarehouseV1RuleEvaluatorOutput |
| invalidRules | A subset of triggered rules that failed the validation check(s) after parsing. | GoogleCloudContentwarehouseV1RuleEvaluatorOutput | Represents the output of the Rule Evaluator. | list(GoogleCloudContentwarehouseV1InvalidRule) |
| matchedRules | A subset of triggered rules that are evaluated true for a given request. | GoogleCloudContentwarehouseV1RuleEvaluatorOutput | Represents the output of the Rule Evaluator. | list(GoogleCloudContentwarehouseV1Rule) |
| triggeredRules | List of rules fetched from database for the given request trigger type. | GoogleCloudContentwarehouseV1RuleEvaluatorOutput | Represents the output of the Rule Evaluator. | list(GoogleCloudContentwarehouseV1Rule) |
| description | Short description of the rule-set. | GoogleCloudContentwarehouseV1RuleSet | Represents a set of rules from a single customer. | String |
| name | The resource name of the rule set. Managed internally. Format: projects/{project_number}/locations/{location}/ruleSet/{rule_set_id}. The name is ignored when creating a rule set. | GoogleCloudContentwarehouseV1RuleSet | Represents a set of rules from a single customer. | String |
| rules | List of rules given by the customer. | GoogleCloudContentwarehouseV1RuleSet | Represents a set of rules from a single customer. | list(GoogleCloudContentwarehouseV1Rule) |
| source | Source of the rules i.e., customer name. | GoogleCloudContentwarehouseV1RuleSet | Represents a set of rules from a single customer. | String |
| exportToCdwPipelineMetadata | The pipeline metadata for Export-to-CDW pipeline. | GoogleCloudContentwarehouseV1RunPipelineMetadata | Metadata message of RunPipeline method. | GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata |
| failedFileCount | Number of files that have failed at some point in the pipeline. | GoogleCloudContentwarehouseV1RunPipelineMetadata | Metadata message of RunPipeline method. | integer |
| gcsIngestPipelineMetadata | The pipeline metadata for GcsIngest pipeline. | GoogleCloudContentwarehouseV1RunPipelineMetadata | Metadata message of RunPipeline method. | GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata |
| individualDocumentStatuses | The list of response details of each document. | GoogleCloudContentwarehouseV1RunPipelineMetadata | Metadata message of RunPipeline method. | list(GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus) |
| processWithDocAiPipelineMetadata | The pipeline metadata for Process-with-DocAi pipeline. | GoogleCloudContentwarehouseV1RunPipelineMetadata | Metadata message of RunPipeline method. | GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata |
| totalFileCount | Number of files that were processed by the pipeline. | GoogleCloudContentwarehouseV1RunPipelineMetadata | Metadata message of RunPipeline method. | integer |
| userInfo | User unique identification and groups information. | GoogleCloudContentwarehouseV1RunPipelineMetadata | Metadata message of RunPipeline method. | GoogleCloudContentwarehouseV1UserInfo |
| docAiDataset | The output CDW dataset resource name. | GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata | The metadata message for Export-to-CDW pipeline. | String |
| documents | The input list of all the resource names of the documents to be exported. | GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata | The metadata message for Export-to-CDW pipeline. | list(String) |
| outputPath | The output Cloud Storage folder in this pipeline. | GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata | The metadata message for Export-to-CDW pipeline. | String |
| inputPath | The input Cloud Storage folder in this pipeline. Format: `gs:///`. | GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata | The metadata message for GcsIngest pipeline. | String |
| documentId | Document identifier of an existing document. | GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus | The status of processing a document. | String |
| status | The status processing the document. | GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus | The status of processing a document. | GoogleRpcStatus |
| documents | The input list of all the resource names of the documents to be processed. | GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata | The metadata message for Process-with-DocAi pipeline. | list(String) |
| processorInfo | The DocAI processor to process the documents with. | GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata | The metadata message for Process-with-DocAi pipeline. | GoogleCloudContentwarehouseV1ProcessorInfo |
| exportCdwPipeline | Export docuemnts from Document Warehouse to CDW for training purpose. | GoogleCloudContentwarehouseV1RunPipelineRequest | Request message for DocumentService.RunPipeline. | GoogleCloudContentwarehouseV1ExportToCdwPipeline |
| gcsIngestPipeline | Cloud Storage ingestion pipeline. | GoogleCloudContentwarehouseV1RunPipelineRequest | Request message for DocumentService.RunPipeline. | GoogleCloudContentwarehouseV1GcsIngestPipeline |
| gcsIngestWithDocAiProcessorsPipeline | Use DocAI processors to process documents in Cloud Storage and ingest them to Document Warehouse. | GoogleCloudContentwarehouseV1RunPipelineRequest | Request message for DocumentService.RunPipeline. | GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline |
| processWithDocAiPipeline | Use a DocAI processor to process documents in Document Warehouse, and re-ingest the updated results into Document Warehouse. | GoogleCloudContentwarehouseV1RunPipelineRequest | Request message for DocumentService.RunPipeline. | GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline |
| requestMetadata | The meta information collected about the end user, used to enforce access control for the service. | GoogleCloudContentwarehouseV1RunPipelineRequest | Request message for DocumentService.RunPipeline. | GoogleCloudContentwarehouseV1RequestMetadata |
| documentQuery | Query used to search against documents (keyword, filters, etc.). | GoogleCloudContentwarehouseV1SearchDocumentsRequest | Request message for DocumentService.SearchDocuments. | GoogleCloudContentwarehouseV1DocumentQuery |
| histogramQueries | An expression specifying a histogram request against matching documents. Expression syntax is an aggregation function call with histogram facets and other options. The following aggregation functions are supported: * `count(string_histogram_facet)`: Count the number of matching entities for each distinct attribute value. Data types: * Histogram facet (aka filterable properties): Facet names with format | GoogleCloudContentwarehouseV1SearchDocumentsRequest | Request message for DocumentService.SearchDocuments. | list(GoogleCloudContentwarehouseV1HistogramQuery) |
| offset | An integer that specifies the current offset (that is, starting result location, amongst the documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. The maximum allowed value is 5000. Otherwise an error is thrown. For example, 0 means to return results starting from the first matching document, and 10 means to return from the 11th document. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page). | GoogleCloudContentwarehouseV1SearchDocumentsRequest | Request message for DocumentService.SearchDocuments. | integer |
| orderBy | The criteria determining how search results are sorted. For non-empty query, default is `”relevance desc”`. For empty query, default is `”upload_date desc”`. Supported options are: * `”relevance desc”`: By relevance descending, as determined by the API algorithms. * `”upload_date desc”`: By upload date descending. * `”upload_date”`: By upload date ascending. * `”update_date desc”`: By last updated date descending. * `”update_date”`: By last updated date ascending. * `”retrieval_importance desc”`: By retrieval importance of properties descending. This feature is still under development, please do not use unless otherwise instructed to do so. | GoogleCloudContentwarehouseV1SearchDocumentsRequest | Request message for DocumentService.SearchDocuments. | String |
| pageSize | A limit on the number of documents returned in the search results. Increasing this value above the default value of 10 can increase search response time. The value can be between 1 and 100. | GoogleCloudContentwarehouseV1SearchDocumentsRequest | Request message for DocumentService.SearchDocuments. | integer |
| pageToken | The token specifying the current offset within search results. See SearchDocumentsResponse.next_page_token for an explanation of how to obtain the next set of query results. | GoogleCloudContentwarehouseV1SearchDocumentsRequest | Request message for DocumentService.SearchDocuments. | String |
| qaSizeLimit | Experimental, do not use. The limit on the number of documents returned for the question-answering feature. To enable the question-answering feature, set [DocumentQuery].is_nl_query to true. | GoogleCloudContentwarehouseV1SearchDocumentsRequest | Request message for DocumentService.SearchDocuments. | integer |
| requestMetadata | The meta information collected about the end user, used to enforce access control and improve the search quality of the service. | GoogleCloudContentwarehouseV1SearchDocumentsRequest | Request message for DocumentService.SearchDocuments. | GoogleCloudContentwarehouseV1RequestMetadata |
| requireTotalSize | Controls if the search document request requires the return of a total size of matched documents. See SearchDocumentsResponse.total_size. Enabling this flag may adversely impact performance. Hint: If this is used with pagination, set this flag on the initial query but set this to false on subsequent page calls (keep the total count locally). Defaults to false. | GoogleCloudContentwarehouseV1SearchDocumentsRequest | Request message for DocumentService.SearchDocuments. | boolean |
| totalResultSize | Controls if the search document request requires the return of a total size of matched documents. See SearchDocumentsResponse.total_size. | GoogleCloudContentwarehouseV1SearchDocumentsRequest | Request message for DocumentService.SearchDocuments. | String |
| histogramQueryResults | The histogram results that match with the specified SearchDocumentsRequest.histogram_queries. | GoogleCloudContentwarehouseV1SearchDocumentsResponse | Response message for DocumentService.SearchDocuments. | list(GoogleCloudContentwarehouseV1HistogramQueryResult) |
| matchingDocuments | The document entities that match the specified SearchDocumentsRequest. | GoogleCloudContentwarehouseV1SearchDocumentsResponse | Response message for DocumentService.SearchDocuments. | list(GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument) |
| metadata | Additional information for the API invocation, such as the request tracking id. | GoogleCloudContentwarehouseV1SearchDocumentsResponse | Response message for DocumentService.SearchDocuments. | GoogleCloudContentwarehouseV1ResponseMetadata |
| nextPageToken | The token that specifies the starting position of the next page of results. This field is empty if there are no more results. | GoogleCloudContentwarehouseV1SearchDocumentsResponse | Response message for DocumentService.SearchDocuments. | String |
| questionAnswer | Experimental. Question answer from the query against the document. | GoogleCloudContentwarehouseV1SearchDocumentsResponse | Response message for DocumentService.SearchDocuments. | String |
| totalSize | The total number of matched documents which is available only if the client set SearchDocumentsRequest.require_total_size to `true` or set SearchDocumentsRequest.total_result_size to `ESTIMATED_SIZE` or `ACTUAL_SIZE`. Otherwise, the value will be `-1`. Typically a UI would handle this condition by displaying “of many”, for example: “Displaying 10 of many”. | GoogleCloudContentwarehouseV1SearchDocumentsResponse | Response message for DocumentService.SearchDocuments. | integer |
| document | Document that matches the specified SearchDocumentsRequest. This document only contains indexed metadata information. | GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument | Document entry with metadata inside SearchDocumentsResponse | GoogleCloudContentwarehouseV1Document |
| matchedTokenPageIndices | Return the 1-based page indices where those pages have one or more matched tokens. | GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument | Document entry with metadata inside SearchDocumentsResponse | list(String) |
| qaResult | Experimental. Additional result info if the question-answering feature is enabled. | GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument | Document entry with metadata inside SearchDocumentsResponse | GoogleCloudContentwarehouseV1QAResult |
| searchTextSnippet | Contains snippets of text from the document full raw text that most closely match a search query’s keywords, if available. All HTML tags in the original fields are stripped when returned in this field, and matching query keywords are enclosed in HTML bold tags. If the question-answering feature is enabled, this field will instead contain a snippet that answers the user’s natural-language query. No HTML bold tags will be present, and highlights in the answer snippet can be found in QAResult.highlights. | GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument | Document entry with metadata inside SearchDocumentsResponse | String |
| policy | Required. REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. This refers to an Identity and Access (IAM) policy, which specifies access controls for the Document. You can set ACL with condition for projects only. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the left of the operator is `DocumentSchemaId` or property name and the right of the operator is a number or a quoted string. You must escape backslash (\\\\) and quote (\\”) characters. Boolean expressions (AND/OR) are supported up to 3 levels of nesting (for example, “((A AND B AND C) OR D) AND E”), a maximum of 10 comparisons are allowed in the expression. The expression must be < 6000 bytes in length. Sample condition: `"DocumentSchemaId = \\"some schema id\\" OR SchemaId.floatPropertyName >= 10″` | GoogleCloudContentwarehouseV1SetAclRequest | Request message for DocumentService.SetAcl. | GoogleIamV1Policy |
| projectOwner | For Set Project ACL only. Authorization check for end user will be ignored when project_owner=true. | GoogleCloudContentwarehouseV1SetAclRequest | Request message for DocumentService.SetAcl. | boolean |
| requestMetadata | The meta information collected about the end user, used to enforce access control for the service. | GoogleCloudContentwarehouseV1SetAclRequest | Request message for DocumentService.SetAcl. | GoogleCloudContentwarehouseV1RequestMetadata |
| metadata | Additional information for the API invocation, such as the request tracking id. | GoogleCloudContentwarehouseV1SetAclResponse | Response message for DocumentService.SetAcl. | GoogleCloudContentwarehouseV1ResponseMetadata |
| policy | The policy will be attached to a resource (e.g. projecct, document). | GoogleCloudContentwarehouseV1SetAclResponse | Response message for DocumentService.SetAcl. | GoogleIamV1Policy |
| context | This is a freeform field. Example contexts can be “sales,” “engineering,” “real estate,” “accounting,” etc. The context can be supplied during search requests. | GoogleCloudContentwarehouseV1SynonymSet | Represents a list of synonyms for a given context. For example a context “sales” could contain: Synonym 1: sale, invoice, bill, order Synonym 2: money, credit, finance, payment Synonym 3: shipping, freight, transport Each SynonymSets should be disjoint | String |
| name | The resource name of the SynonymSet This is mandatory for google.api.resource. Format: projects/{project_number}/locations/{location}/synonymSets/{context}. | GoogleCloudContentwarehouseV1SynonymSet | Represents a list of synonyms for a given context. For example a context “sales” could contain: Synonym 1: sale, invoice, bill, order Synonym 2: money, credit, finance, payment Synonym 3: shipping, freight, transport Each SynonymSets should be disjoint | String |
| synonyms | List of Synonyms for the context. | GoogleCloudContentwarehouseV1SynonymSet | Represents a list of synonyms for a given context. For example a context “sales” could contain: Synonym 1: sale, invoice, bill, order Synonym 2: money, credit, finance, payment Synonym 3: shipping, freight, transport Each SynonymSets should be disjoint | list(GoogleCloudContentwarehouseV1SynonymSetSynonym) |
| words | For example: sale, invoice, bill, order | GoogleCloudContentwarehouseV1SynonymSetSynonym | Represents a list of words given by the customer All these words are synonyms of each other. | list(String) |
| values | List of text values. | GoogleCloudContentwarehouseV1TextArray | String/text values. | list(String) |
| timeField | Specifies which time field to filter documents on. Defaults to TimeField.UPLOAD_TIME. | GoogleCloudContentwarehouseV1TimeFilter | Filter on create timestamp or update timestamp of documents. | String |
| timeRange | GoogleCloudContentwarehouseV1TimeFilter | Filter on create timestamp or update timestamp of documents. | GoogleTypeInterval | |
| values | List of timestamp values. | GoogleCloudContentwarehouseV1TimestampArray | Timestamp values. | list(GoogleCloudContentwarehouseV1TimestampValue) |
| textValue | The string must represent a valid instant in UTC and is parsed using java.time.format.DateTimeFormatter.ISO_INSTANT. e.g. “2013-09-29T18:46:19Z” | GoogleCloudContentwarehouseV1TimestampValue | Timestamp value type. | String |
| timestampValue | Timestamp value | GoogleCloudContentwarehouseV1TimestampValue | Timestamp value type. | DateTime |
| cloudAiDocumentOption | Request Option for processing Cloud AI Document in Document Warehouse. This field offers limited support for mapping entities from Cloud AI Document to Warehouse Document. Please consult with product team before using this field and other available options. | GoogleCloudContentwarehouseV1UpdateDocumentRequest | Request message for DocumentService.UpdateDocument. | GoogleCloudContentwarehouseV1CloudAIDocumentOption |
| document | Required. The document to update. | GoogleCloudContentwarehouseV1UpdateDocumentRequest | Request message for DocumentService.UpdateDocument. | GoogleCloudContentwarehouseV1Document |
| requestMetadata | The meta information collected about the end user, used to enforce access control for the service. | GoogleCloudContentwarehouseV1UpdateDocumentRequest | Request message for DocumentService.UpdateDocument. | GoogleCloudContentwarehouseV1RequestMetadata |
| updateOptions | Options for the update operation. | GoogleCloudContentwarehouseV1UpdateDocumentRequest | Request message for DocumentService.UpdateDocument. | GoogleCloudContentwarehouseV1UpdateOptions |
| document | Updated document after executing update request. | GoogleCloudContentwarehouseV1UpdateDocumentResponse | Response message for DocumentService.UpdateDocument. | GoogleCloudContentwarehouseV1Document |
| metadata | Additional information for the API invocation, such as the request tracking id. | GoogleCloudContentwarehouseV1UpdateDocumentResponse | Response message for DocumentService.UpdateDocument. | GoogleCloudContentwarehouseV1ResponseMetadata |
| ruleEngineOutput | Output from Rule Engine recording the rule evaluator and action executor’s output. Refer format in: google/cloud/contentwarehouse/v1/rule_engine.proto | GoogleCloudContentwarehouseV1UpdateDocumentResponse | Response message for DocumentService.UpdateDocument. | GoogleCloudContentwarehouseV1RuleEngineOutput |
| documentSchema | Required. The document schema to update with. | GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest | Request message for DocumentSchemaService.UpdateDocumentSchema. | GoogleCloudContentwarehouseV1DocumentSchema |
| mergeFieldsOptions | Options for merging. | GoogleCloudContentwarehouseV1UpdateOptions | Options for Update operations. | GoogleCloudContentwarehouseV1MergeFieldsOptions |
| updateMask | Field mask for merging Document fields. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask | GoogleCloudContentwarehouseV1UpdateOptions | Options for Update operations. | String |
| updateType | Type for update. | GoogleCloudContentwarehouseV1UpdateOptions | Options for Update operations. | String |
| ruleSet | Required. The rule set to update. | GoogleCloudContentwarehouseV1UpdateRuleSetRequest | Request message for RuleSetService.UpdateRuleSet. | GoogleCloudContentwarehouseV1RuleSet |
| groupIds | The unique group identifications which the user is belong to. The format is “group:[email protected]”; | GoogleCloudContentwarehouseV1UserInfo | The user information. | list(String) |
| id | A unique user identification string, as determined by the client. The maximum number of allowed characters is 255. Allowed characters include numbers 0 to 9, uppercase and lowercase letters, and restricted special symbols (:, @, +, -, _, ~) The format is “user:[email protected]”; | GoogleCloudContentwarehouseV1UserInfo | The user information. | String |
| booleanValue | Represents a boolean value. | GoogleCloudContentwarehouseV1Value | `Value` represents a dynamically typed value which can be either be a float, a integer, a string, or a datetime value. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. | boolean |
| datetimeValue | Represents a datetime value. | GoogleCloudContentwarehouseV1Value | `Value` represents a dynamically typed value which can be either be a float, a integer, a string, or a datetime value. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. | GoogleTypeDateTime |
| enumValue | Represents an enum value. | GoogleCloudContentwarehouseV1Value | `Value` represents a dynamically typed value which can be either be a float, a integer, a string, or a datetime value. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. | GoogleCloudContentwarehouseV1EnumValue |
| floatValue | Represents a float value. | GoogleCloudContentwarehouseV1Value | `Value` represents a dynamically typed value which can be either be a float, a integer, a string, or a datetime value. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. | number |
| intValue | Represents a integer value. | GoogleCloudContentwarehouseV1Value | `Value` represents a dynamically typed value which can be either be a float, a integer, a string, or a datetime value. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. | integer |
| stringValue | Represents a string value. | GoogleCloudContentwarehouseV1Value | `Value` represents a dynamically typed value which can be either be a float, a integer, a string, or a datetime value. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. | String |
| timestampValue | Represents a timestamp value. | GoogleCloudContentwarehouseV1Value | `Value` represents a dynamically typed value which can be either be a float, a integer, a string, or a datetime value. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. | GoogleCloudContentwarehouseV1TimestampValue |
| documentSchemaName | The document schema name. | GoogleCloudContentwarehouseV1WeightedSchemaProperty | Specifies the schema property name. | String |
| propertyNames | The property definition names in the schema. | GoogleCloudContentwarehouseV1WeightedSchemaProperty | Specifies the schema property name. | list(String) |
| format | Format of a barcode. The supported formats are: – `CODE_128`: Code 128 type. – `CODE_39`: Code 39 type. – `CODE_93`: Code 93 type. – `CODABAR`: Codabar type. – `DATA_MATRIX`: 2D Data Matrix type. – `ITF`: ITF type. – `EAN_13`: EAN-13 type. – `EAN_8`: EAN-8 type. – `QR_CODE`: 2D QR code type. – `UPC_A`: UPC-A type. – `UPC_E`: UPC-E type. – `PDF417`: PDF417 type. – `AZTEC`: 2D Aztec code type. – `DATABAR`: GS1 DataBar code type. | GoogleCloudDocumentaiV1Barcode | Encodes the detailed information of a barcode. | String |
| rawValue | Raw value encoded in the barcode. For example: `’MEBKM:TITLE:Google;URL:https://www.google.com;;’`. | GoogleCloudDocumentaiV1Barcode | Encodes the detailed information of a barcode. | String |
| valueFormat | Value format describes the format of the value that a barcode encodes. The supported formats are: – `CONTACT_INFO`: Contact information. – `EMAIL`: Email address. – `ISBN`: ISBN identifier. – `PHONE`: Phone number. – `PRODUCT`: Product. – `SMS`: SMS message. – `TEXT`: Text string. – `URL`: URL address. – `WIFI`: Wifi information. – `GEO`: Geo-localization. – `CALENDAR_EVENT`: Calendar event. – `DRIVER_LICENSE`: Driver’s license. | GoogleCloudDocumentaiV1Barcode | Encodes the detailed information of a barcode. | String |
| normalizedVertices | The bounding polygon normalized vertices. | GoogleCloudDocumentaiV1BoundingPoly | A bounding polygon for the detected image annotation. | list(GoogleCloudDocumentaiV1NormalizedVertex) |
| vertices | The bounding polygon vertices. | GoogleCloudDocumentaiV1BoundingPoly | A bounding polygon for the detected image annotation. | list(GoogleCloudDocumentaiV1Vertex) |
| content | Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. | GoogleCloudDocumentaiV1Document | Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. | String |
| entities | A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. | GoogleCloudDocumentaiV1Document | Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. | list(GoogleCloudDocumentaiV1DocumentEntity) |
| entityRelations | Placeholder. Relationship among Document.entities. | GoogleCloudDocumentaiV1Document | Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. | list(GoogleCloudDocumentaiV1DocumentEntityRelation) |
| error | Any error that occurred while processing this document. | GoogleCloudDocumentaiV1Document | Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. | GoogleRpcStatus |
| mimeType | An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). | GoogleCloudDocumentaiV1Document | Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. | String |
| pages | Visual page layout for the Document. | GoogleCloudDocumentaiV1Document | Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. | list(GoogleCloudDocumentaiV1DocumentPage) |
| revisions | Placeholder. Revision history of this document. | GoogleCloudDocumentaiV1Document | Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. | list(GoogleCloudDocumentaiV1DocumentRevision) |
| shardInfo | Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified. | GoogleCloudDocumentaiV1Document | Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. | GoogleCloudDocumentaiV1DocumentShardInfo |
| text | Optional. UTF-8 encoded text in reading order from the document. | GoogleCloudDocumentaiV1Document | Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. | String |
| textChanges | Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other. | GoogleCloudDocumentaiV1Document | Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. | list(GoogleCloudDocumentaiV1DocumentTextChange) |
| textStyles | Styles for the Document.text. | GoogleCloudDocumentaiV1Document | Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. | list(GoogleCloudDocumentaiV1DocumentStyle) |
| uri | Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris). | GoogleCloudDocumentaiV1Document | Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. | String |
| confidence | Optional. Confidence of detected Schema entity. Range `[0, 1]`. | GoogleCloudDocumentaiV1DocumentEntity | An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. | number |
| id | Optional. Canonical id. This will be a unique value in the entity list for this document. | GoogleCloudDocumentaiV1DocumentEntity | An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. | String |
| mentionId | Optional. Deprecated. Use `id` field instead. | GoogleCloudDocumentaiV1DocumentEntity | An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. | String |
| mentionText | Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. | GoogleCloudDocumentaiV1DocumentEntity | An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. | String |
| normalizedValue | Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types. | GoogleCloudDocumentaiV1DocumentEntity | An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. | GoogleCloudDocumentaiV1DocumentEntityNormalizedValue |
| pageAnchor | Optional. Represents the provenance of this entity wrt. the location on the page where it was found. | GoogleCloudDocumentaiV1DocumentEntity | An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. | GoogleCloudDocumentaiV1DocumentPageAnchor |
| properties | Optional. Entities can be nested to form a hierarchical data structure representing the content in the document. | GoogleCloudDocumentaiV1DocumentEntity | An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. | list(GoogleCloudDocumentaiV1DocumentEntity) |
| provenance | Optional. The history of this annotation. | GoogleCloudDocumentaiV1DocumentEntity | An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. | GoogleCloudDocumentaiV1DocumentProvenance |
| redacted | Optional. Whether the entity will be redacted for de-identification purposes. | GoogleCloudDocumentaiV1DocumentEntity | An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. | boolean |
| textAnchor | Optional. Provenance of the entity. Text anchor indexing into the Document.text. | GoogleCloudDocumentaiV1DocumentEntity | An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. | GoogleCloudDocumentaiV1DocumentTextAnchor |
| type | Required. Entity type from a schema e.g. `Address`. | GoogleCloudDocumentaiV1DocumentEntity | An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. | String |
| addressValue | Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto | GoogleCloudDocumentaiV1DocumentEntityNormalizedValue | Parsed and normalized entity value. | GoogleTypePostalAddress |
| booleanValue | Boolean value. Can be used for entities with binary values, or for checkboxes. | GoogleCloudDocumentaiV1DocumentEntityNormalizedValue | Parsed and normalized entity value. | boolean |
| dateValue | Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto | GoogleCloudDocumentaiV1DocumentEntityNormalizedValue | Parsed and normalized entity value. | GoogleTypeDate |
| datetimeValue | DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto | GoogleCloudDocumentaiV1DocumentEntityNormalizedValue | Parsed and normalized entity value. | GoogleTypeDateTime |
| floatValue | Float value. | GoogleCloudDocumentaiV1DocumentEntityNormalizedValue | Parsed and normalized entity value. | number |
| integerValue | Integer value. | GoogleCloudDocumentaiV1DocumentEntityNormalizedValue | Parsed and normalized entity value. | integer |
| moneyValue | Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto | GoogleCloudDocumentaiV1DocumentEntityNormalizedValue | Parsed and normalized entity value. | GoogleTypeMoney |
| text | Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. – Money/Currency type (`money_value`) is in the ISO 4217 text format. – Date type (`date_value`) is in the ISO 8601 text format. – Datetime type (`datetime_value`) is in the ISO 8601 text format. | GoogleCloudDocumentaiV1DocumentEntityNormalizedValue | Parsed and normalized entity value. | String |
| objectId | Object entity id. | GoogleCloudDocumentaiV1DocumentEntityRelation | Relationship between Entities. | String |
| relation | Relationship description. | GoogleCloudDocumentaiV1DocumentEntityRelation | Relationship between Entities. | String |
| subjectId | Subject entity id. | GoogleCloudDocumentaiV1DocumentEntityRelation | Relationship between Entities. | String |
| blocks | A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. | GoogleCloudDocumentaiV1DocumentPage | A page in a Document. | list(GoogleCloudDocumentaiV1DocumentPageBlock) |
| detectedBarcodes | A list of detected barcodes. | GoogleCloudDocumentaiV1DocumentPage | A page in a Document. | list(GoogleCloudDocumentaiV1DocumentPageDetectedBarcode) |
| detectedLanguages | A list of detected languages together with confidence. | GoogleCloudDocumentaiV1DocumentPage | A page in a Document. | list(GoogleCloudDocumentaiV1DocumentPageDetectedLanguage) |
| dimension | Physical dimension of the page. | GoogleCloudDocumentaiV1DocumentPage | A page in a Document. | GoogleCloudDocumentaiV1DocumentPageDimension |
| formFields | A list of visually detected form fields on the page. | GoogleCloudDocumentaiV1DocumentPage | A page in a Document. | list(GoogleCloudDocumentaiV1DocumentPageFormField) |
| image | Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned. | GoogleCloudDocumentaiV1DocumentPage | A page in a Document. | GoogleCloudDocumentaiV1DocumentPageImage |
| imageQualityScores | Image quality scores. | GoogleCloudDocumentaiV1DocumentPage | A page in a Document. | GoogleCloudDocumentaiV1DocumentPageImageQualityScores |
| layout | Layout for the page. | GoogleCloudDocumentaiV1DocumentPage | A page in a Document. | GoogleCloudDocumentaiV1DocumentPageLayout |
| lines | A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line. | GoogleCloudDocumentaiV1DocumentPage | A page in a Document. | list(GoogleCloudDocumentaiV1DocumentPageLine) |
| pageNumber | 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing. | GoogleCloudDocumentaiV1DocumentPage | A page in a Document. | integer |
| paragraphs | A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph. | GoogleCloudDocumentaiV1DocumentPage | A page in a Document. | list(GoogleCloudDocumentaiV1DocumentPageParagraph) |
| provenance | The history of this page. | GoogleCloudDocumentaiV1DocumentPage | A page in a Document. | GoogleCloudDocumentaiV1DocumentProvenance |
| symbols | A list of visually detected symbols on the page. | GoogleCloudDocumentaiV1DocumentPage | A page in a Document. | list(GoogleCloudDocumentaiV1DocumentPageSymbol) |
| tables | A list of visually detected tables on the page. | GoogleCloudDocumentaiV1DocumentPage | A page in a Document. | list(GoogleCloudDocumentaiV1DocumentPageTable) |
| tokens | A list of visually detected tokens on the page. | GoogleCloudDocumentaiV1DocumentPage | A page in a Document. | list(GoogleCloudDocumentaiV1DocumentPageToken) |
| transforms | Transformation matrices that were applied to the original document image to produce Page.image. | GoogleCloudDocumentaiV1DocumentPage | A page in a Document. | list(GoogleCloudDocumentaiV1DocumentPageMatrix) |
| visualElements | A list of detected non-text visual elements e.g. checkbox, signature etc. on the page. | GoogleCloudDocumentaiV1DocumentPage | A page in a Document. | list(GoogleCloudDocumentaiV1DocumentPageVisualElement) |
| pageRefs | One or more references to visual page elements | GoogleCloudDocumentaiV1DocumentPageAnchor | Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. | list(GoogleCloudDocumentaiV1DocumentPageAnchorPageRef) |
| boundingPoly | Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it’s referring to. | GoogleCloudDocumentaiV1DocumentPageAnchorPageRef | Represents a weak reference to a page element within a document. | GoogleCloudDocumentaiV1BoundingPoly |
| confidence | Optional. Confidence of detected page element, if applicable. Range `[0, 1]`. | GoogleCloudDocumentaiV1DocumentPageAnchorPageRef | Represents a weak reference to a page element within a document. | number |
| layoutId | Optional. Deprecated. Use PageRef.bounding_poly instead. | GoogleCloudDocumentaiV1DocumentPageAnchorPageRef | Represents a weak reference to a page element within a document. | String |
| layoutType | Optional. The type of the layout element that is being referenced if any. | GoogleCloudDocumentaiV1DocumentPageAnchorPageRef | Represents a weak reference to a page element within a document. | String |
| page | Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json. | GoogleCloudDocumentaiV1DocumentPageAnchorPageRef | Represents a weak reference to a page element within a document. | String |
| detectedLanguages | A list of detected languages together with confidence. | GoogleCloudDocumentaiV1DocumentPageBlock | A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. | list(GoogleCloudDocumentaiV1DocumentPageDetectedLanguage) |
| layout | Layout for Block. | GoogleCloudDocumentaiV1DocumentPageBlock | A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. | GoogleCloudDocumentaiV1DocumentPageLayout |
| provenance | The history of this annotation. | GoogleCloudDocumentaiV1DocumentPageBlock | A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. | GoogleCloudDocumentaiV1DocumentProvenance |
| barcode | Detailed barcode information of the DetectedBarcode. | GoogleCloudDocumentaiV1DocumentPageDetectedBarcode | A detected barcode. | GoogleCloudDocumentaiV1Barcode |
| layout | Layout for DetectedBarcode. | GoogleCloudDocumentaiV1DocumentPageDetectedBarcode | A detected barcode. | GoogleCloudDocumentaiV1DocumentPageLayout |
| confidence | Confidence of detected language. Range `[0, 1]`. | GoogleCloudDocumentaiV1DocumentPageDetectedLanguage | Detected language for a structural component. | number |
| languageCode | The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. | GoogleCloudDocumentaiV1DocumentPageDetectedLanguage | Detected language for a structural component. | String |
| height | Page height. | GoogleCloudDocumentaiV1DocumentPageDimension | Dimension for the page. | number |
| unit | Dimension unit. | GoogleCloudDocumentaiV1DocumentPageDimension | Dimension for the page. | String |
| width | Page width. | GoogleCloudDocumentaiV1DocumentPageDimension | Dimension for the page. | number |
| correctedKeyText | Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction. | GoogleCloudDocumentaiV1DocumentPageFormField | A form field detected on the page. | String |
| correctedValueText | Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction. | GoogleCloudDocumentaiV1DocumentPageFormField | A form field detected on the page. | String |
| fieldName | Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc. | GoogleCloudDocumentaiV1DocumentPageFormField | A form field detected on the page. | GoogleCloudDocumentaiV1DocumentPageLayout |
| fieldValue | Layout for the FormField value. | GoogleCloudDocumentaiV1DocumentPageFormField | A form field detected on the page. | GoogleCloudDocumentaiV1DocumentPageLayout |
| nameDetectedLanguages | A list of detected languages for name together with confidence. | GoogleCloudDocumentaiV1DocumentPageFormField | A form field detected on the page. | list(GoogleCloudDocumentaiV1DocumentPageDetectedLanguage) |
| provenance | The history of this annotation. | GoogleCloudDocumentaiV1DocumentPageFormField | A form field detected on the page. | GoogleCloudDocumentaiV1DocumentProvenance |
| valueDetectedLanguages | A list of detected languages for value together with confidence. | GoogleCloudDocumentaiV1DocumentPageFormField | A form field detected on the page. | list(GoogleCloudDocumentaiV1DocumentPageDetectedLanguage) |
| valueType | If the value is non-textual, this field represents the type. Current valid values are: – blank (this indicates the `field_value` is normal text) – `unfilled_checkbox` – `filled_checkbox` | GoogleCloudDocumentaiV1DocumentPageFormField | A form field detected on the page. | String |
| content | Raw byte content of the image. | GoogleCloudDocumentaiV1DocumentPageImage | Rendered image contents for this page. | String |
| height | Height of the image in pixels. | GoogleCloudDocumentaiV1DocumentPageImage | Rendered image contents for this page. | integer |
| mimeType | Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image. | GoogleCloudDocumentaiV1DocumentPageImage | Rendered image contents for this page. | String |
| width | Width of the image in pixels. | GoogleCloudDocumentaiV1DocumentPageImage | Rendered image contents for this page. | integer |
| detectedDefects | A list of detected defects. | GoogleCloudDocumentaiV1DocumentPageImageQualityScores | Image quality scores for the page image. | list(GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect) |
| qualityScore | The overall quality score. Range `[0, 1]` where `1` is perfect quality. | GoogleCloudDocumentaiV1DocumentPageImageQualityScores | Image quality scores for the page image. | number |
| confidence | Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists. | GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect | Image Quality Defects | number |
| type | Name of the defect type. Supported values are: – `quality/defect_blurry` – `quality/defect_noisy` – `quality/defect_dark` – `quality/defect_faint` – `quality/defect_text_too_small` – `quality/defect_document_cutoff` – `quality/defect_text_cutoff` – `quality/defect_glare` | GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect | Image Quality Defects | String |
| boundingPoly | The bounding polygon for the Layout. | GoogleCloudDocumentaiV1DocumentPageLayout | Visual element describing a layout unit on a page. | GoogleCloudDocumentaiV1BoundingPoly |
| confidence | Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`. | GoogleCloudDocumentaiV1DocumentPageLayout | Visual element describing a layout unit on a page. | number |
| orientation | Detected orientation for the Layout. | GoogleCloudDocumentaiV1DocumentPageLayout | Visual element describing a layout unit on a page. | String |
| textAnchor | Text anchor indexing into the Document.text. | GoogleCloudDocumentaiV1DocumentPageLayout | Visual element describing a layout unit on a page. | GoogleCloudDocumentaiV1DocumentTextAnchor |
| detectedLanguages | A list of detected languages together with confidence. | GoogleCloudDocumentaiV1DocumentPageLine | A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc. | list(GoogleCloudDocumentaiV1DocumentPageDetectedLanguage) |
| layout | Layout for Line. | GoogleCloudDocumentaiV1DocumentPageLine | A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc. | GoogleCloudDocumentaiV1DocumentPageLayout |
| provenance | The history of this annotation. | GoogleCloudDocumentaiV1DocumentPageLine | A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc. | GoogleCloudDocumentaiV1DocumentProvenance |
| cols | Number of columns in the matrix. | GoogleCloudDocumentaiV1DocumentPageMatrix | Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation. | integer |
| data | The matrix data. | GoogleCloudDocumentaiV1DocumentPageMatrix | Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation. | String |
| rows | Number of rows in the matrix. | GoogleCloudDocumentaiV1DocumentPageMatrix | Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation. | integer |
| type | This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html | GoogleCloudDocumentaiV1DocumentPageMatrix | Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation. | integer |
| detectedLanguages | A list of detected languages together with confidence. | GoogleCloudDocumentaiV1DocumentPageParagraph | A collection of lines that a human would perceive as a paragraph. | list(GoogleCloudDocumentaiV1DocumentPageDetectedLanguage) |
| layout | Layout for Paragraph. | GoogleCloudDocumentaiV1DocumentPageParagraph | A collection of lines that a human would perceive as a paragraph. | GoogleCloudDocumentaiV1DocumentPageLayout |
| provenance | The history of this annotation. | GoogleCloudDocumentaiV1DocumentPageParagraph | A collection of lines that a human would perceive as a paragraph. | GoogleCloudDocumentaiV1DocumentProvenance |
| detectedLanguages | A list of detected languages together with confidence. | GoogleCloudDocumentaiV1DocumentPageSymbol | A detected symbol. | list(GoogleCloudDocumentaiV1DocumentPageDetectedLanguage) |
| layout | Layout for Symbol. | GoogleCloudDocumentaiV1DocumentPageSymbol | A detected symbol. | GoogleCloudDocumentaiV1DocumentPageLayout |
| bodyRows | Body rows of the table. | GoogleCloudDocumentaiV1DocumentPageTable | A table representation similar to HTML table structure. | list(GoogleCloudDocumentaiV1DocumentPageTableTableRow) |
| detectedLanguages | A list of detected languages together with confidence. | GoogleCloudDocumentaiV1DocumentPageTable | A table representation similar to HTML table structure. | list(GoogleCloudDocumentaiV1DocumentPageDetectedLanguage) |
| headerRows | Header rows of the table. | GoogleCloudDocumentaiV1DocumentPageTable | A table representation similar to HTML table structure. | list(GoogleCloudDocumentaiV1DocumentPageTableTableRow) |
| layout | Layout for Table. | GoogleCloudDocumentaiV1DocumentPageTable | A table representation similar to HTML table structure. | GoogleCloudDocumentaiV1DocumentPageLayout |
| provenance | The history of this table. | GoogleCloudDocumentaiV1DocumentPageTable | A table representation similar to HTML table structure. | GoogleCloudDocumentaiV1DocumentProvenance |
| colSpan | How many columns this cell spans. | GoogleCloudDocumentaiV1DocumentPageTableTableCell | A cell representation inside the table. | integer |
| detectedLanguages | A list of detected languages together with confidence. | GoogleCloudDocumentaiV1DocumentPageTableTableCell | A cell representation inside the table. | list(GoogleCloudDocumentaiV1DocumentPageDetectedLanguage) |
| layout | Layout for TableCell. | GoogleCloudDocumentaiV1DocumentPageTableTableCell | A cell representation inside the table. | GoogleCloudDocumentaiV1DocumentPageLayout |
| rowSpan | How many rows this cell spans. | GoogleCloudDocumentaiV1DocumentPageTableTableCell | A cell representation inside the table. | integer |
| cells | Cells that make up this row. | GoogleCloudDocumentaiV1DocumentPageTableTableRow | A row of table cells. | list(GoogleCloudDocumentaiV1DocumentPageTableTableCell) |
| detectedBreak | Detected break at the end of a Token. | GoogleCloudDocumentaiV1DocumentPageToken | A detected token. | GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak |
| detectedLanguages | A list of detected languages together with confidence. | GoogleCloudDocumentaiV1DocumentPageToken | A detected token. | list(GoogleCloudDocumentaiV1DocumentPageDetectedLanguage) |
| layout | Layout for Token. | GoogleCloudDocumentaiV1DocumentPageToken | A detected token. | GoogleCloudDocumentaiV1DocumentPageLayout |
| provenance | The history of this annotation. | GoogleCloudDocumentaiV1DocumentPageToken | A detected token. | GoogleCloudDocumentaiV1DocumentProvenance |
| styleInfo | Text style attributes. | GoogleCloudDocumentaiV1DocumentPageToken | A detected token. | GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo |
| type | Detected break type. | GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak | Detected break at the end of a Token. | String |
| backgroundColor | Color of the background. | GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo | Font and other text style attributes. | GoogleTypeColor |
| bold | Whether the text is bold (equivalent to font_weight is at least `700`). | GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo | Font and other text style attributes. | boolean |
| fontSize | Font size in points (`1` point is `¹⁄₇₂` inches). | GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo | Font and other text style attributes. | integer |
| fontType | Name or style of the font. | GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo | Font and other text style attributes. | String |
| fontWeight | TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`. | GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo | Font and other text style attributes. | integer |
| handwritten | Whether the text is handwritten. | GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo | Font and other text style attributes. | boolean |
| italic | Whether the text is italic. | GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo | Font and other text style attributes. | boolean |
| letterSpacing | Letter spacing in points. | GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo | Font and other text style attributes. | float |
| pixelFontSize | Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`. | GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo | Font and other text style attributes. | float |
| smallcaps | Whether the text is in small caps. | GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo | Font and other text style attributes. | boolean |
| strikeout | Whether the text is strikethrough. | GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo | Font and other text style attributes. | boolean |
| subscript | Whether the text is a subscript. | GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo | Font and other text style attributes. | boolean |
| superscript | Whether the text is a superscript. | GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo | Font and other text style attributes. | boolean |
| textColor | Color of the text. | GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo | Font and other text style attributes. | GoogleTypeColor |
| underlined | Whether the text is underlined. | GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo | Font and other text style attributes. | boolean |
| detectedLanguages | A list of detected languages together with confidence. | GoogleCloudDocumentaiV1DocumentPageVisualElement | Detected non-text visual elements e.g. checkbox, signature etc. on the page. | list(GoogleCloudDocumentaiV1DocumentPageDetectedLanguage) |
| layout | Layout for VisualElement. | GoogleCloudDocumentaiV1DocumentPageVisualElement | Detected non-text visual elements e.g. checkbox, signature etc. on the page. | GoogleCloudDocumentaiV1DocumentPageLayout |
| type | Type of the VisualElement. | GoogleCloudDocumentaiV1DocumentPageVisualElement | Detected non-text visual elements e.g. checkbox, signature etc. on the page. | String |
| id | The Id of this operation. Needs to be unique within the scope of the revision. | GoogleCloudDocumentaiV1DocumentProvenance | Structure to identify provenance relationships between annotations in different revisions. | integer |
| parents | References to the original elements that are replaced. | GoogleCloudDocumentaiV1DocumentProvenance | Structure to identify provenance relationships between annotations in different revisions. | list(GoogleCloudDocumentaiV1DocumentProvenanceParent) |
| revision | The index of the revision that produced this element. | GoogleCloudDocumentaiV1DocumentProvenance | Structure to identify provenance relationships between annotations in different revisions. | integer |
| type | The type of provenance operation. | GoogleCloudDocumentaiV1DocumentProvenance | Structure to identify provenance relationships between annotations in different revisions. | String |
| id | The id of the parent provenance. | GoogleCloudDocumentaiV1DocumentProvenanceParent | The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. | integer |
| index | The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. | GoogleCloudDocumentaiV1DocumentProvenanceParent | The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. | integer |
| revision | The index of the index into current revision’s parent_ids list. | GoogleCloudDocumentaiV1DocumentProvenanceParent | The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. | integer |
| agent | If the change was made by a person specify the name or id of that person. | GoogleCloudDocumentaiV1DocumentRevision | Contains past or forward revisions of this document. | String |
| createTime | The time that the revision was created, internally generated by doc proto storage at the time of create. | GoogleCloudDocumentaiV1DocumentRevision | Contains past or forward revisions of this document. | DateTime |
| humanReview | Human Review information of this revision. | GoogleCloudDocumentaiV1DocumentRevision | Contains past or forward revisions of this document. | GoogleCloudDocumentaiV1DocumentRevisionHumanReview |
| id | Id of the revision, internally generated by doc proto storage. Unique within the context of the document. | GoogleCloudDocumentaiV1DocumentRevision | Contains past or forward revisions of this document. | String |
| parent | The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. | GoogleCloudDocumentaiV1DocumentRevision | Contains past or forward revisions of this document. | list(integer) |
| parentIds | The revisions that this revision is based on. Must include all the ids that have anything to do with this revision – eg. there are `provenance.parent.revision` fields that index into this field. | GoogleCloudDocumentaiV1DocumentRevision | Contains past or forward revisions of this document. | list(String) |
| processor | If the annotation was made by processor identify the processor by its resource name. | GoogleCloudDocumentaiV1DocumentRevision | Contains past or forward revisions of this document. | String |
| state | Human review state. e.g. `requested`, `succeeded`, `rejected`. | GoogleCloudDocumentaiV1DocumentRevisionHumanReview | Human Review information of the document. | String |
| stateMessage | A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. | GoogleCloudDocumentaiV1DocumentRevisionHumanReview | Human Review information of the document. | String |
| shardCount | Total number of shards. | GoogleCloudDocumentaiV1DocumentShardInfo | For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. | String |
| shardIndex | The 0-based index of this shard. | GoogleCloudDocumentaiV1DocumentShardInfo | For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. | String |
| textOffset | The index of the first character in Document.text in the overall document global text. | GoogleCloudDocumentaiV1DocumentShardInfo | For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. | String |
| backgroundColor | Text background color. | GoogleCloudDocumentaiV1DocumentStyle | Annotation for common text style attributes. This adheres to CSS conventions as much as possible. | GoogleTypeColor |
| color | Text color. | GoogleCloudDocumentaiV1DocumentStyle | Annotation for common text style attributes. This adheres to CSS conventions as much as possible. | GoogleTypeColor |
| fontFamily | Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp | GoogleCloudDocumentaiV1DocumentStyle | Annotation for common text style attributes. This adheres to CSS conventions as much as possible. | String |
| fontSize | Font size. | GoogleCloudDocumentaiV1DocumentStyle | Annotation for common text style attributes. This adheres to CSS conventions as much as possible. | GoogleCloudDocumentaiV1DocumentStyleFontSize |
| fontWeight | [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`. | GoogleCloudDocumentaiV1DocumentStyle | Annotation for common text style attributes. This adheres to CSS conventions as much as possible. | String |
| textAnchor | Text anchor indexing into the Document.text. | GoogleCloudDocumentaiV1DocumentStyle | Annotation for common text style attributes. This adheres to CSS conventions as much as possible. | GoogleCloudDocumentaiV1DocumentTextAnchor |
| textDecoration | [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. | GoogleCloudDocumentaiV1DocumentStyle | Annotation for common text style attributes. This adheres to CSS conventions as much as possible. | String |
| textStyle | [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`. | GoogleCloudDocumentaiV1DocumentStyle | Annotation for common text style attributes. This adheres to CSS conventions as much as possible. | String |
| size | Font size for the text. | GoogleCloudDocumentaiV1DocumentStyleFontSize | Font size with unit. | number |
| unit | Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`). | GoogleCloudDocumentaiV1DocumentStyleFontSize | Font size with unit. | String |
| content | Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. | GoogleCloudDocumentaiV1DocumentTextAnchor | Text reference indexing into the Document.text. | String |
| textSegments | The text segments from the Document.text. | GoogleCloudDocumentaiV1DocumentTextAnchor | Text reference indexing into the Document.text. | list(GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment) |
| endIndex | TextSegment half open end UTF-8 char index in the Document.text. | GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment | A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset | String |
| startIndex | TextSegment start UTF-8 char index in the Document.text. | GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment | A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset | String |
| changedText | The text that replaces the text identified in the `text_anchor`. | GoogleCloudDocumentaiV1DocumentTextChange | This message is used for text changes aka. OCR corrections. | String |
| provenance | The history of this annotation. | GoogleCloudDocumentaiV1DocumentTextChange | This message is used for text changes aka. OCR corrections. | list(GoogleCloudDocumentaiV1DocumentProvenance) |
| textAnchor | Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index. | GoogleCloudDocumentaiV1DocumentTextChange | This message is used for text changes aka. OCR corrections. | GoogleCloudDocumentaiV1DocumentTextAnchor |
| x | X coordinate. | GoogleCloudDocumentaiV1NormalizedVertex | A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. | number |
| y | Y coordinate (starts from the top of the image). | GoogleCloudDocumentaiV1NormalizedVertex | A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. | number |
| x | X coordinate. | GoogleCloudDocumentaiV1Vertex | A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. | integer |
| y | Y coordinate (starts from the top of the image). | GoogleCloudDocumentaiV1Vertex | A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. | integer |
| auditLogConfigs | The configuration for logging of each type of permission. | GoogleIamV1AuditConfig | Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { “audit_configs”: [ { “service”: “allServices”, “audit_log_configs”: [ { “log_type”: “DATA_READ”, “exempted_members”: [ “user:[email protected]” ] }, { “log_type”: “DATA_WRITE” }, { “log_type”: “ADMIN_READ” } ] }, { “service”: “sampleservice.googleapis.com”, “audit_log_configs”: [ { “log_type”: “DATA_READ” }, { “log_type”: “DATA_WRITE”, “exempted_members”: [ “user:[email protected]” ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `[email protected]` from DATA_READ logging, and `[email protected]` from DATA_WRITE logging. | list(GoogleIamV1AuditLogConfig) |
| service | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | GoogleIamV1AuditConfig | Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { “audit_configs”: [ { “service”: “allServices”, “audit_log_configs”: [ { “log_type”: “DATA_READ”, “exempted_members”: [ “user:[email protected]” ] }, { “log_type”: “DATA_WRITE” }, { “log_type”: “ADMIN_READ” } ] }, { “service”: “sampleservice.googleapis.com”, “audit_log_configs”: [ { “log_type”: “DATA_READ” }, { “log_type”: “DATA_WRITE”, “exempted_members”: [ “user:[email protected]” ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `[email protected]` from DATA_READ logging, and `[email protected]` from DATA_WRITE logging. | String |
| exemptedMembers | Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. | GoogleIamV1AuditLogConfig | Provides the configuration for logging a type of permissions. Example: { “audit_log_configs”: [ { “log_type”: “DATA_READ”, “exempted_members”: [ “user:[email protected]” ] }, { “log_type”: “DATA_WRITE” } ] } This enables ‘DATA_READ’ and ‘DATA_WRITE’ logging, while exempting [email protected] from DATA_READ logging. | list(String) |
| logType | The log type that this config enables. | GoogleIamV1AuditLogConfig | Provides the configuration for logging a type of permissions. Example: { “audit_log_configs”: [ { “log_type”: “DATA_READ”, “exempted_members”: [ “user:[email protected]” ] }, { “log_type”: “DATA_WRITE” } ] } This enables ‘DATA_READ’ and ‘DATA_WRITE’ logging, while exempting [email protected] from DATA_READ logging. | String |
| condition | The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | GoogleIamV1Binding | Associates `members`, or principals, with a `role`. | GoogleTypeExpr |
| members | Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `[email protected]`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. | GoogleIamV1Binding | Associates `members`, or principals, with a `role`. | list(String) |
| role | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). | GoogleIamV1Binding | Associates `members`, or principals, with a `role`. | String |
| auditConfigs | Specifies cloud audit logging configuration for this policy. | GoogleIamV1Policy | An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** “` { “bindings”: [ { “role”: “roles/resourcemanager.organizationAdmin”, “members”: [ “user:[email protected]”, “group:[email protected]”, “domain:google.com”, “serviceAccount:[email protected]” ] }, { “role”: “roles/resourcemanager.organizationViewer”, “members”: [ “user:[email protected]” ], “condition”: { “title”: “expirable access”, “description”: “Does not grant access after Sep 2020”, “expression”: “request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). | list(GoogleIamV1AuditConfig) |
| bindings | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | GoogleIamV1Policy | An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** “` { “bindings”: [ { “role”: “roles/resourcemanager.organizationAdmin”, “members”: [ “user:[email protected]”, “group:[email protected]”, “domain:google.com”, “serviceAccount:[email protected]” ] }, { “role”: “roles/resourcemanager.organizationViewer”, “members”: [ “user:[email protected]” ], “condition”: { “title”: “expirable access”, “description”: “Does not grant access after Sep 2020”, “expression”: “request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). | list(GoogleIamV1Binding) |
| etag | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | GoogleIamV1Policy | An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** “` { “bindings”: [ { “role”: “roles/resourcemanager.organizationAdmin”, “members”: [ “user:[email protected]”, “group:[email protected]”, “domain:google.com”, “serviceAccount:[email protected]” ] }, { “role”: “roles/resourcemanager.organizationViewer”, “members”: [ “user:[email protected]” ], “condition”: { “title”: “expirable access”, “description”: “Does not grant access after Sep 2020”, “expression”: “request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). | String |
| version | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | GoogleIamV1Policy | An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** “` { “bindings”: [ { “role”: “roles/resourcemanager.organizationAdmin”, “members”: [ “user:[email protected]”, “group:[email protected]”, “domain:google.com”, “serviceAccount:[email protected]” ] }, { “role”: “roles/resourcemanager.organizationViewer”, “members”: [ “user:[email protected]” ], “condition”: { “title”: “expirable access”, “description”: “Does not grant access after Sep 2020”, “expression”: “request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). | integer |
| dayOfWeek | Day of week, 0 for Sunday, 1 for Monday, … | GoogleInternalAppsWaldoV1alphaAvailabilityPeriod | Represents the information about user’s working hours during one day. Note that a period on Monday from 18:00 – 00:00 is represented as a triplet (1, 1080, 1440). | integer |
| periodEndMinutes | Period end, in minutes from the start of the day, exclusive. | GoogleInternalAppsWaldoV1alphaAvailabilityPeriod | Represents the information about user’s working hours during one day. Note that a period on Monday from 18:00 – 00:00 is represented as a triplet (1, 1080, 1440). | integer |
| periodStartMinutes | Period start, in minutes from the start of the day, inclusive. | GoogleInternalAppsWaldoV1alphaAvailabilityPeriod | Represents the information about user’s working hours during one day. Note that a period on Monday from 18:00 – 00:00 is represented as a triplet (1, 1080, 1440). | integer |
| committedUntil | The time when the user will either stop being committed or change commitment type (i.e. InMeeting, DoNotDisturb, Busy or OutOfOffice < Xh). Note that the goal of this field is to provide information to help users decide how to communicate with a user (see also http://shortn/_wXYXtZScgh). | GoogleInternalAppsWaldoV1alphaCalendarBusy | The status indicating the user is temporarily busy and there is not a more specific status derived from calendar that applies (e.g., InMeeting or DoNotDisturb). | DateTime |
| eventSummary | The summary of the corresponding event in Calendar. | GoogleInternalAppsWaldoV1alphaCalendarBusy | The status indicating the user is temporarily busy and there is not a more specific status derived from calendar that applies (e.g., InMeeting or DoNotDisturb). | String |
| nextAvailable | The next time when the user will be available, i.e., when their status will be neither InMeeting, CalendarBusy, DoNotDisturb, OutsideWorkingHours, nor OutOfOffice. | GoogleInternalAppsWaldoV1alphaCalendarBusy | The status indicating the user is temporarily busy and there is not a more specific status derived from calendar that applies (e.g., InMeeting or DoNotDisturb). | DateTime |
| occupiedUntil | The time when the user will stop being occupied, i.e., when their status will be neither inMeeting, Busy nor DoNotDisturb. | GoogleInternalAppsWaldoV1alphaCalendarBusy | The status indicating the user is temporarily busy and there is not a more specific status derived from calendar that applies (e.g., InMeeting or DoNotDisturb). | DateTime |
| geoCoordinates | Geographic location as geo coordinates. | GoogleInternalAppsWaldoV1alphaCustomLocation | Custom location specified by the user. | GoogleTypeLatLng |
| label | The custom location label as a string entered manually by the user. | GoogleInternalAppsWaldoV1alphaCustomLocation | Custom location specified by the user. | String |
| location | Geographic location as free-form text. | GoogleInternalAppsWaldoV1alphaCustomLocation | Custom location specified by the user. | String |
| committedUntil | The time when the user will either stop being committed or change commitment type (i.e. InMeeting, DoNotDisturb, Busy or OutOfOffice < Xh). Note that the goal of this field is to provide information to help users decide how to communicate with a user (see also http://shortn/_wXYXtZScgh). | GoogleInternalAppsWaldoV1alphaDoNotDisturb | The status indicating the user should not be disturbed. | DateTime |
| nextAvailable | The next time when the user will be available, i.e., when their status will be neither InMeeting, CalendarBusy, DoNotDisturb, OutsideWorkingHours, nor OutOfOffice. | GoogleInternalAppsWaldoV1alphaDoNotDisturb | The status indicating the user should not be disturbed. | DateTime |
| occupiedUntil | The time when the user will stop being occupied, i.e., when their status will be neither inMeeting, Busy nor DoNotDisturb. | GoogleInternalAppsWaldoV1alphaDoNotDisturb | The status indicating the user should not be disturbed. | DateTime |
| committedUntil | The time when the user will either stop being committed or change commitment type (i.e. InMeeting, DoNotDisturb, Busy or OutOfOffice < Xh). Note that the goal of this field is to provide information to help users decide how to communicate with a user (see also http://shortn/_wXYXtZScgh). | GoogleInternalAppsWaldoV1alphaInMeeting | The status indicating the user is in a meeting. | DateTime |
| eventSummary | The summary of the corresponding event in Calendar. | GoogleInternalAppsWaldoV1alphaInMeeting | The status indicating the user is in a meeting. | String |
| inMeetingsUntil | The time when the user will stop being in a meeting. | GoogleInternalAppsWaldoV1alphaInMeeting | The status indicating the user is in a meeting. | DateTime |
| nextAvailable | The next time when the user will be available, i.e., when their status will be neither InMeeting, CalendarBusy, DoNotDisturb, OutsideWorkingHours, nor OutOfOffice. | GoogleInternalAppsWaldoV1alphaInMeeting | The status indicating the user is in a meeting. | DateTime |
| occupiedUntil | The time when the user will stop being occupied, i.e., when their status will be neither InMeeting, Busy nor DoNotDisturb. | GoogleInternalAppsWaldoV1alphaInMeeting | The status indicating the user is in a meeting. | DateTime |
| timeZone | The current time zone of the user. Represented as a valid time zone ID from Olson database, like “Europe/Zurich” (see http://google3/i18n/identifiers/data/timezones.txt). | GoogleInternalAppsWaldoV1alphaLocalTimeContext | Context which helps to determine the user’s local time. | String |
| experimentalBuildingId | Experimental. Can change or disappear without warning or notice. References a building from http://google3/ccc/hosted/api/rosy/resources/calendar/building.proto For example “US-NYC-9TH”. | GoogleInternalAppsWaldoV1alphaOfficeLocation | Office location. | String |
| experimentalDeskId | Experimental. Can change or disappear without warning or notice. The desk id. For example “11E358K”. | GoogleInternalAppsWaldoV1alphaOfficeLocation | Office location. | String |
| experimentalFloorId | Experimental. Can change or disappear without warning or notice. The floor id. For example “11”. | GoogleInternalAppsWaldoV1alphaOfficeLocation | Office location. | String |
| label | The display label of this office location. For example a building name. | GoogleInternalAppsWaldoV1alphaOfficeLocation | Office location. | String |
| comeBackTime | The closest time when the user will be available after this OOO block. This might be different from the end of the OOO block in Calendar, since the OOO block might end on Friday evening, and then the user is outside working hours. | GoogleInternalAppsWaldoV1alphaOutOfOffice | The status indicating the user is out of office. | DateTime |
| committedUntil | The time when the user will either stop being committed or change commitment type (i.e. InMeeting, DoNotDisturb, Busy or OutOfOffice < Xh). Note that the goal of this field is to provide information to help users decide how to communicate with a user (see also http://shortn/_wXYXtZScgh). Note that if this OOO block is large (>=Xh), committed_until is not set. | GoogleInternalAppsWaldoV1alphaOutOfOffice | The status indicating the user is out of office. | DateTime |
| eventSummary | The summary of the corresponding OOO block in Calendar. This is entered by the user, so we return it “as is” – no i18n. | GoogleInternalAppsWaldoV1alphaOutOfOffice | The status indicating the user is out of office. | String |
| comeBackTime | The closest time when the user will be available after this block. This might be different from the start of the working hours in Calendar, because the given OutsideWorkingHours interval might be followed by OOO. | GoogleInternalAppsWaldoV1alphaOutsideWorkingHours | The status indicating the user doesn’t work at this time. | DateTime |
| endTime | End point of the range, exclusive. | GoogleInternalAppsWaldoV1alphaTimeRange | A time range, which includes the start and excludes the end. | DateTime |
| startTime | Starting point of the range, inclusive. | GoogleInternalAppsWaldoV1alphaTimeRange | A time range, which includes the start and excludes the end. | DateTime |
| nextCommitmentStatus | The status of the commitment above. | GoogleInternalAppsWaldoV1alphaUpcomingCommitmentContext | GoogleInternalAppsWaldoV1alphaUserStatus | |
| nextCommitmentTime | The most relevant upcoming commitment (InMeeting, DoNotDisturb, CalendarBusy or OutOfOffice). This context is set only if there is an upcoming commitment to show, and only on non commitments. Priority is given to the next closest commitment if its start is close enough to this event, otherwise the next large OOO if there is one. | GoogleInternalAppsWaldoV1alphaUpcomingCommitmentContext | DateTime | |
| timeRange | The future period of absence. The start of this timerange is the start of the future Out of Office event. The end of this timerange represents the come back time of the user from that future OOO event. Note that the come back time might be different (greater) than the end of the corresponding future OOO event due to other non-working user status intervals that it may be followed by. | GoogleInternalAppsWaldoV1alphaUpcomingOooContext | The context indicating the user’s upcoming Out of Office event. | GoogleInternalAppsWaldoV1alphaTimeRange |
| availabilities | A list of user availabilities having contiguous time ranges which are ordered chronologically. The first one starts at the time of the request or before, and is guaranteed to contain the request time. That means the first element always indicates the current status of a user. A client that wants to display a user’s availability in real time should display the availability whose time range contains the current time. | GoogleInternalAppsWaldoV1alphaUserAvailabilities | The current and future availabilities of a user. The response contains a timeline, which starts before or at the request time, and the timeline is split into a set of disjoint intervals (without gaps), where the first range always contains the request time. Each range represents what should be displayed in the UI during this time range. The time range might be different from the actual time range of the underlying status. For example, if the user is OOO from 09:00 to 10:00, and a request is made at 8:00, the response might contain two intervals: [08:00, 09:00) – “User is INACTIVE, but leaving the office soon” [09:00, 10:00) – “User is OOO till 10:00” For intervals that don’t have a clear availability signal coming from Calendar (e.g. OOO), we return INACTIVE. For more details, please see https://docs.google.com/presentation/d/1ADCTxGawjF9UqMnfuVrVNxGvdyjeiV8h4D7p0a9zYgw/edit#slide=id.g3e2824ac6c_12_94 The service returns availabilities for some short period of time – likely one day, but the client should stick to the “next_poll_time” to decide when to query the server again at the latest. Below there is an example response from the server. Let’s assume the client calls the service at 17:59:45. The client receives the message and, assuming its current time is between [17:59:45, 18:00:00), it displays “inactive”. When the current time becomes 18:00:00 it displays “outside working hours”. At 18:00:40 the client issues another rpc which will return the availabilities for the next minute. The original response looks like availabilities { time_range { start_time: 17:59:45 end_time: 18:00:00 } status { inactive {} } } availabilities { time_range { start_time: 18:00:00 end_time: 18:00:45 } status { outside_working_hours { } } } next_poll_time: 18:00:40 | list(GoogleInternalAppsWaldoV1alphaUserAvailability) |
| nextPollTime | The time at which the client should issue the next availability query for this user. This field should only be used to control the polling frequency. This time is always before the end of the time range of the last availability so that the client always knows the current availability. | GoogleInternalAppsWaldoV1alphaUserAvailabilities | The current and future availabilities of a user. The response contains a timeline, which starts before or at the request time, and the timeline is split into a set of disjoint intervals (without gaps), where the first range always contains the request time. Each range represents what should be displayed in the UI during this time range. The time range might be different from the actual time range of the underlying status. For example, if the user is OOO from 09:00 to 10:00, and a request is made at 8:00, the response might contain two intervals: [08:00, 09:00) – “User is INACTIVE, but leaving the office soon” [09:00, 10:00) – “User is OOO till 10:00” For intervals that don’t have a clear availability signal coming from Calendar (e.g. OOO), we return INACTIVE. For more details, please see https://docs.google.com/presentation/d/1ADCTxGawjF9UqMnfuVrVNxGvdyjeiV8h4D7p0a9zYgw/edit#slide=id.g3e2824ac6c_12_94 The service returns availabilities for some short period of time – likely one day, but the client should stick to the “next_poll_time” to decide when to query the server again at the latest. Below there is an example response from the server. Let’s assume the client calls the service at 17:59:45. The client receives the message and, assuming its current time is between [17:59:45, 18:00:00), it displays “inactive”. When the current time becomes 18:00:00 it displays “outside working hours”. At 18:00:40 the client issues another rpc which will return the availabilities for the next minute. The original response looks like availabilities { time_range { start_time: 17:59:45 end_time: 18:00:00 } status { inactive {} } } availabilities { time_range { start_time: 18:00:00 end_time: 18:00:45 } status { outside_working_hours { } } } next_poll_time: 18:00:40 | DateTime |
| workingHours | Information about the user’s working hours. This will only be set in case working hours are enabled in their calendar settings. | GoogleInternalAppsWaldoV1alphaUserAvailabilities | The current and future availabilities of a user. The response contains a timeline, which starts before or at the request time, and the timeline is split into a set of disjoint intervals (without gaps), where the first range always contains the request time. Each range represents what should be displayed in the UI during this time range. The time range might be different from the actual time range of the underlying status. For example, if the user is OOO from 09:00 to 10:00, and a request is made at 8:00, the response might contain two intervals: [08:00, 09:00) – “User is INACTIVE, but leaving the office soon” [09:00, 10:00) – “User is OOO till 10:00” For intervals that don’t have a clear availability signal coming from Calendar (e.g. OOO), we return INACTIVE. For more details, please see https://docs.google.com/presentation/d/1ADCTxGawjF9UqMnfuVrVNxGvdyjeiV8h4D7p0a9zYgw/edit#slide=id.g3e2824ac6c_12_94 The service returns availabilities for some short period of time – likely one day, but the client should stick to the “next_poll_time” to decide when to query the server again at the latest. Below there is an example response from the server. Let’s assume the client calls the service at 17:59:45. The client receives the message and, assuming its current time is between [17:59:45, 18:00:00), it displays “inactive”. When the current time becomes 18:00:00 it displays “outside working hours”. At 18:00:40 the client issues another rpc which will return the availabilities for the next minute. The original response looks like availabilities { time_range { start_time: 17:59:45 end_time: 18:00:00 } status { inactive {} } } availabilities { time_range { start_time: 18:00:00 end_time: 18:00:45 } status { outside_working_hours { } } } next_poll_time: 18:00:40 | GoogleInternalAppsWaldoV1alphaWorkingHours |
| contexts | The contexts contain additional information about the current user’s availability or its upcoming changes. The client doesn’t need to extract certain bits to visualize the status or apply custom logic based on the content of this field: the status field should contain everything needed for the correct visualization. | GoogleInternalAppsWaldoV1alphaUserAvailability | A single availability range. The displayed status should be the same during the entire time range. | GoogleInternalAppsWaldoV1alphaUserContext |
| status | The user status during the time range. | GoogleInternalAppsWaldoV1alphaUserAvailability | A single availability range. The displayed status should be the same during the entire time range. | GoogleInternalAppsWaldoV1alphaUserStatus |
| timeRange | The time range when this availability should be displayed. | GoogleInternalAppsWaldoV1alphaUserAvailability | A single availability range. The displayed status should be the same during the entire time range. | GoogleInternalAppsWaldoV1alphaTimeRange |
| localTime | Helps to determine the user’s local time by providing their current time zone. | GoogleInternalAppsWaldoV1alphaUserContext | Additional context about the user’s current and/or future availability to give a better understanding of the status (“Working from Zurich”). | GoogleInternalAppsWaldoV1alphaLocalTimeContext |
| upcomingCommitmentContext | Information about upcoming events. | GoogleInternalAppsWaldoV1alphaUserContext | Additional context about the user’s current and/or future availability to give a better understanding of the status (“Working from Zurich”). | GoogleInternalAppsWaldoV1alphaUpcomingCommitmentContext |
| upcomingOoo | Set if user has upcoming OOO. | GoogleInternalAppsWaldoV1alphaUserContext | Additional context about the user’s current and/or future availability to give a better understanding of the status (“Working from Zurich”). | GoogleInternalAppsWaldoV1alphaUpcomingOooContext |
| workingElsewhere | Set if the user has a working location. Not just elsewhere (legacy name). | GoogleInternalAppsWaldoV1alphaUserContext | Additional context about the user’s current and/or future availability to give a better understanding of the status (“Working from Zurich”). | GoogleInternalAppsWaldoV1alphaWorkingElsewhereContext |
| customLocation | Indicates the user is working from some other location. | GoogleInternalAppsWaldoV1alphaUserLocation | Location of the user, which might be “home”, for example, or an office building, as well as a custom location specified by the user. | GoogleInternalAppsWaldoV1alphaCustomLocation |
| homeLocation | Indicates the user is working from home. | GoogleInternalAppsWaldoV1alphaUserLocation | Location of the user, which might be “home”, for example, or an office building, as well as a custom location specified by the user. | GoogleInternalAppsWaldoV1alphaHomeLocation |
| officeLocation | Indicates the user is working from the office. | GoogleInternalAppsWaldoV1alphaUserLocation | Location of the user, which might be “home”, for example, or an office building, as well as a custom location specified by the user. | GoogleInternalAppsWaldoV1alphaOfficeLocation |
| calendarBusy | Set if the user is temporarily busy and there is not a more specific status derived from calendar that applies (e.g., InMeeting or DoNotDisturb). | GoogleInternalAppsWaldoV1alphaUserStatus | The actual status of the user. The message contains everything needed for visualisation of this status. | GoogleInternalAppsWaldoV1alphaCalendarBusy |
| doNotDisturb | Set if the user is in a Focus Time block. Note that this is different than Chat’s Do not disturb status, but they may coincide, see: go/focus-time-dnd. | GoogleInternalAppsWaldoV1alphaUserStatus | The actual status of the user. The message contains everything needed for visualisation of this status. | GoogleInternalAppsWaldoV1alphaDoNotDisturb |
| inMeeting | Set if the user is in a meeting. | GoogleInternalAppsWaldoV1alphaUserStatus | The actual status of the user. The message contains everything needed for visualisation of this status. | GoogleInternalAppsWaldoV1alphaInMeeting |
| inactive | Set if no other statuses apply. | GoogleInternalAppsWaldoV1alphaUserStatus | The actual status of the user. The message contains everything needed for visualisation of this status. | GoogleInternalAppsWaldoV1alphaInactive |
| outOfOffice | Set if the user is out of office. | GoogleInternalAppsWaldoV1alphaUserStatus | The actual status of the user. The message contains everything needed for visualisation of this status. | GoogleInternalAppsWaldoV1alphaOutOfOffice |
| outsideWorkingHours | Set if the user doesn’t work at this time. | GoogleInternalAppsWaldoV1alphaUserStatus | The actual status of the user. The message contains everything needed for visualisation of this status. | GoogleInternalAppsWaldoV1alphaOutsideWorkingHours |
| location | The new location of the user. Might represent home, office, or a custom address on the map. | GoogleInternalAppsWaldoV1alphaWorkingElsewhereContext | The context providing the User Location (not just Elsewhere). This is a legacy name from when it was only set for users working remotely, now it is also set when the user is working from the office. | GoogleInternalAppsWaldoV1alphaUserLocation |
| availableTime | A list of availability periods representing the user’s working hours as configured in calendar. | GoogleInternalAppsWaldoV1alphaWorkingHours | Information about the user’s working hours. | list(GoogleInternalAppsWaldoV1alphaAvailabilityPeriod) |
| app | app is the tachyon client application that generated or is to receive a message. | GoogleInternalCommunicationsInstantmessagingV1Id | Id for message recipients, e.g. users, groups etc. | String |
| countryCode | country_code is the E164_COUNTRY_CODE format country code for this id, used as a hint for its region. E.g, “+1” will be used for North America, “+86” will be used for China, etc. Should be filled only for RCS group id. | GoogleInternalCommunicationsInstantmessagingV1Id | Id for message recipients, e.g. users, groups etc. | String |
| id | id is a unique (for this type and app) identifier of a message source or recipient. | GoogleInternalCommunicationsInstantmessagingV1Id | Id for message recipients, e.g. users, groups etc. | String |
| locationHint | location_hint is used as a hint for the user’s region. | GoogleInternalCommunicationsInstantmessagingV1Id | Id for message recipients, e.g. users, groups etc. | GoogleInternalCommunicationsInstantmessagingV1LocationHint |
| routingInfoToken | Raw byte array containing encoded routing information. Clients of Tachyon are expected to include the most recent routing_info_cookie that they have received from the server in the requests that they make. Its format is purposely opaque so that clients do not need to concern themselves with the content of this field. This field is expected to be used primarily by Tachygram clients for go/tachygram-groups to simplify the API contract for group operations while reducing the need for unnecessary lookups. | GoogleInternalCommunicationsInstantmessagingV1Id | Id for message recipients, e.g. users, groups etc. | String |
| type | type defines what the id field contains, e.g. phone number, Fi-number, Gaia ID etc. | GoogleInternalCommunicationsInstantmessagingV1Id | Id for message recipients, e.g. users, groups etc. | String |
| format | the format of location. | GoogleInternalCommunicationsInstantmessagingV1LocationHint | LocationHint is used to specify a location as well as format. | String |
| location | Location is the location, provided in the format specified by format. | GoogleInternalCommunicationsInstantmessagingV1LocationHint | LocationHint is used to specify a location as well as format. | String |
| done | If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. | GoogleLongrunningOperation | This resource represents a long-running operation that is the result of a network API call. | boolean |
| error | The error result of the operation in case of failure or cancellation. | GoogleLongrunningOperation | This resource represents a long-running operation that is the result of a network API call. | GoogleRpcStatus |
| metadata | Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. | GoogleLongrunningOperation | This resource represents a long-running operation that is the result of a network API call. | map |
| name | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | GoogleLongrunningOperation | This resource represents a long-running operation that is the result of a network API call. | String |
| response | The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. | GoogleLongrunningOperation | This resource represents a long-running operation that is the result of a network API call. | map |
| code | The status code, which should be an enum value of google.rpc.Code. | GoogleRpcStatus | The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). | integer |
| details | A list of messages that carry the error details. There is a common set of message types for APIs to use. | GoogleRpcStatus | The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). | list(map) |
| message | A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. | GoogleRpcStatus | The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). | String |
| alpha | The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 – alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0). | GoogleTypeColor | Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor’s `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn’t have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // … public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // … Example (iOS / Obj-C): // … static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... | number |
| blue | The amount of blue in the color as a value in the interval [0, 1]. | GoogleTypeColor | Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor’s `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn’t have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // … public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // … Example (iOS / Obj-C): // … static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... | number |
| green | The amount of green in the color as a value in the interval [0, 1]. | GoogleTypeColor | Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor’s `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn’t have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // … public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // … Example (iOS / Obj-C): // … static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... | number |
| red | The amount of red in the color as a value in the interval [0, 1]. | GoogleTypeColor | Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor’s `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn’t have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // … public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // … Example (iOS / Obj-C): // … static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... | number |
| day | Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn’t significant. | GoogleTypeDate | Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp | integer |
| month | Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. | GoogleTypeDate | Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp | integer |
| year | Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. | GoogleTypeDate | Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp | integer |
| day | Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. | GoogleTypeDateTime | Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user’s timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application’s limitations. | integer |
| hours | Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value “24:00:00” for scenarios like business closing time. | GoogleTypeDateTime | Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user’s timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application’s limitations. | integer |
| minutes | Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. | GoogleTypeDateTime | Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user’s timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application’s limitations. | integer |
| month | Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month. | GoogleTypeDateTime | Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user’s timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application’s limitations. | integer |
| nanos | Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0. | GoogleTypeDateTime | Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user’s timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application’s limitations. | integer |
| seconds | Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds. | GoogleTypeDateTime | Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user’s timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application’s limitations. | integer |
| timeZone | Time zone. | GoogleTypeDateTime | Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user’s timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application’s limitations. | GoogleTypeTimeZone |
| utcOffset | UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. | GoogleTypeDateTime | Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user’s timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application’s limitations. | String |
| year | Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. | GoogleTypeDateTime | Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user’s timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application’s limitations. | integer |
| description | Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. | GoogleTypeExpr | Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: “Summary size limit” description: “Determines if a summary is less than 100 chars” expression: “document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. | String |
| expression | Textual representation of an expression in Common Expression Language syntax. | GoogleTypeExpr | Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: “Summary size limit” description: “Determines if a summary is less than 100 chars” expression: “document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. | String |
| location | Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. | GoogleTypeExpr | Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: “Summary size limit” description: “Determines if a summary is less than 100 chars” expression: “document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. | String |
| title | Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. | GoogleTypeExpr | Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: “Summary size limit” description: “Determines if a summary is less than 100 chars” expression: “document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. | String |
| endTime | Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. | GoogleTypeInterval | Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. | DateTime |
| startTime | Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. | GoogleTypeInterval | Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. | DateTime |
| latitude | The latitude in degrees. It must be in the range [-90.0, +90.0]. | GoogleTypeLatLng | An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. | float |
| longitude | The longitude in degrees. It must be in the range [-180.0, +180.0]. | GoogleTypeLatLng | An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. | float |
| currencyCode | The three-letter currency code defined in ISO 4217. | GoogleTypeMoney | Represents an amount of money with its currency type. | String |
| nanos | Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. | GoogleTypeMoney | Represents an amount of money with its currency type. | integer |
| units | The whole units of the amount. For example if `currencyCode` is `”USD”`, then 1 unit is one US dollar. | GoogleTypeMoney | Represents an amount of money with its currency type. | String |
| addressLines | Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. “Austin, TX”), it is important that the line order is clear. The order of address lines should be “envelope order” for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. “ja” for large-to-small ordering and “ja-Latn” or “en” for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). | GoogleTypePostalAddress | Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: – Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) – Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 | list(String) |
| administrativeArea | Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. “Barcelona” and not “Catalonia”). Many countries don’t use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated. | GoogleTypePostalAddress | Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: – Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) – Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 | String |
| languageCode | Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address’ country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: “zh-Hant”, “ja”, “ja-Latn”, “en”. | GoogleTypePostalAddress | Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: – Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) – Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 | String |
| locality | Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines. | GoogleTypePostalAddress | Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: – Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) – Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 | String |
| organization | Optional. The name of the organization at the address. | GoogleTypePostalAddress | Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: – Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) – Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 | String |
| postalCode | Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.). | GoogleTypePostalAddress | Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: – Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) – Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 | String |
| recipients | Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain “care of” information. | GoogleTypePostalAddress | Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: – Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) – Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 | list(String) |
| regionCode | Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: “CH” for Switzerland. | GoogleTypePostalAddress | Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: – Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) – Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 | String |
| revision | The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. | GoogleTypePostalAddress | Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: – Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) – Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 | integer |
| sortingCode | Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like “CEDEX”, optionally followed by a number (e.g. “CEDEX 7”), or just a number alone, representing the “sector code” (Jamaica), “delivery area indicator” (Malawi) or “post office indicator” (e.g. Côte d’Ivoire). | GoogleTypePostalAddress | Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: – Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) – Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 | String |
| sublocality | Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. | GoogleTypePostalAddress | Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: – Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) – Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 | String |
| hours | Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value “24:00:00” for scenarios like business closing time. | GoogleTypeTimeOfDay | Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. | integer |
| minutes | Minutes of hour of day. Must be from 0 to 59. | GoogleTypeTimeOfDay | Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. | integer |
| nanos | Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. | GoogleTypeTimeOfDay | Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. | integer |
| seconds | Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. | GoogleTypeTimeOfDay | Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. | integer |
| id | IANA Time Zone Database time zone, e.g. “America/New_York”. | GoogleTypeTimeZone | Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). | String |
| version | Optional. IANA Time Zone Database version number, e.g. “2019a”. | GoogleTypeTimeZone | Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). | String |
| AuthorId | GroupsPerDocData | String | ||
| GroupGaiaId | GroupsPerDocData | String | ||
| GroupId | Legacy group mysql id. | GroupsPerDocData | String | |
| ThreadId | GroupsPerDocData | String | ||
| agentDeviceId | The device ID defined by the agent. | HomeGraphCommonRoute | String | |
| agentId | The agent’s ID. Generally it is the agent’s Google cloud project id. | HomeGraphCommonRoute | String | |
| chipEndpoint | chip endpoint index (if the target is CHIP). Set packed = true to handle error caused by b/32953375 when exporting this data. Note that we should never change this to non-repeated: a packed field will not work properly if you change the field to non-repeated later. | HomeGraphCommonRoute | list(integer) | |
| targetType | Execution routing target. | HomeGraphCommonRoute | String | |
| supportedRoutes | List of supported execution route. | HomeGraphCommonRoutingTable | Defines execution routing information for Traits, which will be used to be mapped for each Trait as following: map traits_to_routing_table_map = X; We’ll use this for CHIP first. And expect to migrate the existing routing logic to this gradually. | list(HomeGraphCommonRoute) |
| cloudFulfillmentOnly | Set to true for a non-local trait. | HomeGraphCommonTraitRoutingHints | LINT.IfChange go/shed-per-trait-routing. Making it object to allow for extendible design, where we can add attributes in future. | boolean |
| trait | Trait name, e.g., “action.devices.traits.MediaInitiation”. See [device traits](https://developers.home.google.com/cloud-to-cloud/traits). See java/com/google/home/graph/common/devices/config/protoconf.pi for the exhaustive list of trait-strings. | HomeGraphCommonTraitRoutingHints | LINT.IfChange go/shed-per-trait-routing. Making it object to allow for extendible design, where we can add attributes in future. | String |
| name | HtmlrenderWebkitHeadlessProtoAnonTimingStatPair | TimingStatPair message stores a timing period name and a time value. This is intentionally vague for doing fine level timing of rendering as what we measure is likely to change as we iterate. The intention is also that these values will just be dumped to varzs for evaluation purposed and not used programmatically. | String | |
| timeS | HtmlrenderWebkitHeadlessProtoAnonTimingStatPair | TimingStatPair message stores a timing period name and a time value. This is intentionally vague for doing fine level timing of rendering as what we measure is likely to change as we iterate. The intention is also that these values will just be dumped to varzs for evaluation purposed and not used programmatically. | float | |
| height | HtmlrenderWebkitHeadlessProtoBox | A simple 2D box represented by an (x, y) coordinate, a width, and a height. Coordinates are in pixels. | integer | |
| width | HtmlrenderWebkitHeadlessProtoBox | A simple 2D box represented by an (x, y) coordinate, a width, and a height. Coordinates are in pixels. | integer | |
| x | on horizontal axis | HtmlrenderWebkitHeadlessProtoBox | A simple 2D box represented by an (x, y) coordinate, a width, and a height. Coordinates are in pixels. | integer |
| y | on vertical axis | HtmlrenderWebkitHeadlessProtoBox | A simple 2D box represented by an (x, y) coordinate, a width, and a height. Coordinates are in pixels. | integer |
| chromiumTrace | Populated if Chromium traces are requested in JSON format. | HtmlrenderWebkitHeadlessProtoChromiumTrace | A message to describe the trace events returned by Chromium. | String |
| chromiumTraceProto | Populated if Chromium traces are requested in PROTO format. | HtmlrenderWebkitHeadlessProtoChromiumTrace | A message to describe the trace events returned by Chromium. | String |
| lineNumber | Line number of the document which caused an error. | HtmlrenderWebkitHeadlessProtoConsoleLogEntry | ConsoleLogEntry message stores messages logged by the renderer to the console. Typically error messages related to JS execution, parsing, any CSS errors, etc are logged by the renderer to the console. Next id: 7. | integer |
| message | Message which indicates the nature of the error. e.g. parse error, reference error (happens when javascript functions or variables are not resolvable) etc. | HtmlrenderWebkitHeadlessProtoConsoleLogEntry | ConsoleLogEntry message stores messages logged by the renderer to the console. Typically error messages related to JS execution, parsing, any CSS errors, etc are logged by the renderer to the console. Next id: 7. | String |
| messageLevel | message level | HtmlrenderWebkitHeadlessProtoConsoleLogEntry | ConsoleLogEntry message stores messages logged by the renderer to the console. Typically error messages related to JS execution, parsing, any CSS errors, etc are logged by the renderer to the console. Next id: 7. | String |
| sourceUrl | The url of the document which has the error. | HtmlrenderWebkitHeadlessProtoConsoleLogEntry | ConsoleLogEntry message stores messages logged by the renderer to the console. Typically error messages related to JS execution, parsing, any CSS errors, etc are logged by the renderer to the console. Next id: 7. | String |
| stackTrace | Stack trace which functions were called when generating the console log. The first frame is the innermost one. | HtmlrenderWebkitHeadlessProtoConsoleLogEntry | ConsoleLogEntry message stores messages logged by the renderer to the console. Typically error messages related to JS execution, parsing, any CSS errors, etc are logged by the renderer to the console. Next id: 7. | list(HtmlrenderWebkitHeadlessProtoScriptStackFrame) |
| timestamp | Wall time (s) when the log entry was recorded | HtmlrenderWebkitHeadlessProtoConsoleLogEntry | ConsoleLogEntry message stores messages logged by the renderer to the console. Typically error messages related to JS execution, parsing, any CSS errors, etc are logged by the renderer to the console. Next id: 7. | float |
| domain | HtmlrenderWebkitHeadlessProtoCookie | String | ||
| expiration | HtmlrenderWebkitHeadlessProtoCookie | float | ||
| httpOnly | HtmlrenderWebkitHeadlessProtoCookie | boolean | ||
| name | HtmlrenderWebkitHeadlessProtoCookie | String | ||
| path | HtmlrenderWebkitHeadlessProtoCookie | String | ||
| sameSite | HtmlrenderWebkitHeadlessProtoCookie | String | ||
| secure | HtmlrenderWebkitHeadlessProtoCookie | boolean | ||
| value | HtmlrenderWebkitHeadlessProtoCookie | String | ||
| baseUri | Document’s base uri. | HtmlrenderWebkitHeadlessProtoDocument | Next available tag: 24 | String |
| charset | Document’s charset. | HtmlrenderWebkitHeadlessProtoDocument | Next available tag: 24 | String |
| contentHeight | HtmlrenderWebkitHeadlessProtoDocument | Next available tag: 24 | integer | |
| contentLanguage | Document’s language. | HtmlrenderWebkitHeadlessProtoDocument | Next available tag: 24 | String |
| contentWidth | These fields contain the actual width and height of the document content, which may exceed the size of the rendering viewport. *DEPRECATED* Use rendered_content_area instead. These two fields always assume the content area begins at viewport coordinates (0,0). | HtmlrenderWebkitHeadlessProtoDocument | Next available tag: 24 | integer |
| domTreeNode | A flat list of all the DOMTreeNodes in the DOM. A flat list is preferred to a tree to avoid recursion and potential stack overflows. Note that the first node in this list will always be the root node. | HtmlrenderWebkitHeadlessProtoDocument | Next available tag: 24 | list(HtmlrenderWebkitHeadlessProtoDOMTreeNode) |
| frameId | A unique identifier for the frame (browser window of iframe) this document is loaded in. This identifier matches the identifiers used in the timeline data to identify frames and therefore only set if the record_timeline field of the RenderRequest message was set to true. frame_id is not supported on Chromium. | HtmlrenderWebkitHeadlessProtoDocument | Next available tag: 24 | String |
| frameName | The name of the frame (browser window of iframe) this document is loaded in. May not be set if the frame name was empty. | HtmlrenderWebkitHeadlessProtoDocument | Next available tag: 24 | String |
| javascriptTimeOfDay | ————————————————————————– Input context. These fields are copied from RenderRequest so that Document can be a self contained protobuf. We would’ve liked to place them in a ## nested InputContext message but it’s too late now. ## Time specified to RenderRequest.JavaScriptOptions.time_of_day, if any. ## End of input context. Output-only fields below. | HtmlrenderWebkitHeadlessProtoDocument | Next available tag: 24 | float |
| redirectHop | The chain of redirects (and redirect methods) used to get to the final resource for this Document. Deprecated: Use the redirect events in the render_event field instead. | HtmlrenderWebkitHeadlessProtoDocument | Next available tag: 24 | list(HtmlrenderWebkitHeadlessProtoRedirectHop) |
| referencedResource | Contains a list of Resources which the renderer requested — both those that were found and those that were not. Resources are returned in the order that they were requested. | HtmlrenderWebkitHeadlessProtoDocument | Next available tag: 24 | list(HtmlrenderWebkitHeadlessProtoReferencedResource) |
| renderEvent | Different types of events which happened during rendering. All events for this document’s frame are included, so for example if a confirmation dialog is created before a client redirect to this document the ConfirmationDialogEvent will still be included even though the dialog was created by a different document. See render_event.proto for the types of events which are recorded. Note that this is present regardless of whether record_timeline was set in the RenderRequest. | HtmlrenderWebkitHeadlessProtoDocument | Next available tag: 24 | list(HtmlrenderWebkitHeadlessProtoRenderEvent) |
| renderStyle | See htmlrender_webkit_headless_utils::SerializeRenderStyle() if a serialized css string is wanted. | HtmlrenderWebkitHeadlessProtoDocument | Next available tag: 24 | list(HtmlrenderWebkitHeadlessProtoStyle) |
| renderTreeNode | A flat list of all the RenderTreeNodes from the render tree. A flat list is preferred to a tree to avoid recursion and potential stack overflows. Note that the first node in this list will always be the RenderTreeNode for the #document node (aka root). | HtmlrenderWebkitHeadlessProtoDocument | Next available tag: 24 | list(HtmlrenderWebkitHeadlessProtoRenderTreeNode) |
| renderTreeQualityScore | DEPRECATED – This field to be removed mid-2011. If you need this, use the library directly: //google3/htmlrender/webkit_headless/snapshot_quality Indicates how good or bad the rendering is from the perspective of the render tree. This is different from snapshot_quality_score in that the quality analysis examines everything that can be rendered, not just the portion within the document’s viewport. It also ignores missing resouces with fixed width/height specified in the tag. A score of 1 (100%) implies the entire document can be rendered at the best quality and a score of 0 implies the entire document is unusable. | HtmlrenderWebkitHeadlessProtoDocument | Next available tag: 24 | float |
| renderedContentArea | The bounding box which represents the whole area of rendered content, which may exceed the size of the rendering viewport. It doesn’t include the body’s margin. | HtmlrenderWebkitHeadlessProtoDocument | Next available tag: 24 | HtmlrenderWebkitHeadlessProtoBox |
| scrollX | Scroll offset of this document within the frame. Note that if expand_frame_to_content_height or expand_frame_to_content_width is true, this field reflects the final scroll offset after frame expansion. | HtmlrenderWebkitHeadlessProtoDocument | Next available tag: 24 | integer |
| scrollY | HtmlrenderWebkitHeadlessProtoDocument | Next available tag: 24 | integer | |
| snapshotQualityScore | DEPRECATED – This field to be removed mid-2011. If you need this, use the library directly: //google3/htmlrender/webkit_headless/snapshot_quality Indicates how good or bad the rendered snapshot is within the rendered content area within the document’s viewport. A score of 1 (100%) implies the snapshot is of best quality and a score of 0 implies the snapshot is unusable. | HtmlrenderWebkitHeadlessProtoDocument | Next available tag: 24 | float |
| title | Document’s title. | HtmlrenderWebkitHeadlessProtoDocument | Next available tag: 24 | String |
| uri | Document uri is the URL that this document was fetched from. The displayed URL and base URL may be different. If this document was not fetched from any URL (e.g. iframe with no src, populated by script) uri will be “about:blank”. | HtmlrenderWebkitHeadlessProtoDocument | Next available tag: 24 | String |
| viewport | The page’s layout size. | HtmlrenderWebkitHeadlessProtoDocument | Next available tag: 24 | HtmlrenderWebkitHeadlessProtoBox |
| key | HtmlrenderWebkitHeadlessProtoDOMStorageItem | String | ||
| securityOrigin | HtmlrenderWebkitHeadlessProtoDOMStorageItem | String | ||
| value | HtmlrenderWebkitHeadlessProtoDOMStorageItem | String | ||
| attribute | HtmlrenderWebkitHeadlessProtoDOMTreeNode | DOMTreeNode Defines a DOM Node. An instance can contain references to one or more children (of type DOMTreeNode) and one or more attributes. The DOMTreeNode also encapsulates rendering information (if applicable) in the form of references to one or more RenderTreeNodes. Next tag available: 16 | list(HtmlrenderWebkitHeadlessProtoDOMTreeNodeAttribute) | |
| childDomTreeNodeIndex | An index per child. Indexes can be used to fetch the DOMTreeNodes from the list maintained by the Document. | HtmlrenderWebkitHeadlessProtoDOMTreeNode | DOMTreeNode Defines a DOM Node. An instance can contain references to one or more children (of type DOMTreeNode) and one or more attributes. The DOMTreeNode also encapsulates rendering information (if applicable) in the form of references to one or more RenderTreeNodes. Next tag available: 16 | list(integer) |
| currentSourceUrl | For elements, the actual url that was used to fetch the image. Note that this field is set only if it is different from the ‘src’ attribute value. | HtmlrenderWebkitHeadlessProtoDOMTreeNode | DOMTreeNode Defines a DOM Node. An instance can contain references to one or more children (of type DOMTreeNode) and one or more attributes. The DOMTreeNode also encapsulates rendering information (if applicable) in the form of references to one or more RenderTreeNodes. Next tag available: 16 | String |
| document | If the node represents an iframe or a frame then document will be set. | HtmlrenderWebkitHeadlessProtoDOMTreeNode | DOMTreeNode Defines a DOM Node. An instance can contain references to one or more children (of type DOMTreeNode) and one or more attributes. The DOMTreeNode also encapsulates rendering information (if applicable) in the form of references to one or more RenderTreeNodes. Next tag available: 16 | HtmlrenderWebkitHeadlessProtoDocument |
| htmlTagType | Identifies the HTML tag type (IMG, P, DIV, etc). Applicable only for DOM nodes that are representative of html elements. For a list of possible types refer HtmlTagEnum defined in webutil/html/htmltagenum.h. | HtmlrenderWebkitHeadlessProtoDOMTreeNode | DOMTreeNode Defines a DOM Node. An instance can contain references to one or more children (of type DOMTreeNode) and one or more attributes. The DOMTreeNode also encapsulates rendering information (if applicable) in the form of references to one or more RenderTreeNodes. Next tag available: 16 | integer |
| isClickable | Whether this DOM node responds to mouse clicks. This includes e.g. nodes that have had click event listeners attached via JavaScript as well as e.g. anchor tags that naturally navigate when clicked. | HtmlrenderWebkitHeadlessProtoDOMTreeNode | DOMTreeNode Defines a DOM Node. An instance can contain references to one or more children (of type DOMTreeNode) and one or more attributes. The DOMTreeNode also encapsulates rendering information (if applicable) in the form of references to one or more RenderTreeNodes. Next tag available: 16 | boolean |
| name | Name of the node (document, text, comment, div, etc). | HtmlrenderWebkitHeadlessProtoDOMTreeNode | DOMTreeNode Defines a DOM Node. An instance can contain references to one or more children (of type DOMTreeNode) and one or more attributes. The DOMTreeNode also encapsulates rendering information (if applicable) in the form of references to one or more RenderTreeNodes. Next tag available: 16 | String |
| originUrl | URL of the script, if any, which created or populated this node. | HtmlrenderWebkitHeadlessProtoDOMTreeNode | DOMTreeNode Defines a DOM Node. An instance can contain references to one or more children (of type DOMTreeNode) and one or more attributes. The DOMTreeNode also encapsulates rendering information (if applicable) in the form of references to one or more RenderTreeNodes. Next tag available: 16 | String |
| referencedResourceIndex | List of referenced resource indexes for any resources that this DOM tree node references. | HtmlrenderWebkitHeadlessProtoDOMTreeNode | DOMTreeNode Defines a DOM Node. An instance can contain references to one or more children (of type DOMTreeNode) and one or more attributes. The DOMTreeNode also encapsulates rendering information (if applicable) in the form of references to one or more RenderTreeNodes. Next tag available: 16 | list(integer) |
| renderTreeNodeIndex | RenderTreeNode can be looked up from the list of RenderTreeNodes stored in the Document using render_tree_node_index. RenderTreeNode gives rendering information (bounding box, style that was applied, etc). Note: 1. If a DOMTreeNode does not have a RenderTreeNode then it is safe to assume that the DOMTreeNode has no effect on the rendering. DOMTreeNodes for a , | HtmlrenderWebkitHeadlessProtoDOMTreeNode | DOMTreeNode Defines a DOM Node. An instance can contain references to one or more children (of type DOMTreeNode) and one or more attributes. The DOMTreeNode also encapsulates rendering information (if applicable) in the form of references to one or more RenderTreeNodes. Next tag available: 16 | list(integer) |
| type | HtmlrenderWebkitHeadlessProtoDOMTreeNode | DOMTreeNode Defines a DOM Node. An instance can contain references to one or more children (of type DOMTreeNode) and one or more attributes. The DOMTreeNode also encapsulates rendering information (if applicable) in the form of references to one or more RenderTreeNodes. Next tag available: 16 | String | |
| value | The node value is applicable for TEXT_NODEs, DOCUMENT_TYPE_NODEs, COMMENT_NODEs, and user input elements such as , and | HtmlrenderWebkitHeadlessProtoDOMTreeNode | DOMTreeNode Defines a DOM Node. An instance can contain references to one or more children (of type DOMTreeNode) and one or more attributes. The DOMTreeNode also encapsulates rendering information (if applicable) in the form of references to one or more RenderTreeNodes. Next tag available: 16 | String |
| htmlAttributeType | Identifies the HTML attribute type (src, width, height, etc). For a list of possible types refer HtmlAttributeEnum defined in webutil/html/htmlattrenum.h. | HtmlrenderWebkitHeadlessProtoDOMTreeNodeAttribute | Zero or more attributes for the node. | integer |
| name | HtmlrenderWebkitHeadlessProtoDOMTreeNodeAttribute | Zero or more attributes for the node. | String | |
| value | HtmlrenderWebkitHeadlessProtoDOMTreeNodeAttribute | Zero or more attributes for the node. | String | |
| resizeType | HtmlrenderWebkitHeadlessProtoFrameResizeEvent | Event for frame resize. Currently we only record resize events caused by automatic frame expansion. | String | |
| visibleRectAfterResize | HtmlrenderWebkitHeadlessProtoFrameResizeEvent | Event for frame resize. Currently we only record resize events caused by automatic frame expansion. | HtmlrenderWebkitHeadlessProtoBox | |
| visibleRectBeforeResize | HtmlrenderWebkitHeadlessProtoFrameResizeEvent | Event for frame resize. Currently we only record resize events caused by automatic frame expansion. | HtmlrenderWebkitHeadlessProtoBox | |
| data | The binary image data, stored in a format decided by the application and a particular RenderService implementation. | HtmlrenderWebkitHeadlessProtoImage | String | |
| height | HtmlrenderWebkitHeadlessProtoImage | integer | ||
| pageNumber | The page number if this is an image of a page from a print-mode rendering. | HtmlrenderWebkitHeadlessProtoImage | integer | |
| viewport | The viewport from which this image was generated. This is relative to the upper left of the page’s document. | HtmlrenderWebkitHeadlessProtoImage | HtmlrenderWebkitHeadlessProtoBox | |
| width | The width and height of the image stored in the data field. | HtmlrenderWebkitHeadlessProtoImage | integer | |
| url | HtmlrenderWebkitHeadlessProtoInitialLoadEvent | Event for the initial load of a frame, including main frame and subframes. | String | |
| confirmed | Whether a confirm() or prompt() dialog was confirmed. Will not be present for an alert() dialog. | HtmlrenderWebkitHeadlessProtoModalDialogEvent | Event for a modal dialog created by one of window.confirm(), window.prompt(), or window.alert(). | boolean |
| message | HtmlrenderWebkitHeadlessProtoModalDialogEvent | Event for a modal dialog created by one of window.confirm(), window.prompt(), or window.alert(). | String | |
| result | For a prompt() dialog, the result of the prompt. Will not be present for other types of dialogs. If confirmed == false and the prompt had a default value, result will contain the default value. | HtmlrenderWebkitHeadlessProtoModalDialogEvent | Event for a modal dialog created by one of window.confirm(), window.prompt(), or window.alert(). | String |
| type | HtmlrenderWebkitHeadlessProtoModalDialogEvent | Event for a modal dialog created by one of window.confirm(), window.prompt(), or window.alert(). | String | |
| unit | HtmlrenderWebkitHeadlessProtoOffset | String | ||
| value | HtmlrenderWebkitHeadlessProtoOffset | integer | ||
| cookie | Cookies at the time of snapshot creation. | HtmlrenderWebkitHeadlessProtoPartialRender | PartialRenders can be created using the extension API to store the document state and/or create an image at points before the final render. | list(HtmlrenderWebkitHeadlessProtoCookie) |
| currentClientUrl | Current url as would appear in the web browser’s address bar at the time of snapshot creation. | HtmlrenderWebkitHeadlessProtoPartialRender | PartialRenders can be created using the extension API to store the document state and/or create an image at points before the final render. | String |
| document | Snapshot of the document DOM + Render trees, if requested | HtmlrenderWebkitHeadlessProtoPartialRender | PartialRenders can be created using the extension API to store the document state and/or create an image at points before the final render. | HtmlrenderWebkitHeadlessProtoDocument |
| id | ID set by the render extension | HtmlrenderWebkitHeadlessProtoPartialRender | PartialRenders can be created using the extension API to store the document state and/or create an image at points before the final render. | String |
| image | Image of the render, if requested | HtmlrenderWebkitHeadlessProtoPartialRender | PartialRenders can be created using the extension API to store the document state and/or create an image at points before the final render. | HtmlrenderWebkitHeadlessProtoImage |
| data | The binary PDF data. | HtmlrenderWebkitHeadlessProtoPdf | String | |
| bottom | HtmlrenderWebkitHeadlessProtoRectangle | HtmlrenderWebkitHeadlessProtoOffset | ||
| left | HtmlrenderWebkitHeadlessProtoRectangle | HtmlrenderWebkitHeadlessProtoOffset | ||
| right | HtmlrenderWebkitHeadlessProtoRectangle | HtmlrenderWebkitHeadlessProtoOffset | ||
| top | A missing value for any field in this message means ‘auto’. | HtmlrenderWebkitHeadlessProtoRectangle | HtmlrenderWebkitHeadlessProtoOffset | |
| httpMethod | The HTTP method of the request for the redirect target. | HtmlrenderWebkitHeadlessProtoRedirectEvent | A redirect event represents a change in the resource URL for a document. This includes HTTP redirects, as well things which trigger client navigations such as script changing window.location, tags, HTTP Refresh headers, etc. | String |
| httpStatusCode | For HTTP redirects, the HTTP status code returned in the initial HTTP response. | HtmlrenderWebkitHeadlessProtoRedirectEvent | A redirect event represents a change in the resource URL for a document. This includes HTTP redirects, as well things which trigger client navigations such as script changing window.location, tags, HTTP Refresh headers, etc. | integer |
| refreshType | HtmlrenderWebkitHeadlessProtoRedirectEvent | A redirect event represents a change in the resource URL for a document. This includes HTTP redirects, as well things which trigger client navigations such as script changing window.location, tags, HTTP Refresh headers, etc. | String | |
| targetContentDownloaded | True if the redirect led to a download instead of loading a new page. Note that such redirects can appear anywhere in the list of redirect events. | HtmlrenderWebkitHeadlessProtoRedirectEvent | A redirect event represents a change in the resource URL for a document. This includes HTTP redirects, as well things which trigger client navigations such as script changing window.location, tags, HTTP Refresh headers, etc. | boolean |
| targetUrl | HtmlrenderWebkitHeadlessProtoRedirectEvent | A redirect event represents a change in the resource URL for a document. This includes HTTP redirects, as well things which trigger client navigations such as script changing window.location, tags, HTTP Refresh headers, etc. | String | |
| type | HtmlrenderWebkitHeadlessProtoRedirectEvent | A redirect event represents a change in the resource URL for a document. This includes HTTP redirects, as well things which trigger client navigations such as script changing window.location, tags, HTTP Refresh headers, etc. | String | |
| type | HtmlrenderWebkitHeadlessProtoRedirectHop | String | ||
| url | The redirect target url. | HtmlrenderWebkitHeadlessProtoRedirectHop | String | |
| canceled | True if this fetch was canceled due to render server policy. e.g. the page exceeded the fetch budget or an extension canceled the fetch. | HtmlrenderWebkitHeadlessProtoReferencedResource | ReferencedResource contains an entry per url referenced by the browser while rendering a document. Next tag available: 20 | boolean |
| contentType | Content type of this resource (webutil/http/content-type.h). The content type is from guess based on the file extension, any mime type in http headers at the beginning of the content, any content-disposition http header, and the content body itself. Note: the content type defined in webutil/http/content-type.proto is incomplete. If you are interested in missing types, please update the enum and the logic of content type detection. | HtmlrenderWebkitHeadlessProtoReferencedResource | ReferencedResource contains an entry per url referenced by the browser while rendering a document. Next tag available: 20 | integer |
| domTreeNodeIndex | DOMTreeNode index which has the url as one of its attributes specified using either src, href or background attributes. src attribute applies to img, script, frame and iframe nodes, href applies to link nodes and background applies to body node. It is possible for a url to be referenced by multiple DOM nodes. For e.g. an tag with the same src attribute can occur in multiple places within a document. It is possible for a url to not have any DOM node reference. For example, redirects don’t have DOM tree nodes. | HtmlrenderWebkitHeadlessProtoReferencedResource | ReferencedResource contains an entry per url referenced by the browser while rendering a document. Next tag available: 20 | list(integer) |
| failedHttpAccessControlCheck | True when a HTTP request succeeded but the resource was not made accessible to script due to a HTTP Access Control (CORS) failure. This field is not implemented on Chromium. | HtmlrenderWebkitHeadlessProtoReferencedResource | ReferencedResource contains an entry per url referenced by the browser while rendering a document. Next tag available: 20 | boolean |
| fetchSourceInfo | Where this resource comes from. | HtmlrenderWebkitHeadlessProtoReferencedResource | ReferencedResource contains an entry per url referenced by the browser while rendering a document. Next tag available: 20 | list(WirelessTranscoderFetchFetchSourceInfo) |
| fetchStatus | The FetchStatus returned by the fetcher. Values are taken from wireless_transcoder_fetch.FetchConstants.FetchStatus in fetch_service.proto. The default value is SUCCESS(0). | HtmlrenderWebkitHeadlessProtoReferencedResource | ReferencedResource contains an entry per url referenced by the browser while rendering a document. Next tag available: 20 | String |
| httpHeader | HTTP headers from the fetcher. | HtmlrenderWebkitHeadlessProtoReferencedResource | ReferencedResource contains an entry per url referenced by the browser while rendering a document. Next tag available: 20 | list(HtmlrenderWebkitHeadlessProtoReferencedResourceHttpHeader) |
| httpResponseCode | HTTP response code if we had tried to fetch the url. Absence of this field indicates either we have not tried to fetch the url or the fetcher never got back to us with any response. | HtmlrenderWebkitHeadlessProtoReferencedResource | ReferencedResource contains an entry per url referenced by the browser while rendering a document. Next tag available: 20 | integer |
| metadata | HtmlrenderWebkitHeadlessProtoReferencedResource | ReferencedResource contains an entry per url referenced by the browser while rendering a document. Next tag available: 20 | list(WirelessTranscoderFetchFetchMetadata) | |
| postData | The post_data field is only valid when the HTTP request method is POST. | HtmlrenderWebkitHeadlessProtoReferencedResource | ReferencedResource contains an entry per url referenced by the browser while rendering a document. Next tag available: 20 | String |
| redirectTarget | If the http_response_code is a HTTP redirect, the redirect target will be stored here. | HtmlrenderWebkitHeadlessProtoReferencedResource | ReferencedResource contains an entry per url referenced by the browser while rendering a document. Next tag available: 20 | String |
| referencedResourceContentIndex | Indicates which referenced_resource_content (in RenderResponse) this RefencedResource points to. This field will be set only when there is referenced_resource_content for this RefencedResource in RenderResponse. | HtmlrenderWebkitHeadlessProtoReferencedResource | ReferencedResource contains an entry per url referenced by the browser while rendering a document. Next tag available: 20 | integer |
| requestHeader | Only necessary headers are recorded. See google3/htmlrender/webkit_headless/resource_key.cc | HtmlrenderWebkitHeadlessProtoReferencedResource | ReferencedResource contains an entry per url referenced by the browser while rendering a document. Next tag available: 20 | list(HtmlrenderWebkitHeadlessProtoReferencedResourceHttpHeader) |
| requestMethod | The HTTP request method (GET, HEAD, POST, etc) used for this request. Values are taken from the HTTPHeaders::Protocol enum in webutil/http/httputils.h. HTTPHeaders::PROTO_GET | HtmlrenderWebkitHeadlessProtoReferencedResource | ReferencedResource contains an entry per url referenced by the browser while rendering a document. Next tag available: 20 | integer |
| styleIndex | style index which has the url specified using either the background-image property or the list-style-image property. | HtmlrenderWebkitHeadlessProtoReferencedResource | ReferencedResource contains an entry per url referenced by the browser while rendering a document. Next tag available: 20 | list(integer) |
| synchronouslyFetched | Whether it is synchronously fetched. | HtmlrenderWebkitHeadlessProtoReferencedResource | ReferencedResource contains an entry per url referenced by the browser while rendering a document. Next tag available: 20 | boolean |
| timing | HtmlrenderWebkitHeadlessProtoReferencedResource | ReferencedResource contains an entry per url referenced by the browser while rendering a document. Next tag available: 20 | list(HtmlrenderWebkitHeadlessProtoReferencedResourceFetchTiming) | |
| url | Does not have a #fragment. | HtmlrenderWebkitHeadlessProtoReferencedResource | ReferencedResource contains an entry per url referenced by the browser while rendering a document. Next tag available: 20 | String |
| webkitMetadata | Additional information webkit about this resource. e.g. intended usage | HtmlrenderWebkitHeadlessProtoReferencedResource | ReferencedResource contains an entry per url referenced by the browser while rendering a document. Next tag available: 20 | HtmlrenderWebkitHeadlessProtoWebKitFetchMetadata |
| finishMsec | HtmlrenderWebkitHeadlessProtoReferencedResourceFetchTiming | Timing data produced by the fetcher. | String | |
| name | A string identifying the fetcher that added this timing information. | HtmlrenderWebkitHeadlessProtoReferencedResourceFetchTiming | Timing data produced by the fetcher. | String |
| startMsec | UNIX epoch timestamps in milliseconds. | HtmlrenderWebkitHeadlessProtoReferencedResourceFetchTiming | Timing data produced by the fetcher. | String |
| name | HtmlrenderWebkitHeadlessProtoReferencedResourceHttpHeader | HTTP Headers included with the resource request. | String | |
| value | HtmlrenderWebkitHeadlessProtoReferencedResourceHttpHeader | HTTP Headers included with the resource request. | String | |
| frameResize | HtmlrenderWebkitHeadlessProtoRenderEvent | HtmlrenderWebkitHeadlessProtoFrameResizeEvent | ||
| initialLoad | HtmlrenderWebkitHeadlessProtoRenderEvent | HtmlrenderWebkitHeadlessProtoInitialLoadEvent | ||
| modalDialog | HtmlrenderWebkitHeadlessProtoRenderEvent | HtmlrenderWebkitHeadlessProtoModalDialogEvent | ||
| redirect | HtmlrenderWebkitHeadlessProtoRenderEvent | HtmlrenderWebkitHeadlessProtoRedirectEvent | ||
| scriptOriginUrl | The URL of the script which caused this event, if any. Analogous to origin_url in DOMTreeNode. | HtmlrenderWebkitHeadlessProtoRenderEvent | String | |
| virtualTimeOffset | Virtual time of the event, as an offset from the beginning of the render in seconds. | HtmlrenderWebkitHeadlessProtoRenderEvent | float | |
| windowOpen | HtmlrenderWebkitHeadlessProtoRenderEvent | HtmlrenderWebkitHeadlessProtoWindowOpenEvent | ||
| consoleLogEntry | Log messages and errors generated by extension script. | HtmlrenderWebkitHeadlessProtoRenderExtensionResult | Results returned by a render server extension. Next id: 3 | list(HtmlrenderWebkitHeadlessProtoConsoleLogEntry) |
| result | HtmlrenderWebkitHeadlessProtoRenderExtensionResult | Results returned by a render server extension. Next id: 3 | String | |
| chromiumTrace | Contains chromium trace generated during page rendering. This is present if a chromium_trace_config was provided in the request. | HtmlrenderWebkitHeadlessProtoRenderResponse | See go/wrs-render-quality for how to evaluate the results. Next id: 24 | HtmlrenderWebkitHeadlessProtoChromiumTrace |
| cookie | Contents of the browser’s cookie jar. (if cookies_enabled was set to true in the RenderRequest). | HtmlrenderWebkitHeadlessProtoRenderResponse | See go/wrs-render-quality for how to evaluate the results. Next id: 24 | list(HtmlrenderWebkitHeadlessProtoCookie) |
| document | Contains the DOM tree, render tree and more. For details consult document.proto. | HtmlrenderWebkitHeadlessProtoRenderResponse | See go/wrs-render-quality for how to evaluate the results. Next id: 24 | HtmlrenderWebkitHeadlessProtoDocument |
| exceptionDetail | Provides extra debugging details when certain exception bits are set. | HtmlrenderWebkitHeadlessProtoRenderResponse | See go/wrs-render-quality for how to evaluate the results. Next id: 24 | String |
| exceptions | Exceptions (possibly serious conditions) that occurred during this rendering. 0 means none. Bitfield encoding. See the RenderingException enum above for an explanation. | HtmlrenderWebkitHeadlessProtoRenderResponse | See go/wrs-render-quality for how to evaluate the results. Next id: 24 | String |
| extensionResult | Render extension results (if `devtools_script` was provided with the request.) | HtmlrenderWebkitHeadlessProtoRenderResponse | See go/wrs-render-quality for how to evaluate the results. Next id: 24 | HtmlrenderWebkitHeadlessProtoRenderExtensionResult |
| finalClientUrl | This field contains the final url as would appear in the web browser’s address bar. Note that JavaScript can modify the contents of the location bar so this URL may not appear on the list of referenced resources. If we fail to follow a redirect this field will contain the URL that we failed to redirect to, not the last one we successfully loaded. | HtmlrenderWebkitHeadlessProtoRenderResponse | See go/wrs-render-quality for how to evaluate the results. Next id: 24 | String |
| image | Contains the viewport images rendered by webkit (if generate_image was set to true in the RenderRequest). Will also contain the print-mode images (if generate_print_mode_images was set to true). | HtmlrenderWebkitHeadlessProtoRenderResponse | See go/wrs-render-quality for how to evaluate the results. Next id: 24 | list(HtmlrenderWebkitHeadlessProtoImage) |
| localStorage | Contents of the browser’s local storage. | HtmlrenderWebkitHeadlessProtoRenderResponse | See go/wrs-render-quality for how to evaluate the results. Next id: 24 | list(HtmlrenderWebkitHeadlessProtoDOMStorageItem) |
| partialRender | Partial render snapshots (if requested by a render extension) | HtmlrenderWebkitHeadlessProtoRenderResponse | See go/wrs-render-quality for how to evaluate the results. Next id: 24 | list(HtmlrenderWebkitHeadlessProtoPartialRender) |
| Contains the PDF document (if generate_pdf was set to true in the RenderRequest) | HtmlrenderWebkitHeadlessProtoRenderResponse | See go/wrs-render-quality for how to evaluate the results. Next id: 24 | HtmlrenderWebkitHeadlessProtoPdf | |
| referencedResourceContent | Contents for all the urls fetched by the render server. This field is present only if generate_referenced_resource_content was set to true in the RenderRequest. | HtmlrenderWebkitHeadlessProtoRenderResponse | See go/wrs-render-quality for how to evaluate the results. Next id: 24 | list(HtmlrenderWebkitHeadlessProtoResource) |
| renderStats | Time to render the url, total size of a document, number of referenced images, etc will be part of RenderStats. | HtmlrenderWebkitHeadlessProtoRenderResponse | See go/wrs-render-quality for how to evaluate the results. Next id: 24 | HtmlrenderWebkitHeadlessProtoRenderStats |
| sessionStorage | Contents of the browser’s session storage. | HtmlrenderWebkitHeadlessProtoRenderResponse | See go/wrs-render-quality for how to evaluate the results. Next id: 24 | list(HtmlrenderWebkitHeadlessProtoDOMStorageItem) |
| title | Contains the page title produced by webkit, in the UTF-8 encoding. | HtmlrenderWebkitHeadlessProtoRenderResponse | See go/wrs-render-quality for how to evaluate the results. Next id: 24 | String |
| anonRenderFineTimingStats | Deliberately non-named fine timing stats. These are all related to each other and unrelated to other timing stats in this message. | HtmlrenderWebkitHeadlessProtoRenderStats | Next id: 17. | list(HtmlrenderWebkitHeadlessProtoAnonTimingStatPair) |
| consoleLogEntry | Any messages logged by the renderer to the console. Note that we capture a subset of the messages logged by the renderer here to avoid explosion. | HtmlrenderWebkitHeadlessProtoRenderStats | Next id: 17. | list(HtmlrenderWebkitHeadlessProtoConsoleLogEntry) |
| counter | HtmlrenderWebkitHeadlessProtoRenderStats | Next id: 17. | list(HtmlrenderWebkitHeadlessProtoRenderStatsCounter) | |
| documentBuildTimeMsec | Time to build document and render tree response data. | HtmlrenderWebkitHeadlessProtoRenderStats | Next id: 17. | integer |
| droppedLogEntryCount | Number of dropped log messages. Since we capture only a subset of the messages in console_log_entry this field is included just so that the consumers can get an idea of how many actual attempts were made by the renderer. | HtmlrenderWebkitHeadlessProtoRenderStats | Next id: 17. | integer |
| imageEncodingTimeMsec | Image encoding (e.g. raw -> PNG) time. | HtmlrenderWebkitHeadlessProtoRenderStats | Next id: 17. | integer |
| imageScalingTimeMsec | Image scaling time. | HtmlrenderWebkitHeadlessProtoRenderStats | Next id: 17. | integer |
| layoutTimeMsec | Time from starting render to document finished loading. This includes all fetches, parsing, decoding, running JavaScript, etc. | HtmlrenderWebkitHeadlessProtoRenderStats | Next id: 17. | integer |
| paintTimeMsec | Time required to paint a document into our buffer. | HtmlrenderWebkitHeadlessProtoRenderStats | Next id: 17. | integer |
| renderCostMgcu | Total cost this render spent running and RPC cost in milliGCUs. | HtmlrenderWebkitHeadlessProtoRenderStats | Next id: 17. | integer |
| renderEngine | Render engine used to render this document. | HtmlrenderWebkitHeadlessProtoRenderStats | Next id: 17. | String |
| renderRunningTimeMsec | Total CPU time this render spent running in milliseconds. | HtmlrenderWebkitHeadlessProtoRenderStats | Next id: 17. | integer |
| renderServerBaselineCl | The CL from which the render engine was built. | HtmlrenderWebkitHeadlessProtoRenderStats | Next id: 17. | String |
| renderTimeMsec | Total wall time taken to render a document in milliseconds. | HtmlrenderWebkitHeadlessProtoRenderStats | Next id: 17. | integer |
| sandboxRenderTimeMsec | Total time spent in the sandbox in milliseconds. This time includes all phases measured individually below. | HtmlrenderWebkitHeadlessProtoRenderStats | Next id: 17. | integer |
| count | HtmlrenderWebkitHeadlessProtoRenderStatsCounter | Render event counters. | String | |
| name | By convention, counters may contain a “.” which we use to separate a metric name from a counter name in streamz. | HtmlrenderWebkitHeadlessProtoRenderStatsCounter | Render event counters. | String |
| box | Box is set for render blocks ( , , etc). Box for any RenderTreeNode can be found either in the RenderTreeNode itself or by traversing up the ancestors until a RenderTreeNode with a Box is found. | HtmlrenderWebkitHeadlessProtoRenderTreeNode | HtmlrenderWebkitHeadlessProtoBox | |
| childRenderTreeNodeIndex | child_render_tree_node_index is an index into the list of RenderTreeNodes stored in the Document. *** WARNING ***: Don’t use this field. Applications should not rely on the structure of the render tree. This is an internal browser implementation detail and it changes from time to time. Generally, applications should obtain rendering information by starting with the relevant DOMTreeNode and following pointers from there to the relevant RenderTreeNodes. | HtmlrenderWebkitHeadlessProtoRenderTreeNode | list(integer) | |
| domTreeNodeIndex | Index of the DOMTreeNode for which this RenderTreeNode is applicable. This index can be used to lookup a DOMTreeNode from list of DOMTreeNodes stored in the Document. | HtmlrenderWebkitHeadlessProtoRenderTreeNode | integer | |
| inlineTextBox | HtmlrenderWebkitHeadlessProtoRenderTreeNode | list(HtmlrenderWebkitHeadlessProtoRenderTreeNodeInlineTextBox) | ||
| renderedText | The actual text that was rendered. This is applicable only for text nodes. | HtmlrenderWebkitHeadlessProtoRenderTreeNode | String | |
| styleIndex | Style index is set for rendered nodes (text nodes, image nodes, widgets, etc). The style_index can be used to lookup the style from the list of styles stored in the Document. | HtmlrenderWebkitHeadlessProtoRenderTreeNode | integer | |
| box | HtmlrenderWebkitHeadlessProtoRenderTreeNodeInlineTextBox | For text nodes, individual lines of text. This repeats rendered_text with more specific bounding boxes. | HtmlrenderWebkitHeadlessProtoBox | |
| renderedText | HtmlrenderWebkitHeadlessProtoRenderTreeNodeInlineTextBox | For text nodes, individual lines of text. This repeats rendered_text with more specific bounding boxes. | String | |
| content | content contains a complete HTTP response message including the HTTP status line, headers and body. For example: HTTP/1.1 200 OK\\r\\n Content-Type: text/html\\r\\n \\r\\n … content … For inputs (RenderRequest.resource): Any HTTP content encoding (e.g. gzip) and transfer encoding (e.g. chunked) MUST be decoded. HTTP content and transfer encoding headers will be ignored if present. For outputs (RenderResponse.referenced_resource_content): The body will be decoded (no content or transfer encoding) however any content or transfer encoding headers present in the original fetch response will be passed through. Decoding this field requires a correct text encoding. The charset field of Document proto can be a good guess but is not guaranteed to be correct. | HtmlrenderWebkitHeadlessProtoResource | Next id: 9. | String |
| fetchSourceInfo | Where this resource comes from. | HtmlrenderWebkitHeadlessProtoResource | Next id: 9. | list(WirelessTranscoderFetchFetchSourceInfo) |
| finalContentUrl | The url that contributes the final content. Only existed when metadata contains FetchReplyData. | HtmlrenderWebkitHeadlessProtoResource | Next id: 9. | String |
| metadata | HtmlrenderWebkitHeadlessProtoResource | Next id: 9. | list(WirelessTranscoderFetchFetchMetadata) | |
| method | The HTTP request method (GET, HEAD, POST, etc) used for this request. Values are taken from the HTTPHeaders::Protocol enum in webutil/http/httputils.h. If it’s not set, we will infer GET or POST based on the presence of post_data. | HtmlrenderWebkitHeadlessProtoResource | Next id: 9. | integer |
| postData | HtmlrenderWebkitHeadlessProtoResource | Next id: 9. | String | |
| requestHeader | Only necessary headers are included in the resource key by default. See google3/htmlrender/webkit_headless/resource_key.cc | HtmlrenderWebkitHeadlessProtoResource | Next id: 9. | list(HtmlrenderWebkitHeadlessProtoResourceHttpHeader) |
| url | HtmlrenderWebkitHeadlessProtoResource | Next id: 9. | String | |
| name | HtmlrenderWebkitHeadlessProtoResourceHttpHeader | String | ||
| value | HtmlrenderWebkitHeadlessProtoResourceHttpHeader | String | ||
| columnNumber | The current column number for the stack frame. | HtmlrenderWebkitHeadlessProtoScriptStackFrame | Describes a script stack frame. | integer |
| functionName | The function name of the stack frame. | HtmlrenderWebkitHeadlessProtoScriptStackFrame | Describes a script stack frame. | String |
| lineNumber | The current line number for the stack frame. | HtmlrenderWebkitHeadlessProtoScriptStackFrame | Describes a script stack frame. | integer |
| url | The URL of the script being executed. | HtmlrenderWebkitHeadlessProtoScriptStackFrame | Describes a script stack frame. | String |
| marginTop | Margin | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | HtmlrenderWebkitHeadlessProtoOffset |
| marginLeft | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | HtmlrenderWebkitHeadlessProtoOffset | |
| listStyleType | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | String | |
| referencedResourceIndex | List of referenced resource indexes for any resources that this style references. (e.g. background images.) (see document.proto) | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | list(integer) |
| borderPixelWidthLeft | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | integer | |
| display | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | String | |
| borderPixelWidthBottom | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | integer | |
| textAlign | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | String | |
| fontSize | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | integer | |
| borderColorArgbTop | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | integer | |
| backgroundImageYPos | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | HtmlrenderWebkitHeadlessProtoOffset | |
| fontFamily | `font_family` is the `font-family` computed style, not necessarily the actual font. https://developer.mozilla.org/en-US/docs/Web/CSS/font-family. Note that it may contain multiple font families, not just one. | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | String |
| overflowX | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | String | |
| borderColorArgbLeft | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | integer | |
| textShadowColorArgb | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | integer | |
| backgroundGradientRepeat | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | boolean | |
| foregroundColorArgb | Foreground color encoded as ARGB | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | integer |
| borderPixelWidthRight | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | integer | |
| position | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | String | |
| borderStyleLeft | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | String | |
| borderPixelWidthTop | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | integer | |
| backgroundSize | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | String | |
| backgroundImageUrl | The url of the background image in the first layer. | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | String |
| clip | Default value for clip is “auto”, which is represented here as !has_clip(). | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | HtmlrenderWebkitHeadlessProtoRectangle |
| fontWeight | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | integer | |
| backgroundGradientColorStopArgb | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | list(integer) | |
| backgroundSizeWidth | Only present (but may be missing) if background_size == SIZE_LENGTH. | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | HtmlrenderWebkitHeadlessProtoOffset |
| paddingTop | Padding | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | HtmlrenderWebkitHeadlessProtoOffset |
| visibility | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | String | |
| textDecoration | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | String | |
| marginBottom | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | HtmlrenderWebkitHeadlessProtoOffset | |
| marginRight | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | HtmlrenderWebkitHeadlessProtoOffset | |
| borderStyleRight | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | String | |
| backgroundAttachment | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | String | |
| overflowY | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | String | |
| direction | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | String | |
| borderStyleBottom | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | String | |
| borderColorArgbBottom | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | integer | |
| paddingLeft | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | HtmlrenderWebkitHeadlessProtoOffset | |
| hasBackground | Starting from Chromium, has_background is set when there is a non-empty specification for background_image, whether it be a url, gradient or other cases, such as cross-fade. Besides setting this field, We additionally parse url and gradient cases and populate some of the following background fields. | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | boolean |
| backgroundImageXPos | Background image position (x, y). | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | HtmlrenderWebkitHeadlessProtoOffset |
| borderStyleTop | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | String | |
| backgroundSizeHeight | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | HtmlrenderWebkitHeadlessProtoOffset | |
| backgroundColorArgb | Background color encoded as ARGB | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | integer |
| paddingRight | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | HtmlrenderWebkitHeadlessProtoOffset | |
| borderColorArgbRight | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | integer | |
| listStyleImageUrl | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | String | |
| backgroundGradientType | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | String | |
| backgroundImageRepeat | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | String | |
| opacity | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | number | |
| fontStyle | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | String | |
| paddingBottom | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | HtmlrenderWebkitHeadlessProtoOffset | |
| zIndex | Default value for z-index is “auto” which means “inherit from parent”. | HtmlrenderWebkitHeadlessProtoStyle | Next id: 54 Font and text decorations: | integer |
| devtoolsFrameId | Chromium DevTools frame ID of the frame that initiated this fetch. Only populated in the streaming render service with FETCH_MODE_CLIENT. | HtmlrenderWebkitHeadlessProtoWebKitFetchMetadata | WebkKitFetchMetadata holds additional webkit-specific information for a single resource fetch. | String |
| targetType | HtmlrenderWebkitHeadlessProtoWebKitFetchMetadata | WebkKitFetchMetadata holds additional webkit-specific information for a single resource fetch. | String | |
| allowed | Whether or not the window was allowed to be opened by the popup blocker. Unless user events are created with a render extension this should be false. | HtmlrenderWebkitHeadlessProtoWindowOpenEvent | Corresponds to a call to window.open(). Note that a WindowOpenEvent will be present whether or not the call was successful. | boolean |
| url | The URL for the new window. Note that this is the URL after it has been processed by WebKit, so, for example, relative links passed to window.create() will have been made absolute. | HtmlrenderWebkitHeadlessProtoWindowOpenEvent | Corresponds to a call to window.open(). Note that a WindowOpenEvent will be present whether or not the call was successful. | String |
| windowFeatures | Window features passed to window.open(). | HtmlrenderWebkitHeadlessProtoWindowOpenEvent | Corresponds to a call to window.open(). Note that a WindowOpenEvent will be present whether or not the call was successful. | String |
| windowName | Window name passed to window.open(). If no name is provided this defaults to “_blank”. | HtmlrenderWebkitHeadlessProtoWindowOpenEvent | Corresponds to a call to window.open(). Note that a WindowOpenEvent will be present whether or not the call was successful. | String |
| countryCode | The country calling code for this number, as defined by the International Telecommunication Union (ITU). For example, this would be 1 for NANPA countries, and 33 for France. | I18nPhonenumbersPhoneNumber | The PhoneNumber object that is used by all LibPhoneNumber API’s to fully represent a phone number. | integer |
| countryCodeSource | The source from which the country_code is derived. | I18nPhonenumbersPhoneNumber | The PhoneNumber object that is used by all LibPhoneNumber API’s to fully represent a phone number. | String |
| extension | Extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. It is defined as a string here to accommodate for the possible use of a leading zero in the extension (organizations have complete freedom to do so, as there is no standard defined). Other than digits, some other dialling characters such as “,” (indicating a wait) may be stored here. | I18nPhonenumbersPhoneNumber | The PhoneNumber object that is used by all LibPhoneNumber API’s to fully represent a phone number. | String |
| italianLeadingZero | In some countries, the national (significant) number starts with one or more “0”s without this being a national prefix or trunk code of some kind. For example, the leading zero in the national (significant) number of an Italian phone number indicates the number is a fixed-line number. There have been plans to migrate fixed-line numbers to start with the digit two since December 2000, but it has not happened yet. See http://en.wikipedia.org/wiki/%2B39 for more details. These fields can be safely ignored (there is no need to set them) for most countries. Some limited number of countries behave like Italy – for these cases, if the leading zero(s) of a number would be retained even when dialling internationally, set this flag to true, and also set the number of leading zeros. Clients who use the parsing or conversion functionality of the i18n phone number libraries (go/phonenumbers) will have these fields set if necessary automatically. | I18nPhonenumbersPhoneNumber | The PhoneNumber object that is used by all LibPhoneNumber API’s to fully represent a phone number. | boolean |
| nationalNumber | The National (significant) Number, as defined in International Telecommunication Union (ITU) Recommendation E.164, without any leading zero. The leading-zero is stored separately if required, since this is an uint64 and hence cannot store such information. Do not use this field directly: if you want the national significant number, call the getNationalSignificantNumber method of PhoneNumberUtil. For countries which have the concept of an “area code” or “national destination code”, this is included in the National (significant) Number. Although the ITU says the maximum length should be 15, we have found longer numbers in some countries e.g. Germany. Note that the National (significant) Number does not contain the National (trunk) prefix. Obviously, as a uint64, it will never contain any formatting (hyphens, spaces, parentheses), nor any alphanumeric spellings. | I18nPhonenumbersPhoneNumber | The PhoneNumber object that is used by all LibPhoneNumber API’s to fully represent a phone number. | String |
| numberOfLeadingZeros | Full description of this field in the comment for italian_leading_zero since this field will only be set when italian_leading_zero is true. | I18nPhonenumbersPhoneNumber | The PhoneNumber object that is used by all LibPhoneNumber API’s to fully represent a phone number. | integer |
| preferredDomesticCarrierCode | The carrier selection code that is preferred when calling this phone number domestically. This also includes codes that need to be dialed in some countries when calling from landlines to mobiles or vice versa. For example, in Columbia, a “3” needs to be dialed before the phone number itself when calling from a mobile phone to a domestic landline phone and vice versa. Note this is the “preferred” code, which means other codes may work as well. | I18nPhonenumbersPhoneNumber | The PhoneNumber object that is used by all LibPhoneNumber API’s to fully represent a phone number. | String |
| rawInput | This field is used to store the raw input string containing phone numbers before it was canonicalized by the library. For example, it could be used to store alphanumerical numbers such as “1-800-GOOG-411”. | I18nPhonenumbersPhoneNumber | The PhoneNumber object that is used by all LibPhoneNumber API’s to fully represent a phone number. | String |
| byteSize | the size of the stored thumbnail | ImageBaseThumbnailMetadata | Next ID: 16 | integer |
| crops | SmartCrop crop-hints By default, this field is not populated. | ImageBaseThumbnailMetadata | Next ID: 16 | ContentAwareCropsIndexing |
| deepCrop | DeepCrop crop-hints. Usage in thumbnails could be deprecated in favor or deep_crop_pixels (below). By default, this field is not populated. | ImageBaseThumbnailMetadata | Next ID: 16 | DeepCropIndexing |
| deepCropPixels | DeepCrop signal in pixels, equivalent to deep_crop (above) but with pixels instead of percentages. By default, this field is not populated. | ImageBaseThumbnailMetadata | Next ID: 16 | DeepCropPixels |
| docid | the Amarna docid of the thumbnail | ImageBaseThumbnailMetadata | Next ID: 16 | String |
| encryptedDocid | encrypted version of docid | ImageBaseThumbnailMetadata | Next ID: 16 | String |
| expirationTimestampMicros | expiration timestamp of thumbnail | ImageBaseThumbnailMetadata | Next ID: 16 | String |
| fprint | the fprint of the thumbnail | ImageBaseThumbnailMetadata | Next ID: 16 | String |
| height | the height of the stored thumbnail | ImageBaseThumbnailMetadata | Next ID: 16 | integer |
| mimeType | The mime_type of the thumbnail (“image/jpeg”, “image/png”, etc.). | ImageBaseThumbnailMetadata | Next ID: 16 | String |
| originalHeight | ImageBaseThumbnailMetadata | Next ID: 16 | integer | |
| originalWidth | Not populated by Amarna/image pipelines, ever. This was apparently introduced by a customer that wished to extend ThumbnailMetadata with this custom data. | ImageBaseThumbnailMetadata | Next ID: 16 | integer |
| type | ImageBaseThumbnailMetadata | Next ID: 16 | String | |
| width | the width of the stored thumbnail | ImageBaseThumbnailMetadata | Next ID: 16 | integer |
| byteSize | Size of the stored preview. | ImageBaseVideoPreviewMetadata | This message is used internally in Amarna and is also used to store information in the VideoWebAttachment portion of the websearch index. Only the following fields will be used in the index: VideoPreviewType type int32 width int32 height byte byte_size If more fields are added, please update this list. | integer |
| docid | 64 bit docid of the original video. | ImageBaseVideoPreviewMetadata | This message is used internally in Amarna and is also used to store information in the VideoWebAttachment portion of the websearch index. Only the following fields will be used in the index: VideoPreviewType type int32 width int32 height byte byte_size If more fields are added, please update this list. | String |
| duration | TODO (yzliu): consider using duration_ms as field name since it is number of milliseconds. Duration of the preview in ms. | ImageBaseVideoPreviewMetadata | This message is used internally in Amarna and is also used to store information in the VideoWebAttachment portion of the websearch index. Only the following fields will be used in the index: VideoPreviewType type int32 width int32 height byte byte_size If more fields are added, please update this list. | integer |
| expirationTimestampMicros | Expiration timestamp of preview in microseconds since epoch. | ImageBaseVideoPreviewMetadata | This message is used internally in Amarna and is also used to store information in the VideoWebAttachment portion of the websearch index. Only the following fields will be used in the index: VideoPreviewType type int32 width int32 height byte byte_size If more fields are added, please update this list. | String |
| fprint | LINT.ThenChange(//depot/google3/video/crawl/indexing/signal_combiner.cc:video_preview) Fingerprint of the preview. | ImageBaseVideoPreviewMetadata | This message is used internally in Amarna and is also used to store information in the VideoWebAttachment portion of the websearch index. Only the following fields will be used in the index: VideoPreviewType type int32 width int32 height byte byte_size If more fields are added, please update this list. | String |
| height | Height of the stored preview. | ImageBaseVideoPreviewMetadata | This message is used internally in Amarna and is also used to store information in the VideoWebAttachment portion of the websearch index. Only the following fields will be used in the index: VideoPreviewType type int32 width int32 height byte byte_size If more fields are added, please update this list. | integer |
| mimeType | Mime type of the preview (“video/mp4”). | ImageBaseVideoPreviewMetadata | This message is used internally in Amarna and is also used to store information in the VideoWebAttachment portion of the websearch index. Only the following fields will be used in the index: VideoPreviewType type int32 width int32 height byte byte_size If more fields are added, please update this list. | String |
| state | Indicates the state in Venom for this preview type. | ImageBaseVideoPreviewMetadata | This message is used internally in Amarna and is also used to store information in the VideoWebAttachment portion of the websearch index. Only the following fields will be used in the index: VideoPreviewType type int32 width int32 height byte byte_size If more fields are added, please update this list. | String |
| timestamp | Timestamp of start of preview in ms. | ImageBaseVideoPreviewMetadata | This message is used internally in Amarna and is also used to store information in the VideoWebAttachment portion of the websearch index. Only the following fields will be used in the index: VideoPreviewType type int32 width int32 height byte byte_size If more fields are added, please update this list. | integer |
| type | LINT.IfChange | ImageBaseVideoPreviewMetadata | This message is used internally in Amarna and is also used to store information in the VideoWebAttachment portion of the websearch index. Only the following fields will be used in the index: VideoPreviewType type int32 width int32 height byte byte_size If more fields are added, please update this list. | String |
| videoSegmentEndUs | The end timestamp of the video segment in microseconds that this preview is generated from. Used for segmented video previews. | ImageBaseVideoPreviewMetadata | This message is used internally in Amarna and is also used to store information in the VideoWebAttachment portion of the websearch index. Only the following fields will be used in the index: VideoPreviewType type int32 width int32 height byte byte_size If more fields are added, please update this list. | String |
| videoSegmentStartUs | The start timestamp of the video segment in microseconds that this preview is generated from. Used for segmented video previews. | ImageBaseVideoPreviewMetadata | This message is used internally in Amarna and is also used to store information in the VideoWebAttachment portion of the websearch index. Only the following fields will be used in the index: VideoPreviewType type int32 width int32 height byte byte_size If more fields are added, please update this list. | String |
| width | Width of the stored preview. | ImageBaseVideoPreviewMetadata | This message is used internally in Amarna and is also used to store information in the VideoWebAttachment portion of the websearch index. Only the following fields will be used in the index: VideoPreviewType type int32 width int32 height byte byte_size If more fields are added, please update this list. | integer |
| starburst | Repeated so that multiple versions can exist in prod simultaneously. | ImageContentFlowProtoProd | The subset of FlowProto that we want to go into production AND be stored in ContentSignals. | list(ImageContentStarburstVersionGroup) |
| queryboost | ImageContentQueryBoost | Image content based multipliers. Current usage is in the pamir_section. | list(ImageContentQueryBoostQueryBoost) | |
| boost | Score multiplier (fully normalized 1 is nop). | ImageContentQueryBoostQueryBoost | number | |
| query | Canonicalized query string. | ImageContentQueryBoostQueryBoost | String | |
| descriptorFloat | Raw dense float feature vector. | ImageContentStarburstVersionGroup | list(number) | |
| descriptorFloatBeforeProjection | Raw dense float feature vector prior to embedding. Only for Starburst V6. | ImageContentStarburstVersionGroup | list(number) | |
| descriptorShort | Short descriptor for image content features, e.g. compressed bytes. This is the compressed version of descriptor_float below. It can be can be decompressed to descriptor_float with a tiny bit of compression error (in most cases it should be totally fine). | ImageContentStarburstVersionGroup | String | |
| enumVersion | ImageContentStarburstVersionGroup | String | ||
| minorVersion | ImageContentStarburstVersionGroup | String | ||
| starburstTokens | Starburst tokens. | ImageContentStarburstVersionGroup | list(integer) | |
| starburstTokensDistances | Squared distance of the current embedding to each cluster center. Elements are aligned with starburst_tokens. | ImageContentStarburstVersionGroup | list(number) | |
| version | The following integers are currently used: Starburst V1: 1 Starburst V2: 2 Starburst V3: 3 Starburst V4: 4 Starburst Visual V4: 1004 This field is deprecated. Please try to use the ‘enum_version’ in future. | ImageContentStarburstVersionGroup | integer | |
| expirationTimestamp | The thumbnail is guaranteed to be kept in the serving system until the expiration timestamp has passed, in microseconds. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | String |
| h2c | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | number | |
| corpusSelectionInfo | Corpus scoring info for images indexed through Amarna. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | list(CorpusSelectionInfo) |
| isUnwantedContent | Field to indicate the image is unwanted for search index. The data is propagated from amarna to alexandria to be annotated in the cdoc. Refer to image/repository/proto/unwanted_content.proto for more info. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | boolean |
| colorScore | Colorness scores for the image. Each score represents the amount of a particular color in the image. At the current time, there are 12 colors, so there should always be 0 or 12 values in this array. The 12 colors are black, blue, brown, gray, green, orange, pink, purple, red, teal, white, yellow. The convention is that the scores are stored in alphabetical order, so the first score is black, and the last score is yellow. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | list(number) |
| isIndexedByImagesearch | If this image was not selected for indexing by imagesearch, these fields say so and explain why. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | boolean |
| thumbHeight | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | integer | |
| lastCrawlTime | Most recent timestamp in seconds when this URL was crawled. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | integer |
| nearDupFeaturesVersion | Image content derived data used for finding image near dups. NOTE: This hash is generated by V1 hash computation. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | integer |
| clipartDetectorScore | Image content based classifier scores. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | number |
| thumbnail | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | list(ImageDataThumbnail) | |
| colorScoreVersion | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | integer | |
| contentFirstCrawlTime | Earliest known crawl time among all neardups of this image (go/imagecontentage). | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | integer |
| lineartDetectorVersion | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | integer | |
| embeddedMetadata | the EXIF/IPTC metadata | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | ImageExifImageEmbeddedMetadata |
| width | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | integer | |
| imageContentQueryBoost | Image Content Scored per query boosts. Currently this is filled by the pamir algorithm and populates the pamir_section. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | ImageContentQueryBoost |
| shoppingProductInformation | The Shoppable Images product information to be annotated in the Cdoc. All fields will be populated except the product location bounding box. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | ImageRepositoryShoppingProductInformation |
| height | Height | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | integer |
| imageLicenseInfo | Indicates license info of this image, which will tell image search users how to use this image legally. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | ImageSearchImageLicenseInfo |
| extendedExif | The EXIF generated by photos backend team’s (more specifically FIFE’s) thumbnailer library. This exif model is more comprehensive since a dedicated team is constantly improving it and adding new fields over time. This is currently populated by moonshine for selected corpora. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | PhotosImageMetadata |
| nimaVq | Productionized Nima VQ score. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | ImageRepositoryNimaOutput |
| imagerank | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | integer | |
| imageQualityClickSignals | Click signals for measuring image quality (e.g., usefulness, presentation, appealingness, and engagingness). Click signals are considered Search CPS Personal Data. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | ImageQualityNavboostImageQualityClickSignals |
| finalPornScore | A [0..1] porn score based on some image-level features (like content score, referrer statistics, navboost queries, etc.). See class RiflePornScorer for more details. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | number |
| coloredPixelsFrac | Fraction of the image that contains pixels over a certain saturation threshold: can be used to determine if the image is grayscale or not. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | number |
| whiteBackgroundScoreVersion | Image is likely an object on a white background (value on [0,1]). | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | integer |
| lineartDetectorScore | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | number | |
| clusterId | Superlabels generated cluster id. This field is going to be deprecated, please use `superlabels_v2_cluster_id` instead. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | String |
| restrictStrings | A string representation of all the restricts associated with this image. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | list(String) |
| hateLogoDetection | Hate logo detections from the VSS logo_recognition module. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | ImageUnderstandingIndexingAnnotationGroup |
| clickMagnetScore | A score in (0, 1] to indicate how likely this image is considered as a click magnet based on clicks received from bad queries. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | number |
| nearDupFeaturesSmallVersion | The following fields contain information about a smaller and less powerful version of the hash, needed for neardup retrieval. A compressed and an encoded version of the small hash are stored below. The smaller hash may have a few variants to increase recall. NOTE: This hash is generated by V2 hash computation. A compressed version of the small hash. Currently, a 4-byte fingerprint. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | integer |
| styleAestheticsScore | Aesthetics score of a style image. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | LensDiscoveryStyleAestheticsScoreSignals |
| smearedTopWebLandingPageDocids | Web docids that correspond to high ranked smeared landing pages for this image. Used for conditional retrieval of actionable landing pages for image search. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | list(String) |
| robotedAgents | CSV list of user agents for which this image should be considered roboted. Note: All images are crawled using googlebot-images, this exists for clients that require additional restrictions beyond googlebot-images such as news. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | String |
| size | Size in bytes of original (non-thumbnail) | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | integer |
| canonicalDocid | This is the image docid used in image search. For ImageData protos coming from Alexandria/Freshdocs, this is a ‘required’ field that MUST be populated. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | String |
| pornFlagData | Used by the segindexer for combined www+image indices. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | PornFlagData |
| personAttributes | Contains person attributes from the LookNet-Person model and the Style AI Iconic Person Scorer for the most iconic person in a style image. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | LensDiscoveryStylePersonAttributes |
| generatedImageLikelihoodSignal | The signal about the likelihood of whether the image is generated by Google. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | ImageRepositoryGeneratedImageLikelihoodSignal |
| clipartDetectorVersion | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | integer | |
| testingScore | This field is for testing purposes, more information in go/media-dirt-2022. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | integer |
| ocrGoodoc | Pruned OCR Goodoc see vss_aksara_ocr_util.h for the fields copied. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | GoodocDocument |
| smearedTopWebLandingPages | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | list(SmearedWebLandingPageEntry) | |
| whiteBackgroundScore | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | number | |
| docid | fingerprint(non-canonicalized absolute image url) This is *not* the image docid. Use canonical_docid instead. For ImageData protos coming from Alexandria/Freshdocs, this is a ‘required’ field that MUST be populated. But once again, this is very likely NOT something you need. Use canonical_docid instead. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | String |
| orbitIntents | Orbit intents. More details on go/orbit-in-image-indexing. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | QualityOrbitOrbitImageIntents |
| flags | Use image_perdoc.h to read/write ‘flags’. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | integer |
| thumbWidth | Thumbnail width. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | integer |
| packedFullFaceInfo | Encodes face number and largest face frac into a small package for storage in mustang. This is calculated directly from FaceDetectionResult. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | FaceIndexing |
| crops | The content-aware cropping information. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | ContentAwareCropsIndexing |
| ocrTextboxes | Text lines detected by OCR engine. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | list(OcrPhotoTextBox) |
| h2i | ‘Hovers to Impressions’ and ‘Hovers to Clicks’ ratios for an image. These are considered Search CPS Personal Data due to concerns that they may be used to reidentify or confirm the presence of specific singleton (unique) queries. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | number |
| isMultiframe | True if the original image contains multiple frames (e.g., for animated or stereoscopic images). | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | boolean |
| ocrTaser | Ocr detected by ocr_taser module. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | GoodocDocument |
| featuredImageProp | Properties used in featured imagesearch project. inspiration_score indicates how well an image is related to products, or how inspirational it is. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | ImageMonetizationFeaturedImageProperties |
| unavailableAfterSecs | Time in seconds since epoch after which this image should be considered unavailable. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | String |
| imageRegions | Regions detected within the image (go/images-region-search-edd). Regions contain bounding boxes circumscribing objects of interest in the image, along with object labels. Regions may overlap. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | ImageRegionsImageRegions |
| fileFormat | True file format (not extension). | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | String |
| deepTags | VSS generated deep tags for shopping images. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | CommerceDatastoreImageDeepTags |
| adaboostImageFeaturePornVersion | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | integer | |
| noIndexReason | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | list(String) | |
| personDetectionSignals | Contains person detection result. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | LensDiscoveryStylePersonDetectionSignals |
| flowOutput | The output of various features generated by the Flow framework, most importantly data from Starburst (go/starburst). Do NOT interact with the internals of this proto since they may change over time. Instead, use the existing interfaces that consume FlowProtoProd’s directly, e.g., image/mustang/content/image_content_distance.h For more info, please contact image-content-core@. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | ImageContentFlowProtoProd |
| photoDetectorVersion | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | integer | |
| numberFaces | Number of faces detected in the image | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | integer |
| nearDupFeaturesSmall | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | list(String) | |
| deepImageEngagingness | Productionized Deep Image Engagingness score. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | ImageRepositoryDeepImageEngagingnessOutput |
| isVisible | True if the image is inlined on the page (typicially via ) or false if the image is linked to (via an href). | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | boolean |
| url | Canonicalized absolute image url. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | String |
| licensedWebImagesOptInState | Indicates the web-master opt-in state of this image, and will be used for Google products to decide usage rights like showing large previews. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | String |
| rankInNeardupCluster | Rank in near-dup cluster (go/image-rank-in-neardup-cluster). The rank is 1-indexed: rank 1 is the best. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | integer |
| thumbSize | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | integer | |
| codomainStrength | Like is_visible, this is a property of the (web-doc, img_url) pair not just the image. A high codomain_strength indicates high confidence based on collected stats that the image is hosted on a companion domain. If not enough stats are available for codomain strength, this field may be absent in ImageData, and hence the CompositeDoc. Do not place negative values here. Permitted values range between 0 and image_quality_codomain::kMaxCodomainStrength defined in //image/quality/codomain/codomain-stats-utils.h. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | integer |
| deepCrop | DeepCrop based cropping information. See go/creatism/deepcrop for details. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | DeepCropIndexing |
| nearDupFeatures | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | String | |
| photoDetectorScore | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | number | |
| firstCrawlTime | Earliest known timestamp about this image. Today, this is the timestamp when the content key was generated for this image. The time is in seconds. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | integer |
| adaboostImageFeaturePorn | Warning: adaboost_image_feature_porn* and imageFeaturePorn fields are DEPRECATED in favor of brain_porn_scores. Please do not use them. Contact safesearch@ for transition advice. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | number |
| brainPornScores | A [0..1] SafeSearch scores based on image pixels, using Google Brain: porn, csai, violence, medical, and spoof. For porn only, if available prefer final_porn_score as it should be more precise than brain_porn_scores.porn_score. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | ImageSafesearchContentBrainPornAnnotation |
| styleImageType | Prediction of a style image type: Stage, Stock, Street or Outfits. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | LensDiscoveryStyleStyleImageTypeSignals |
| animatedImageData | Present for animated images only: additional animatated image perdoc data. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | ImageRepositoryAnimatedImagePerdocData |
| onPageAlternateUrl | For an image not explicitly visible on this page, the following url is the one which most closely matches it. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | String |
| largestFaceFrac | Fraction of image covered by the largest face (should match largestFaceFraction, but without scaling). In perdocs, is set only if numberFaces > 0. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | number |
| imageExactBoost | A set of query fingerprints and confidence scores. There queries are supposed to be relevant to the image with high confidence. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | ImageExactBoost |
| brainPornScoresVersion | A string that indicates the version of SafeSearch classifier used to compute brain_porn_scores. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | String |
| multibangKgEntities | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | ImageDataMultibangEntities | |
| adaboostImageFeaturePornMinorVersion | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | integer | |
| largestFaceFraction | Fraction of image covered by the largest face, scaled by 1000. Warning: Is DEPRECATED in favor of largest_face_frac. Do not use. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | integer |
| finalPornScoreVersion | A string that indicates the version of SafeSearch classifier used to compute final_porn_score. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | String |
| superlabelsV2ClusterId | Superlabels V2 generated cluster id. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | String |
| isIipInScope | IIP in scope signal (go/iip). Set to true if the image is annotated with any iip_in_scope entities (go/iukp-trust-v2). | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | boolean |
| firstTimeSeenOnDocSec | The first time this image URL was seen on the containing web page. Only set during web indexing. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | integer |
| nimaAva | Productionized Nima AVA score. Both this field and nima_vq were added on the top of nima_ava_score and nima_vq_score because the signals are already integrated with Batch Amarna in image/repository/schema/global_output_tags.h using NimaOutput. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | ImageRepositoryNimaOutput |
| precomputedRestricts | Restricts computed before building a Mustang index. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | PrecomputedRestricts |
| linkinfoType | Bitmask of LinkInfo enum in google3/indexing/converter/outlinks/linkinfo.h. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | String |
| indexedVerticals | Vertical indexing information for the document and associated image outlinks. | ImageData | This defines the per-doc data which is extracted from thumbnails and propagated over to indexing. It contains all information that can be used for restricts. Next tag id: 135 | list(ImageDataVerticalIndexingInfoImage) |
| entity | ImageDataMultibangEntities | Multibang kg entities. | list(ImageDataMultibangEntitiesMultibangEntity) | |
| entityId | Entity ID. | ImageDataMultibangEntitiesMultibangEntity | String | |
| score | Multibang score. | ImageDataMultibangEntitiesMultibangEntity | number | |
| expirationTimestampMicros | The thumbnail is guaranteed to be kept in the serving system until the expiration timestamp has passed, in microseconds. | ImageDataThumbnail | String | |
| height | ImageDataThumbnail | integer | ||
| mimeType | ImageDataThumbnail | String | ||
| size | ImageDataThumbnail | integer | ||
| type | ImageDataThumbnail | String | ||
| width | ImageDataThumbnail | integer | ||
| name | List the string representation of the vertical that this image is indexed into. | ImageDataVerticalIndexingInfoImage | Proto to store vertical indexing information for the document and associated image outlinks. The image content can be indexed to multiple verticals, including imagesearch. It can also be indexed only in verticals, not in imagesearch. | String |
| navquery | ImageExactBoost | list(ImageExactBoostNavQuery) | ||
| confidence | Associated confidence scores for the image for the query. | ImageExactBoostNavQuery | Navboost query data. | integer |
| imageClickRank | Click-based rank of the image for this query. | ImageExactBoostNavQuery | Navboost query data. | integer |
| navFp | Query fingerprint. | ImageExactBoostNavQuery | Navboost query data. | String |
| navQuery | The normalized raw query text. | ImageExactBoostNavQuery | Navboost query data. | String |
| referrerDocid | List of all referrers, sorted by their rank (stored in Moosedog). | ImageExactBoostNavQuery | Navboost query data. | list(String) |
| referrerRank | Rank of the current web doc referrer (stored in docjoins). | ImageExactBoostNavQuery | Navboost query data. | integer |
| iso | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | integer | |
| modificationTime | in time_t | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | String |
| subjectLocationY | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | integer | |
| meteringMode | 1-6, see EXIF definition | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | integer |
| subjectDistance | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | number | |
| flashUsed | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | boolean | |
| focalLength35mm | convert to match 35mm film camera | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | number |
| lensMaker | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | String | |
| lightSource | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | integer | |
| subjectLocationX | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | integer | |
| deprecatedState | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | String | |
| copyright | EXIF_TAG_COPYRIGHT | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | String |
| orientation | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | String | |
| description | EXIF_TAG_IMAGE_DESCRIPTION | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | String |
| xResolution | pixels per inch | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | number |
| cameraMaker | Device – Camera raw text without normalization | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | String |
| lensId | Device – Lens We use this extended id to identify a lens uniquely. Canon: “%d %d %d”=.. Nikon: “%.2X %.2X %.2X %.2X %.2X %.2X %.2X %.2X” Don’t change the format of the internal lens id because we use them to look up the lens names. | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | String |
| keywords | EXIF_TAG_XP_KEYWORDS | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | String |
| cameraModel | raw text without normalization | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | String |
| destDistance | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | float | |
| destBearing | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | float | |
| longitude | +/- 180 inclusive | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | float |
| gpsStatus | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | String | |
| focalPlaneXres | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | number | |
| comments2 | EXIF_TAG_XP_COMMENT | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | String |
| altitude | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | float | |
| hPositioningError | in meters | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | float |
| maxApertureAtShortFocal | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | number | |
| imageHeight | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | integer | |
| brightness | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | number | |
| focusMode | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | String | |
| imgDirection | GPS Heading 0.00 to 359.99 degrees | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | float |
| destLongitude | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | float | |
| exposureBias | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | number | |
| gpsMeasureMode | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | String | |
| shortFocal | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | integer | |
| exposureProgram | 1-8, see EXIF definition | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | integer |
| maxApertureAtLongFocal | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | number | |
| subject | EXIF_TAG_XP_SUBJECT | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | String |
| author2 | EXIF_TAG_XP_AUTHOR | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | String |
| imgDirectionRef | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | String | |
| aperture | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | number | |
| destLatitude | GPS location of destination point. | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | float |
| iptc | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | ImageExifIPTCMetadata | |
| author | Text fields EXIF_TAG_ARTIST | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | String |
| latitude | GPS location +/- 90 inclusive | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | float |
| longFocal | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | integer | |
| digitalZoomRatio | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | number | |
| gpsDop | Dilution of precision. HDOP/PDOP depends on measure mode. Find out more at http://en.wikipedia.org/wiki/Dilution_of_precision_(GPS) | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | float |
| imageWidth | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | integer | |
| software | EXIF_TAG_SOFTWARE | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | String |
| deprecatedCity | Location from IPTC @deprecated: Use iptc.location instead. | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | String |
| focalLength | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | number | |
| focalPlaneResUnit | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | integer | |
| cameraSerialNumber | This is the extracted serial number from EXIF (the source depends on camera, most of the cameras store it in makers note tag). | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | String |
| destBearingRef | Bearing and distance to destination point. | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | float |
| yResolution | pixels per inch | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | number |
| colorSpace | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | integer | |
| captureTime | Capturing settings in time_t | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | String |
| deprecatedCountry | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | String | |
| comments | EXIF_TAG_USER_COMMENT | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | String |
| exposureTime | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | number | |
| title | EXIF_TAG_XP_TITLE | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | String |
| continousDriveMode | ImageExifImageEmbeddedMetadata | This class holds the EXIf/IPTC meta data Next Id: 104 | boolean | |
| acquireLicensePage | Page URL about how to acquire this licensable image. | ImageExifIPTCMetadata | This proto holds IPTC metadata. http://www.iptc.org/cms/site/index.html?channel=CH0099 Proto field name is same with IPTC property name except which is clearly stated. Next Id: 64 | String |
| artwork | ImageExifIPTCMetadata | This proto holds IPTC metadata. http://www.iptc.org/cms/site/index.html?channel=CH0099 Proto field name is same with IPTC property name except which is clearly stated. Next Id: 64 | list(ImageExifIPTCMetadataArtwork) | |
| contactinfo | ImageExifIPTCMetadata | This proto holds IPTC metadata. http://www.iptc.org/cms/site/index.html?channel=CH0099 Proto field name is same with IPTC property name except which is clearly stated. Next Id: 64 | ImageExifIPTCMetadataContactInfo | |
| copyrightNotice | ImageExifIPTCMetadata | This proto holds IPTC metadata. http://www.iptc.org/cms/site/index.html?channel=CH0099 Proto field name is same with IPTC property name except which is clearly stated. Next Id: 64 | String | |
| creator | IPTC authorship & copyright related fields. | ImageExifIPTCMetadata | This proto holds IPTC metadata. http://www.iptc.org/cms/site/index.html?channel=CH0099 Proto field name is same with IPTC property name except which is clearly stated. Next Id: 64 | list(String) |
| creditLine | ImageExifIPTCMetadata | This proto holds IPTC metadata. http://www.iptc.org/cms/site/index.html?channel=CH0099 Proto field name is same with IPTC property name except which is clearly stated. Next Id: 64 | String | |
| dateCreated | Time (in seconds) | ImageExifIPTCMetadata | This proto holds IPTC metadata. http://www.iptc.org/cms/site/index.html?channel=CH0099 Proto field name is same with IPTC property name except which is clearly stated. Next Id: 64 | String |
| dateExpired | ImageExifIPTCMetadata | This proto holds IPTC metadata. http://www.iptc.org/cms/site/index.html?channel=CH0099 Proto field name is same with IPTC property name except which is clearly stated. Next Id: 64 | String | |
| dateReleased | ImageExifIPTCMetadata | This proto holds IPTC metadata. http://www.iptc.org/cms/site/index.html?channel=CH0099 Proto field name is same with IPTC property name except which is clearly stated. Next Id: 64 | String | |
| description | ImageExifIPTCMetadata | This proto holds IPTC metadata. http://www.iptc.org/cms/site/index.html?channel=CH0099 Proto field name is same with IPTC property name except which is clearly stated. Next Id: 64 | String | |
| digitalSourceType | See go/gi-annotations-indexing for more information. | ImageExifIPTCMetadata | This proto holds IPTC metadata. http://www.iptc.org/cms/site/index.html?channel=CH0099 Proto field name is same with IPTC property name except which is clearly stated. Next Id: 64 | String |
| event | ImageExifIPTCMetadata | This proto holds IPTC metadata. http://www.iptc.org/cms/site/index.html?channel=CH0099 Proto field name is same with IPTC property name except which is clearly stated. Next Id: 64 | String | |
| headline | ImageExifIPTCMetadata | This proto holds IPTC metadata. http://www.iptc.org/cms/site/index.html?channel=CH0099 Proto field name is same with IPTC property name except which is clearly stated. Next Id: 64 | String | |
| imageSupplier | PLUS field, not used. | ImageExifIPTCMetadata | This proto holds IPTC metadata. http://www.iptc.org/cms/site/index.html?channel=CH0099 Proto field name is same with IPTC property name except which is clearly stated. Next Id: 64 | String |
| instructions | ImageExifIPTCMetadata | This proto holds IPTC metadata. http://www.iptc.org/cms/site/index.html?channel=CH0099 Proto field name is same with IPTC property name except which is clearly stated. Next Id: 64 | String | |
| keywords | ImageExifIPTCMetadata | This proto holds IPTC metadata. http://www.iptc.org/cms/site/index.html?channel=CH0099 Proto field name is same with IPTC property name except which is clearly stated. Next Id: 64 | list(String) | |
| licenseUrl | License URL about how to distribute the image. | ImageExifIPTCMetadata | This proto holds IPTC metadata. http://www.iptc.org/cms/site/index.html?channel=CH0099 Proto field name is same with IPTC property name except which is clearly stated. Next Id: 64 | String |
| location | ImageExifIPTCMetadata | This proto holds IPTC metadata. http://www.iptc.org/cms/site/index.html?channel=CH0099 Proto field name is same with IPTC property name except which is clearly stated. Next Id: 64 | ImageExifIPTCMetadataLocation | |
| locationCreated | Location of the camera | ImageExifIPTCMetadata | This proto holds IPTC metadata. http://www.iptc.org/cms/site/index.html?channel=CH0099 Proto field name is same with IPTC property name except which is clearly stated. Next Id: 64 | ImageExifIPTCMetadataLocationInfo |
| locationShown | Location shown on the image | ImageExifIPTCMetadata | This proto holds IPTC metadata. http://www.iptc.org/cms/site/index.html?channel=CH0099 Proto field name is same with IPTC property name except which is clearly stated. Next Id: 64 | list(ImageExifIPTCMetadataLocationInfo) |
| modelReleaseStatus | ImageExifIPTCMetadata | This proto holds IPTC metadata. http://www.iptc.org/cms/site/index.html?channel=CH0099 Proto field name is same with IPTC property name except which is clearly stated. Next Id: 64 | String | |
| propertyReleaseStatus | ImageExifIPTCMetadata | This proto holds IPTC metadata. http://www.iptc.org/cms/site/index.html?channel=CH0099 Proto field name is same with IPTC property name except which is clearly stated. Next Id: 64 | String | |
| rightsUsageTerms | ImageExifIPTCMetadata | This proto holds IPTC metadata. http://www.iptc.org/cms/site/index.html?channel=CH0099 Proto field name is same with IPTC property name except which is clearly stated. Next Id: 64 | String | |
| source | ImageExifIPTCMetadata | This proto holds IPTC metadata. http://www.iptc.org/cms/site/index.html?channel=CH0099 Proto field name is same with IPTC property name except which is clearly stated. Next Id: 64 | String | |
| supplementalCategories | ImageExifIPTCMetadata | This proto holds IPTC metadata. http://www.iptc.org/cms/site/index.html?channel=CH0099 Proto field name is same with IPTC property name except which is clearly stated. Next Id: 64 | list(String) | |
| title | IPTC description related fields. | ImageExifIPTCMetadata | This proto holds IPTC metadata. http://www.iptc.org/cms/site/index.html?channel=CH0099 Proto field name is same with IPTC property name except which is clearly stated. Next Id: 64 | String |
| title | Other fields omitted. | ImageExifIPTCMetadataArtwork | Artwork or Object in the Image Details | String |
| address | ImageExifIPTCMetadataContactInfo | String | ||
| city | ImageExifIPTCMetadataContactInfo | String | ||
| country | ImageExifIPTCMetadataContactInfo | String | ||
| ImageExifIPTCMetadataContactInfo | String | |||
| phone | ImageExifIPTCMetadataContactInfo | String | ||
| postalCode | ImageExifIPTCMetadataContactInfo | String | ||
| state | ImageExifIPTCMetadataContactInfo | String | ||
| webUrl | ImageExifIPTCMetadataContactInfo | String | ||
| city | ImageExifIPTCMetadataLocation | Location of the camera @deprecated: Use location_created instead. | String | |
| country | ImageExifIPTCMetadataLocation | Location of the camera @deprecated: Use location_created instead. | String | |
| countryCode | ImageExifIPTCMetadataLocation | Location of the camera @deprecated: Use location_created instead. | String | |
| state | ImageExifIPTCMetadataLocation | Location of the camera @deprecated: Use location_created instead. | String | |
| subLocation | ImageExifIPTCMetadataLocation | Location of the camera @deprecated: Use location_created instead. | String | |
| worldRegion | ImageExifIPTCMetadataLocation | Location of the camera @deprecated: Use location_created instead. | String | |
| city | ImageExifIPTCMetadataLocationInfo | String | ||
| country | ImageExifIPTCMetadataLocationInfo | String | ||
| countryCode | ImageExifIPTCMetadataLocationInfo | String | ||
| state | ImageExifIPTCMetadataLocationInfo | String | ||
| subLocation | ImageExifIPTCMetadataLocationInfo | String | ||
| worldRegion | ImageExifIPTCMetadataLocationInfo | String | ||
| inspirationScore | How an image is inspirational, [0, 1]. | ImageMonetizationFeaturedImageProperties | number | |
| code | ImageMoosedogCrawlState | String | ||
| detailedReason | Each of the above not_crawled_reason will have a set of detailed reason defined in crawler/trawler/trawler_enums.proto. | ImageMoosedogCrawlState | integer | |
| internalStatus | The status returned when RPCs are used to internally fetch the image (eg. from FIFE). | ImageMoosedogCrawlState | UtilStatusProto | |
| isTerminal | Specifies if the current crawl state is terminal. | ImageMoosedogCrawlState | boolean | |
| noIndexAfterTimestamp | Time in seconds since epoch after which this image should be considered unavailable. | ImageMoosedogCrawlState | String | |
| notCrawledReason | ImageMoosedogCrawlState | String | ||
| overrodeTerminalState | When true, it means that a non-terminal state has overwrote a terminal one. | ImageMoosedogCrawlState | boolean | |
| repid | The repid for the urls. This repid is the id given to the dupe cluster this url belongs to. | ImageMoosedogCrawlState | String | |
| robotedAgents | A comma separated list of user agents for which this image should be considered roboted. All images are crawled using googlebot-images and this exists here purely for informative reasons. | ImageMoosedogCrawlState | String | |
| url | The url at which we crawled this content. With us starting to use repids the crawl table key no longer is suggestive of the url. In addition this is used in Amarna to detect race conditions between a reference changing its crawl directive and the original crawl job finishing. | ImageMoosedogCrawlState | String | |
| urlDeleted | Set to true if the url is taken down by clients. This indicates that this crawl state is used to fast remove the crawl result of the url instead of waiting for Multiverse crawl results. For more information, please refer to go/amarna-url-deletion. | ImageMoosedogCrawlState | boolean | |
| webRelevanceScore | score calculated in image selection phase, higher imagelink_selection_score more relevant the link is related to the web page | ImageMustangImageLinkSelectionInfo | For detailed info, please see go/naive-image-selection | float |
| inferredImageTypes | ImageMustangShoppingOffer | A proto buffer to organize shopping offer info from Inventory & Policy Service. | list(String) | |
| ipsOfferId | ImageMustangShoppingOffer | A proto buffer to organize shopping offer info from Inventory & Policy Service. | String | |
| DEPRECATEDEntropyColor | entropy and color values for thumbnail (4 bytes consisting of R, G, B and entropy values) | ImagePerDocData | integer | |
| filename | about 10 bytes | ImagePerDocData | String | |
| flags | image_perdoc.h | ImagePerDocData | integer | |
| height | ImagePerDocData | integer | ||
| width | ImagePerDocData | integer | ||
| info | ImagePornDebugInfo | Used to store debug information of the overall classifier. | String | |
| clicks | ImageQualityNavboostImageQualityClickSignals | Next ID: 3 | number | |
| gveClicks | Good clicks that are defined using GVE (go/gve-history). | ImageQualityNavboostImageQualityClickSignals | Next ID: 3 | number |
| mediaEntitiesId | Similar to above, but for media entities (movie name, fictional character, musical band) | ImageQualitySensitiveMediaOrPeopleEntities | Goldmine annotation in the CDoc to store the hrid of the 5 entities with higher topicality in the document. Used by the Skin Tone Twiddler to determine if the result set shows mostly one specific KG entity. go/result-set-signal | list(String) |
| peopleEntitiesId | hrid of the 5 people entities with higher topicality in the document | ImageQualitySensitiveMediaOrPeopleEntities | Goldmine annotation in the CDoc to store the hrid of the 5 entities with higher topicality in the document. Used by the Skin Tone Twiddler to determine if the result set shows mostly one specific KG entity. go/result-set-signal | list(String) |
| boundingBox | The bounding box of the region. | ImageRegionsImageRegion | A single region within an image. NEXT_ID: 11 | PhotosVisionGroundtruthdbNormalizedBoundingBox |
| boundingBoxScore | The confidence score associated with the bounding box. | ImageRegionsImageRegion | A single region within an image. NEXT_ID: 11 | number |
| id | A unique identifier for the region within the image. The id is unique only among other regions in the image. | ImageRegionsImageRegion | A single region within an image. NEXT_ID: 11 | String |
| isProduct | Set true if the region represents a product, i.e., if any of its labels are on a product labels whitelist. See ImageRegionsConfig for details on the product whitelist. | ImageRegionsImageRegion | A single region within an image. NEXT_ID: 11 | boolean |
| knnScore | The score for this region based on how visually similar its neighbors are. | ImageRegionsImageRegion | A single region within an image. NEXT_ID: 11 | float |
| labelGroup | The label group corresponding to the first LabelParams listed in ImageRegionsConfig. | ImageRegionsImageRegion | A single region within an image. NEXT_ID: 11 | ImageUnderstandingIndexingLabelGroup |
| labelVersion | The version string of the labels with which the region was processed. | ImageRegionsImageRegion | A single region within an image. NEXT_ID: 11 | String |
| primaryLabel | The primary label associated with the region. Specifically, the highest-scored whitelisted label associated with the region. See ImageRegionsConfig for details on the whitelist. | ImageRegionsImageRegion | A single region within an image. NEXT_ID: 11 | ImageUnderstandingIndexingLabel |
| renderType | ImageRegionsImageRegion | A single region within an image. NEXT_ID: 11 | String | |
| starburstV4 | The starburst v4 features and tokens for the region. | ImageRegionsImageRegion | A single region within an image. NEXT_ID: 11 | ImageUnderstandingIndexingFeature |
| finalPornScore | The final_porn_score for the image. | ImageRegionsImageRegions | An image with regions within it. NEXT_ID: 11 | number |
| finalViolenceScore | The final_violence_score for the image. | ImageRegionsImageRegions | An image with regions within it. NEXT_ID: 11 | number |
| flowOutput | The output of various features generated by the Flow framework, most importantly data from Starburst (go/starburst). | ImageRegionsImageRegions | An image with regions within it. NEXT_ID: 11 | ImageContentFlowProtoProd |
| has300kThumb | True if the image has a 300k thumb. | ImageRegionsImageRegions | An image with regions within it. NEXT_ID: 11 | boolean |
| hasNavboost | True if the image has navboost. | ImageRegionsImageRegions | An image with regions within it. NEXT_ID: 11 | boolean |
| isIuInappropriate | True if the image is iu-inappropriate. | ImageRegionsImageRegions | An image with regions within it. NEXT_ID: 11 | boolean |
| pedoScore | The pedo_score of the image. | ImageRegionsImageRegions | An image with regions within it. NEXT_ID: 11 | number |
| precomputedRestricts | The precomputed restricts for the image. | ImageRegionsImageRegions | An image with regions within it. NEXT_ID: 11 | PrecomputedRestricts |
| racyScore | The racy_score of the image. | ImageRegionsImageRegions | An image with regions within it. NEXT_ID: 11 | number |
| region | The list of regions. | ImageRegionsImageRegions | An image with regions within it. NEXT_ID: 11 | list(ImageRegionsImageRegion) |
| duplicateOfYtS3Asr | If this field is set to true, it means that Youtube already processed the ASR from S3 for the langID. Please find the ASR result from transcript_asr in google3/image/repository/proto/video_search.proto instead. | ImageRepositoryAmarnaCloudSpeechSignals | Next Tag: 10 | boolean |
| langWithoutLocale | DEPRECATED: Please switch to `langid_input`. The language id input for creating this ASR without regional info. Same format as in go/ytlangid. This field is populated in Kronos Amarna Cloud Speech operator and passed to Amarna, but it is cleared before stored in Amarna’s metadata table. | ImageRepositoryAmarnaCloudSpeechSignals | Next Tag: 10 | String |
| langidInput | The language identification input used to generate this ASR. This field is populated in Kronos Amarna Cloud Speech operator and passed to Amarna, but cleared before stored in Amarna’s metadata table. | ImageRepositoryAmarnaCloudSpeechSignals | Next Tag: 10 | ImageRepositoryLanguageIdentificationResult |
| modelIdentifier | ImageRepositoryAmarnaCloudSpeechSignals | Next Tag: 10 | String | |
| results | Raw results from Cloud Speech API | ImageRepositoryAmarnaCloudSpeechSignals | Next Tag: 10 | list(ImageRepositorySpeechRecognitionResult) |
| s3RecognizerMetadataResponse | The metadata about the S3 recognizer used. | ImageRepositoryAmarnaCloudSpeechSignals | Next Tag: 10 | ImageRepositoryS3RecognizerMetadataResponse |
| transcriptAsr | This field contains full (stitched) transcription, word-level time offset , and word-level byte offset. The value of this field is derived from the SpeechRecognitionResult field above. | ImageRepositoryAmarnaCloudSpeechSignals | Next Tag: 10 | PseudoVideoData |
| frameFeatures | ImageRepositoryAmarnaSignalsBlob | DrishtiFeatureSetDataSequence | ||
| signalsBlobId | Blob id for AmarnaSignalsBlob (see `Blob proto` section of go/revisit-frame-level-signals-amarna). | ImageRepositoryAmarnaSignalsBlobInfo | String | |
| signalsBlobUpdateTimestamp | Additional timestamp field for when the blob is written/updated, serving as the dirty field to help checksum-based update push (see `Dirty field` section in go/revisit-frame-level-signals-amarna). | ImageRepositoryAmarnaSignalsBlobInfo | DateTime | |
| reason | ImageRepositoryAmarnaStatus | This message stores the status and reason why Amarna was unable to provide perdoc information for an image. | String | |
| status | ImageRepositoryAmarnaStatus | This message stores the status and reason why Amarna was unable to provide perdoc information for an image. | String | |
| aggregatedPornScores | Aggregated porn scores for animated images. Aggregated using max sampling rate / max duration. Note the plan is to fold these scores into existing summarized scores, for cases where these scores are available. See tracking bug b/63580795. | ImageRepositoryAnimatedImagePerdocData | Additional animated image data stored in perdoc (ImageData); will only be stored for animated images. | ImageSafesearchContentBrainPornAnnotation |
| durationMs | Total duration of animation, in ms. | ImageRepositoryAnimatedImagePerdocData | Additional animated image data stored in perdoc (ImageData); will only be stored for animated images. | integer |
| expirationTimestampSec | Timestamp (measured in seconds since epoch) after which Amarna will delete the serving transcode. | ImageRepositoryApiItagSpecificMetadata | The metadata returned with each transcode. Next available field: 9 | String |
| genus | The Venom Genus that this transcode was produced for. | ImageRepositoryApiItagSpecificMetadata | The metadata returned with each transcode. Next available field: 9 | String |
| state | Indicates the state in Venom for this transcode type. | ImageRepositoryApiItagSpecificMetadata | The metadata returned with each transcode. Next available field: 9 | String |
| transcodeItag | transcode type which are available for the video. | ImageRepositoryApiItagSpecificMetadata | The metadata returned with each transcode. Next available field: 9 | integer |
| videoId | The Venom ID that this transcode was produced for. | ImageRepositoryApiItagSpecificMetadata | The metadata returned with each transcode. Next available field: 9 | VideoAssetsVenomVideoId |
| xtagsList | Indicates xtags if present. Xtag makes the different transcode. For transcode “MP4_AVCBASE640_AAC/af=sq” (itag 18 with xtag), “af=sq” is the xtag part. This is a different transcode than “MP4_AVCBASE640_AAC” (itag 18). | ImageRepositoryApiItagSpecificMetadata | The metadata returned with each transcode. Next available field: 9 | ImageRepositoryApiXtagList |
| name | Names are all stored case-sensitive, and no case-folding is done for comparisons. | ImageRepositoryApiXtag | String | |
| value | The value associated with this Xtag. Values are all stored case-sensitive, and no case-folding is done for comparisons. | ImageRepositoryApiXtag | String | |
| xtags | ImageRepositoryApiXtagList | XtagList — a collection of Xtag instances with unique names. This would be associated with one specific piece of content. | list(ImageRepositoryApiXtag) | |
| aresClassificationRequestTimestamp | Timestamp of the last successful Ares classification request. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | DateTime |
| videoPreviewBytes | video_preview_bytes is only exported as virtual dataset by IE VideoUnderstanding and should not be persisted. It will be used by downstream IE functions to push for serving. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | list(ImageRepositoryVideoPreviewsVideoPreview) |
| loudnessData | When Transcode itag 140 is requested, MediaAnalyzer (as the part of Viper graph) generates audio info including loudness_data, which is then published to Streamer. For Audio news client, we extract this loudness data from Streamer to this field. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | VideoStorageLoudnessData |
| cloudSpeechSignals | Transcript generated from Cloud Speech API | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | ImageRepositoryAmarnaCloudSpeechSignals |
| featureSetData | Video Understanding Golden features. (go/amarna-video-signals#golden-signals) Note: Golden6 features (names matching “video_*”) are DEPRECATED. Please migrate to Golden7 (“VideoFeatures.*”). For more context, see go/golden7/migrating-from-golden6 and go/amarna-golden-feature-tracker. Signals popluated in Raffia cdoc.doc_videos are configured in cs/symbol:AMARNA_EXPORTED_GOLDEN7_FEATURES. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | DrishtiFeatureSetData |
| videoPornScoreV4 | The video porn confidence score extracted from WhisperV4 featureSet: “VideoFeatures.whisper_v4_labels”, with CR2 label: “/tns/porn”. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | number |
| transcriptAsr | Speech related metadata The transcript_asr field is generated from the YT caption’s SPEECH_RECOGNIZER asset. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | PseudoVideoData |
| lmsPreviewFramePerdocs | LMS preview frame perdocs. Timestamps of the frame perdocs are from the original video, not from the preview. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | ImageRepositoryFramePerdocs |
| signalsBlob | Amarna signals blob that contains large-size signals like VCA frame-level signals. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | ImageRepositoryAmarnaSignalsBlob |
| s3LanguageIdentification | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | ImageRepositoryS3LangIdSignals | |
| frameLevelStarburstEmbeddings | Frame-level Starburst embeddings. They are IE only signals for short videos initially and will be supported for all videos later. (go/frame-level-sbv5-on-ie) | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | ImageRepositoryFrameLevelStarburstEmbeddings |
| golden7SoapboxTracksBlobInfo | Information on frame-level people feature blob. (go/vpf-frame-features) | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | ImageRepositoryAmarnaSignalsBlobInfo |
| videoStreamInfo | Deprecated, please use media_info. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | VideoPipelineViperVSIColumnData |
| thumbnailerData | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | VideoPipelineViperThumbnailerColumnData | |
| transcodeMetadata | Metadata about each transcode requested. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | list(ImageRepositoryApiItagSpecificMetadata) |
| truncationInfo | Data about whether or not the video was truncated. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | ImageRepositoryFileTruncationInfo |
| speechProperties | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | IndexingSpeechSpeechPropertiesProto | |
| mediaInfo | Information about the media file, such as duration, resolution, and detail about each audio/video stream. Note that it contains no PII. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | VideoMediaInfo |
| venomId | The video id in the venom pipeline for STAMP purposes. DEPRECATED: Use transcode_metadata or venom_processing_info instead, which includes the ID and contains information for all clients. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | String |
| s3Asr | Trnascript generated through AMARNA_CLOUD_SPEECH asset in Venom. Note that AMARNA_CLOUD_SPEECH uses S3 as the speech engine backend, similar to YT caption’s SPEECH_RECOGNIZER asset. However, they may use different S3 models. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | ImageRepositoryAmarnaCloudSpeechSignals |
| venomProcessingInfo | Information about the video’s status in Venom, including IDs and processing times. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | ImageRepositoryVenomProcessingInfo |
| safesearchVideoContentSignals | Contains SafeSearch video classification outputs which are vertical_name/float pairs. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | SafesearchVideoContentSignals |
| videoPornScore | The video porn confidence score extracted from Whisper featureSet: “video_labels:whisper_v3”, with CR2 label: “/cr2/1”. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | number |
| thumbnailQualityScore | Thumbnail quality score predict how visual pleasing a thumbnail is, based on the model trained with deep neural networks.(go/thumb_features_dd) Note the signal currently only available for Youtube videos. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | VideoThumbnailsThumbnailScore |
| languageIdentification | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | VideoTimedtextS4ALIResults | |
| representativeFrameData | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | ImageData | |
| videoDurationSec | Set from the video header if truncated, or is the verified length if completely crawled. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | float |
| inlinePlayback | Metadata related to Inline playback on the Interest Feed. This field is filled by Hamilton. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | VideoCrawlVideoInlinePlaybackMetadata |
| signalsBlobInfo | Information for the amarna signals blob. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | ImageRepositoryAmarnaSignalsBlobInfo |
| audioOnly | Both audio- and audio-video-files are treated as videos during indexing (whether they share a container format, like .mp4, or not, like .mp3). This bool indicates that there’s no video track, just an audio track. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | boolean |
| golden7SoapboxSummary | Golden7 video-level people features. (go/ypf-video-features) | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | DrishtiFeatureSetData |
| videoAnchorSet | Video anchor sets hold set of anchors with multiple anchor types and sequence of VideoAnchor which contains metadata about the anchor, such as thumbnail, perdoc data. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | VideoContentSearchVideoAnchorSets |
| amarnaDocid | A hash of the video bytes used as a key to Amarna’s video_metadata table. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | String |
| multiThumbnailsFramePerdocs | multi_thumbnails_frame_perdocs contains perdocs(go/vss-signals#perdoc) for all frame thumbnails generated by multiple frames per minutes. See more details in go/multiple-thumbnails-per-minutes. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | ImageRepositoryFramePerdocs |
| videoPreviews | video_previews contain the preview metadata but no bytes. It exits for IE and non-IE cases. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | list(ImageBaseVideoPreviewMetadata) |
| legosAnnotationData | Legos results | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | VideoLegosLegosAnnotationsSets |
| youtubeProcessingFilter | Contains lists of reasons why YT videos were filtered from specific processing. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | ImageRepositoryYoutubeProcessingFilter |
| unwantedContent | If set, video has been deleted using the deletion service (MediaDeletionService). | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | ImageRepositoryUnwantedContent |
| searchDocid | 64 bit docid used for retrieving video previews. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | String |
| videoTranscriptAnnotations | VideoTranscriptAnnotations holds sentence segmented text and timing information to be used for VideoAnswers (go/video-answers). Note that only punctuated_transcript, timing_info, and lang field are filled, and other fields will be filled in the later stage. | ImageRepositoryContentBasedVideoMetadata | Next Tag: 52 | QualityWebanswersVideoTranscriptAnnotations |
| code | ImageRepositoryCrawlStatusInfo | Fields for crawl-status-related debugging information. | String | |
| notCrawledReason | ImageRepositoryCrawlStatusInfo | Fields for crawl-status-related debugging information. | String | |
| score | DeepImageEngagingness score. | ImageRepositoryDeepImageEngagingnessOutput | number | |
| originalFileSizeLowerBoundBytes | A lower bound on the original file’s size. | ImageRepositoryFileTruncationInfo | Describes our knowledge about whether a stored file is truncated with respect to its original file online. | String |
| truncationState | Indicates whether the stored file is equal to the original file (COMPLETE), is only a prefix (TRUNCATED), or that we don’t know (UNKNOWN, the default). | ImageRepositoryFileTruncationInfo | Describes our knowledge about whether a stored file is truncated with respect to its original file online. | String |
| multiThumbnailVariant | ImageRepositoryFrameIdentifier | Identifier for frames associated with a video. | ImageRepositoryFrameIdentifierMultiThumbnailVariant | |
| previewFrameZeroVariant | ImageRepositoryFrameIdentifier | Identifier for frames associated with a video. | ImageRepositoryFrameIdentifierPreviewFrameZeroVariant | |
| thumbnailVariant | ImageRepositoryFrameIdentifier | Identifier for frames associated with a video. | ImageRepositoryFrameIdentifierThumbnailVariant | |
| timestampMs | Offset of the frame from the beginning of the video (in milliseconds). | ImageRepositoryFrameIdentifier | Identifier for frames associated with a video. | integer |
| previewLength | ImageRepositoryFrameIdentifierPreviewFrameZeroVariant | This variant defines the frame to be the first frame of the video’s generated preview. | String | |
| xtagList | All xtags used in the generation of the preview. The same frame generated from the same preview with different xtags will likely have different bytes (such as, for example, resulting from a different aspect ratio). | ImageRepositoryFrameIdentifierPreviewFrameZeroVariant | This variant defines the frame to be the first frame of the video’s generated preview. | ImageRepositoryApiXtagList |
| starburstV5Embeddings | Frame-level Starburst V5 embeddings computed by SUP. See https://data.corp.google.com/su_catalog/signal/starburst:v5. | ImageRepositoryFrameLevelStarburstEmbeddings | Each supported Starburst embedding version will have a pair of AmarnaSignalsBlobInfo and SUPFrameLevelEmbeddings. Blob info has the blob id of the corresponding embeddings and a blob write timestamp. SUPFrameLevelEmbeddings are the actual frame-level embeddings at 1 FPS. MMS callers have 3 options to fetch frame-level Starburst embeddings: 1. OPTION_NONE (default): Don’t fetch frame-level Starburst embeddings. 2. OPTION_BLOB_DATA: Fetch the actual Starburst embeddings in SUPFrameLevelEmbeddings. 3. OPTION_CLONED_BLOB_ID: Clone the starburst embeddings into the target Blobstore directory. Then, fetch the cloned blob id of Starburst embeddings in AmarnaSignalsBlobInfo. | ImageRepositorySUPFrameLevelEmbeddings |
| starburstV5EmbeddingsBlobInfo | Frame-level Starburst V5 embeddings blob id. | ImageRepositoryFrameLevelStarburstEmbeddings | Each supported Starburst embedding version will have a pair of AmarnaSignalsBlobInfo and SUPFrameLevelEmbeddings. Blob info has the blob id of the corresponding embeddings and a blob write timestamp. SUPFrameLevelEmbeddings are the actual frame-level embeddings at 1 FPS. MMS callers have 3 options to fetch frame-level Starburst embeddings: 1. OPTION_NONE (default): Don’t fetch frame-level Starburst embeddings. 2. OPTION_BLOB_DATA: Fetch the actual Starburst embeddings in SUPFrameLevelEmbeddings. 3. OPTION_CLONED_BLOB_ID: Clone the starburst embeddings into the target Blobstore directory. Then, fetch the cloned blob id of Starburst embeddings in AmarnaSignalsBlobInfo. | ImageRepositoryAmarnaSignalsBlobInfo |
| errorStatus | Error, if any, while generating the frame perdoc. It is mutually exclusive to the perdoc, only set when perdoc is missing. | ImageRepositoryFramePerdoc | Only one of timestamp_msec or frame_identifier should be set. timestamp_msec is the old identifier for frames, and is still used on thumbnail frames. frame_identifier should be used on other kinds of frames (e.g. preview frame zero). | UtilStatusProto |
| frameIdentifier | ImageRepositoryFramePerdoc | Only one of timestamp_msec or frame_identifier should be set. timestamp_msec is the old identifier for frames, and is still used on thumbnail frames. frame_identifier should be used on other kinds of frames (e.g. preview frame zero). | ImageRepositoryFrameIdentifier | |
| perdoc | ImageRepositoryFramePerdoc | Only one of timestamp_msec or frame_identifier should be set. timestamp_msec is the old identifier for frames, and is still used on thumbnail frames. frame_identifier should be used on other kinds of frames (e.g. preview frame zero). | ImageData | |
| timestampMsec | Timestamp (in msec) of the frame from the original video DEPRECATED: Use the timestamp_ms field in frame_identifier instead. | ImageRepositoryFramePerdoc | Only one of timestamp_msec or frame_identifier should be set. timestamp_msec is the old identifier for frames, and is still used on thumbnail frames. frame_identifier should be used on other kinds of frames (e.g. preview frame zero). | integer |
| framePerdoc | ImageRepositoryFramePerdocs | This proto stores perdocs extracted from video frames. | list(ImageRepositoryFramePerdoc) | |
| fingerprintNearestNeighborDecision | Decision according to the given fingerprint nearest neighbor score. | ImageRepositoryGeneratedImageLikelihoodSignal | String | |
| provenanceClassifierDecision | OVERALL DECISION Decision according to the given watermark logits and fingerprint nearest neighbor score. | ImageRepositoryGeneratedImageLikelihoodSignal | String | |
| watermarkDecision | INDIVIDUAL DECISION Decision according to the given watermark logits. | ImageRepositoryGeneratedImageLikelihoodSignal | String | |
| localeStripped | Whether the locale got stripped from the original result before further processing. | ImageRepositoryLanguageIdentificationResult | boolean | |
| s3TopLocale | From cs/symbol:speech.s3.LanguageIdentificationResult owned by go/s3. | ImageRepositoryLanguageIdentificationResult | String | |
| ytCapsAudioLanguage | From cs/symbol:video_platform.operation.AudioLanguage owned gy go/ytcaps. | ImageRepositoryLanguageIdentificationResult | String | |
| score | NIMA score. | ImageRepositoryNimaOutput | number | |
| audioInputCap | Audio input processing cap. | ImageRepositoryS3LangIdDebuggingInfo | For debugging only. | String |
| failedSegments | Number of failed segments. Successful segments are stored in `langid_signals_for_segment`. | ImageRepositoryS3LangIdDebuggingInfo | For debugging only. | integer |
| processedSegments | Number of processed segments. | ImageRepositoryS3LangIdDebuggingInfo | For debugging only. | integer |
| segmentDuration | Duration of each segment (except for the last one if capped). | ImageRepositoryS3LangIdDebuggingInfo | For debugging only. | String |
| segmentStride | If >1, every N segment is processed. | ImageRepositoryS3LangIdDebuggingInfo | For debugging only. | integer |
| waveHeader | Wave header of the audio input. | ImageRepositoryS3LangIdDebuggingInfo | For debugging only. | SpeechWaveHeader |
| containsSpeech | Whether this audio chunk has speech or not. | ImageRepositoryS3LangIdSignals | Next Tag: 10 | boolean |
| debuggingInfo | ImageRepositoryS3LangIdSignals | Next Tag: 10 | ImageRepositoryS3LangIdDebuggingInfo | |
| endSec | ImageRepositoryS3LangIdSignals | Next Tag: 10 | String | |
| langidResult | S3 langID result. We keep langid_result even if contains_speech = false. | ImageRepositoryS3LangIdSignals | Next Tag: 10 | SpeechS3LanguageIdentificationResult |
| languageIdentification | Converted version of the langid_result field, so that we have the YT compatible version of the langID result. | ImageRepositoryS3LangIdSignals | Next Tag: 10 | VideoTimedtextS4ALIResults |
| modelVersion | The version of the model used for S3 LangID service. | ImageRepositoryS3LangIdSignals | Next Tag: 10 | String |
| speechFrameCount | ImageRepositoryS3LangIdSignals | Next Tag: 10 | integer | |
| startSec | The audio chunk which corresponds to this langID result expressed as a start_sec and end_sec. | ImageRepositoryS3LangIdSignals | Next Tag: 10 | String |
| totalFrameCount | Count the number of total frames in the audio chunk as well as the number of speech frames. | ImageRepositoryS3LangIdSignals | Next Tag: 10 | integer |
| mode | ImageRepositoryS3RecognizerMetadataResponse | This proto is trimmed down from RecognizerMetadataResponse in google3/speech/service/s3/services/recognizer/recognizer.proto | String | |
| modelInfoLabel | ImageRepositoryS3RecognizerMetadataResponse | This proto is trimmed down from RecognizerMetadataResponse in google3/speech/service/s3/services/recognizer/recognizer.proto | String | |
| serviceName | ImageRepositoryS3RecognizerMetadataResponse | This proto is trimmed down from RecognizerMetadataResponse in google3/speech/service/s3/services/recognizer/recognizer.proto | String | |
| productSets | Information about versioned product sets found. There will be at most two versions present. The results from the current version of the models used in VSS and the results from the previous version of the models used. Note that not all products may have two version since the model might detect the product in one version and not the other. | ImageRepositoryShoppingProductInformation | A message containing embedding information and localization scores using the VSS product recognition module. | list(ImageRepositoryShoppingProductInformationVersionedProductInformationSet) |
| h | The vertical height of the bounding box (ymax – ymin + 1), normalized by image height with range [0,1]. | ImageRepositoryShoppingProductInformationBoundingBox | Contains the coordinates of the normalized bounding box. | number |
| w | The horizontal width of the bound box (xmax – xmin + 1), normalized by image width with range [0,1]. | ImageRepositoryShoppingProductInformationBoundingBox | Contains the coordinates of the normalized bounding box. | number |
| x | The x coordinate (xmin), normalized by image width with range [0,1). | ImageRepositoryShoppingProductInformationBoundingBox | Contains the coordinates of the normalized bounding box. | number |
| y | The y coordinate (ymin), normalized by image height with range [0,1). | ImageRepositoryShoppingProductInformationBoundingBox | Contains the coordinates of the normalized bounding box. | number |
| id | ImageRepositoryShoppingProductInformationEntity | The recognized entity. | String | |
| score | The normalized recognition score between 0 and 1. | ImageRepositoryShoppingProductInformationEntity | The recognized entity. | number |
| categoryId | The possible Merlot ids for the item. There may be more than one if the product detector result corresponds to a collection of merlot ids, which can’t be easily grouped up to a common ancestor, for which the detector would still make sense for all the children. E.g. a detected “chair” can be either an indoor chair or an outdoor one, however in Merlot the common ancestor of the two is furniture. | ImageRepositoryShoppingProductInformationProductInformation | Information about a single product. For ProductNet models, each product has one label with a detection score. The label is mapped to one or multiple category ids. For PRIMI generic feature models, each product can have multiple entities, and each entity has a score. The category_id and detection_score fields are not populated for PRIMI generic feature models. | list(integer) |
| clusterIds | The k-d tree clusters for retrieval. Will be deprecated, use the token_groups instead. To add tokens/cluster_ids from new tokenization model in the future, add it to the token_groups. | ImageRepositoryShoppingProductInformationProductInformation | Information about a single product. For ProductNet models, each product has one label with a detection score. The label is mapped to one or multiple category ids. For PRIMI generic feature models, each product can have multiple entities, and each entity has a score. The category_id and detection_score fields are not populated for PRIMI generic feature models. | list(integer) |
| detectionScore | The localization detection score. | ImageRepositoryShoppingProductInformationProductInformation | Information about a single product. For ProductNet models, each product has one label with a detection score. The label is mapped to one or multiple category ids. For PRIMI generic feature models, each product can have multiple entities, and each entity has a score. The category_id and detection_score fields are not populated for PRIMI generic feature models. | number |
| embedding | The serialized embedding values. | ImageRepositoryShoppingProductInformationProductInformation | Information about a single product. For ProductNet models, each product has one label with a detection score. The label is mapped to one or multiple category ids. For PRIMI generic feature models, each product can have multiple entities, and each entity has a score. The category_id and detection_score fields are not populated for PRIMI generic feature models. | String |
| entities | The recognized entities and scores. | ImageRepositoryShoppingProductInformationProductInformation | Information about a single product. For ProductNet models, each product has one label with a detection score. The label is mapped to one or multiple category ids. For PRIMI generic feature models, each product can have multiple entities, and each entity has a score. The category_id and detection_score fields are not populated for PRIMI generic feature models. | list(ImageRepositoryShoppingProductInformationEntity) |
| featureType | Feature type (different detectors and embedders) requested. | ImageRepositoryShoppingProductInformationProductInformation | Information about a single product. For ProductNet models, each product has one label with a detection score. The label is mapped to one or multiple category ids. For PRIMI generic feature models, each product can have multiple entities, and each entity has a score. The category_id and detection_score fields are not populated for PRIMI generic feature models. | String |
| productLocation | The bounding box. | ImageRepositoryShoppingProductInformationProductInformation | Information about a single product. For ProductNet models, each product has one label with a detection score. The label is mapped to one or multiple category ids. For PRIMI generic feature models, each product can have multiple entities, and each entity has a score. The category_id and detection_score fields are not populated for PRIMI generic feature models. | ImageRepositoryShoppingProductInformationBoundingBox |
| tokenGroups | ImageRepositoryShoppingProductInformationProductInformation | Information about a single product. For ProductNet models, each product has one label with a detection score. The label is mapped to one or multiple category ids. For PRIMI generic feature models, each product can have multiple entities, and each entity has a score. The category_id and detection_score fields are not populated for PRIMI generic feature models. | list(ImageRepositoryShoppingProductInformationProductInformationTokenGroup) | |
| model | ImageRepositoryShoppingProductInformationProductInformationTokenGroup | The tokens for retrieval. | String | |
| tokens | ImageRepositoryShoppingProductInformationProductInformationTokenGroup | The tokens for retrieval. | list(integer) | |
| modelType | The type of the model. | ImageRepositoryShoppingProductInformationVersionedProductInformationSet | Store ProductInformation for a given version of the models used in VSS. | String |
| products | List of ProductInformation for this version. | ImageRepositoryShoppingProductInformationVersionedProductInformationSet | Store ProductInformation for a given version of the models used in VSS. | list(ImageRepositoryShoppingProductInformationProductInformation) |
| version | The version of the models used in VSS. Newer version will have a higher version number. | ImageRepositoryShoppingProductInformationVersionedProductInformationSet | Store ProductInformation for a given version of the models used in VSS. | integer |
| confidence | The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative of a non-streaming result or, of a streaming result where `is_final=true`. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. | ImageRepositorySpeechRecognitionAlternative | Alternative hypotheses (a.k.a. n-best list). | number |
| transcript | Transcript text representing the words that the user spoke. | ImageRepositorySpeechRecognitionAlternative | Alternative hypotheses (a.k.a. n-best list). | String |
| words | A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. | ImageRepositorySpeechRecognitionAlternative | Alternative hypotheses (a.k.a. n-best list). | list(ImageRepositoryWordInfo) |
| alternatives | May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. | ImageRepositorySpeechRecognitionResult | A speech recognition result corresponding to a portion of the audio. This field is copied from cloud/speech/v1p1beta1/cloud_speech.proto. Amarna needs to have a standalone version as v1p1beta1/cloud_speech.proto is in the for of versioned proto and it breaks other prod code depending on Amarna’s video schema. | list(ImageRepositorySpeechRecognitionAlternative) |
| channelTag | For multi-channel audio, this is the channel number corresponding to the recognized result for the audio from that channel. For audio_channel_count = N, its output values can range from ‘1’ to ‘N’. | ImageRepositorySpeechRecognitionResult | A speech recognition result corresponding to a portion of the audio. This field is copied from cloud/speech/v1p1beta1/cloud_speech.proto. Amarna needs to have a standalone version as v1p1beta1/cloud_speech.proto is in the for of versioned proto and it breaks other prod code depending on Amarna’s video schema. | integer |
| languageCode | The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. | ImageRepositorySpeechRecognitionResult | A speech recognition result corresponding to a portion of the audio. This field is copied from cloud/speech/v1p1beta1/cloud_speech.proto. Amarna needs to have a standalone version as v1p1beta1/cloud_speech.proto is in the for of versioned proto and it breaks other prod code depending on Amarna’s video schema. | String |
| resultEndTime | Time offset of the end of this result relative to the beginning of the audio. This field is internal-only and is used to order results based on their timestamps. | ImageRepositorySpeechRecognitionResult | A speech recognition result corresponding to a portion of the audio. This field is copied from cloud/speech/v1p1beta1/cloud_speech.proto. Amarna needs to have a standalone version as v1p1beta1/cloud_speech.proto is in the for of versioned proto and it breaks other prod code depending on Amarna’s video schema. | String |
| embedding | Embedding of the frame. | ImageRepositorySUPFrameLevelEmbedding | ReneEmbedding | |
| timeOffset | Time offset of the frame. | ImageRepositorySUPFrameLevelEmbedding | String | |
| embeddings | All the frame-level embeddings of the video. | ImageRepositorySUPFrameLevelEmbeddings | list(ImageRepositorySUPFrameLevelEmbedding) | |
| deletionReason | ImageRepositoryUnwantedContent | To indicate whether the image or video is to be deleted from the repository due to legal reasons or hidden from search results. | String | |
| hideReason | ImageRepositoryUnwantedContent | To indicate whether the image or video is to be deleted from the repository due to legal reasons or hidden from search results. | String | |
| venomStatus | Contains one status for each Genus that this video belongs to in Venom. For example, a video that is both 1) Found on the web, and 2) Opted-in by an Interest Feed partner would have two entries, one for GENUS_CRAWL and one for GENUS_VIDEO_INTEREST_FEED | ImageRepositoryVenomProcessingInfo | list(ImageRepositoryVenomStatus) | |
| acl | Venom ACL of the video. Used to check if other systems, such as Ares, are able to process the video. | ImageRepositoryVenomStatus | VideoAssetsVenomACL | |
| deletionTimestampUsec | ImageRepositoryVenomStatus | String | ||
| genus | The Genus (Venom’s client ID) that this media belongs to. | ImageRepositoryVenomStatus | String | |
| insertionResponseTimestampUsec | Time that VideoNotification result was received from Venom. | ImageRepositoryVenomStatus | String | |
| insertionTimestampUsec | ImageRepositoryVenomStatus | String | ||
| lastInsertionAttemptsNum | Record the attempts num of previous insertion. It’s only updated when either the insertion succeeds or fails with reason INSERTION_ATTEMPTS_EXCEEDED, but it’s always set so that we can easily construct venom_id with this attempts num for future insertions. | ImageRepositoryVenomStatus | integer | |
| reason | ImageRepositoryVenomStatus | String | ||
| settings | The Settings that were used to customize the Venom request for this media. | ImageRepositoryVenomStatus | list(VideoAssetsVenomSettings) | |
| state | ImageRepositoryVenomStatus | String | ||
| transition | Transition contains the Objective and Outcome of the latest Venom run. | ImageRepositoryVenomStatus | VideoAssetsVenomTransition | |
| venomId | The media’s unique identifier within Venom. | ImageRepositoryVenomStatus | VideoAssetsVenomVideoId | |
| venomMutationGeneration | The generation number returned by Venom. | ImageRepositoryVenomStatus | String | |
| videoVenomSetting | This field is not persisted anywhere. It is only used in deletion service for converying the VideoVenomSetting when deleting Venom data. | ImageRepositoryVenomStatus | String | |
| notIndexedVideoLink | ImageRepositoryVideoIndexingInfo | list(ImageRepositoryVideoLinkIndexingInfo) | ||
| crawlStatusInfo | Fields for crawl-status-related debugging information. | ImageRepositoryVideoLinkIndexingInfo | ImageRepositoryCrawlStatusInfo | |
| url | The video URL. | ImageRepositoryVideoLinkIndexingInfo | String | |
| lastAmarnaProcessingTime | Last Amarna processing timestamp. | ImageRepositoryVideoPreviewsDebuggingInfo | DateTime | |
| processingEngine | The underlying processing engine, like ‘viper’ or ‘kronos’. | ImageRepositoryVideoPreviewsDebuggingInfo | String | |
| content | The actual video preview bytes generated for the video. | ImageRepositoryVideoPreviewsVideoPreview | String | |
| debuggingInfo | Used for debugging only. | ImageRepositoryVideoPreviewsVideoPreview | ImageRepositoryVideoPreviewsDebuggingInfo | |
| metadata | The metadata associated with the preview (i.e. the type: 8k, 90k, etc.) | ImageRepositoryVideoPreviewsVideoPreview | ImageBaseVideoPreviewMetadata | |
| previewFrameZero | 0th frame image of the preview. This frame has the same resolution as the associated preview video bytes, as it is taken directly from the preview bytes in Venom/Viper processing. Right now, we only populate preview_frame_zero only for the VPREVIEW_TYPE_540K_ORIGINAL_HQ_LICENSED preview type. Note that preview_frame_zero.thumbnails(0).timestamp_ms() is the timestamp from the full video, not from the preview. | ImageRepositoryVideoPreviewsVideoPreview | DrishtiVesperVideoThumbnail | |
| audioOnly | Both audio- and audio-video-files are treated as videos during indexing (whether they share a container format, like .mp4, or not, like .mp3). This bool indicates that there’s no video track, just an audio track. | ImageRepositoryVideoProperties | boolean | |
| contentBasedMetadata | Information derived from fetched video bytes. | ImageRepositoryVideoProperties | ImageRepositoryContentBasedVideoMetadata | |
| crawlState | The raw crawl state. | ImageRepositoryVideoProperties | ImageMoosedogCrawlState | |
| firstCrawlTimestampSec | Timestamp of the first time that the video was successfully crawled. | ImageRepositoryVideoProperties | String | |
| firstProcessingTimestampSec | Timestamp when this video’s videoProperties is populated for the first time, measured in seconds since epoch. | ImageRepositoryVideoProperties | String | |
| indexedVerticals | Proto to store vertical indexing information for the document. The video can be indexed to multiple verticals, including video search. It can also be indexed only in verticals, not in video search. | ImageRepositoryVideoProperties | list(ImageRepositoryVideoPropertiesVerticalIndexingInfoVideo) | |
| inlinePlayback | DEPRECATED: please use content_based_metadata.inline_playback. Metadata related to Inline playback on the Interest Feed | ImageRepositoryVideoProperties | VideoCrawlVideoInlinePlaybackMetadata | |
| lastCrawlRequestTimestampSec | Timestamp when this video’s last crawling is requested, measured in seconds since epoch. | ImageRepositoryVideoProperties | String | |
| lastProcessingTimestampSec | Last timestamp when this video’s videoProperties is populated, measured in seconds since epoch. | ImageRepositoryVideoProperties | String | |
| url | This is the video url taken from the key of the Amarna references table row corresponding to this message. | ImageRepositoryVideoProperties | String | |
| name | List the string representation of the vertical that this image is indexed into. | ImageRepositoryVideoPropertiesVerticalIndexingInfoVideo | Proto to store vertical indexing information for the document and associated video outlinks. The video content can be indexed to multiple verticals, including videosearch. It can also be indexed only in verticals, not in videosearch. | String |
| confidence | The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative of a non-streaming result or, of a streaming result where `is_final=true`. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. | ImageRepositoryWordInfo | Word-specific information for recognized words. | number |
| endTime | Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. | ImageRepositoryWordInfo | Word-specific information for recognized words. | String |
| speakerTag | A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from ‘1’ to diarization_speaker_count. speaker_tag is set if enable_speaker_diarization = ‘true’ and only in the top alternative. | ImageRepositoryWordInfo | Word-specific information for recognized words. | integer |
| startTime | Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. | ImageRepositoryWordInfo | Word-specific information for recognized words. | String |
| word | The word corresponding to this set of information. | ImageRepositoryWordInfo | Word-specific information for recognized words. | String |
| previewsFilteredReason | ImageRepositoryYoutubeProcessingFilter | Next available tag: 13 | list(String) | |
| childScore | The probability that the youngest person in the image is a child. | ImageSafesearchContentBrainPornAnnotation | Don’t change the field names. The names are used as sparse feature labels in client projects. | number |
| csaiScore | This score correlates with potential child abuse. Google confidential! | ImageSafesearchContentBrainPornAnnotation | Don’t change the field names. The names are used as sparse feature labels in client projects. | float |
| csamA1Score | Experimental score. Do not use. Google confidential! | ImageSafesearchContentBrainPornAnnotation | Don’t change the field names. The names are used as sparse feature labels in client projects. | number |
| csamAgeIndeterminateScore | Experimental score. Do not use. Google confidential! | ImageSafesearchContentBrainPornAnnotation | Don’t change the field names. The names are used as sparse feature labels in client projects. | number |
| iuInappropriateScore | This field contains the probability that an image is inappropriate for Images Universal, according to this policy: go/iupolicy. | ImageSafesearchContentBrainPornAnnotation | Don’t change the field names. The names are used as sparse feature labels in client projects. | number |
| medicalScore | ImageSafesearchContentBrainPornAnnotation | Don’t change the field names. The names are used as sparse feature labels in client projects. | number | |
| pedoScore | ImageSafesearchContentBrainPornAnnotation | Don’t change the field names. The names are used as sparse feature labels in client projects. | number | |
| pornScore | ImageSafesearchContentBrainPornAnnotation | Don’t change the field names. The names are used as sparse feature labels in client projects. | float | |
| racyScore | This score is related to an image being sexually suggestive. | ImageSafesearchContentBrainPornAnnotation | Don’t change the field names. The names are used as sparse feature labels in client projects. | number |
| semanticSexualizationScore | This score is related to racy/sexual images where scores have semantic meaning from 0 to 1. | ImageSafesearchContentBrainPornAnnotation | Don’t change the field names. The names are used as sparse feature labels in client projects. | number |
| spoofScore | ImageSafesearchContentBrainPornAnnotation | Don’t change the field names. The names are used as sparse feature labels in client projects. | number | |
| version | ImageSafesearchContentBrainPornAnnotation | Don’t change the field names. The names are used as sparse feature labels in client projects. | String | |
| violenceScore | ImageSafesearchContentBrainPornAnnotation | Don’t change the field names. The names are used as sparse feature labels in client projects. | number | |
| ytPornScore | Deprecated, use porn_score instead. The most recent model version does not produce this anymore. | ImageSafesearchContentBrainPornAnnotation | Don’t change the field names. The names are used as sparse feature labels in client projects. | number |
| ocrAnnotationVersion | A string that indicates the version of SafeSearch OCR annotation. | ImageSafesearchContentOCRAnnotation | A protocol buffer to store the OCR annotation. Next available tag id: 10. | String |
| ocrProminenceScore | The score produced by Aksara geometry and spoof score. Describes the ‘visibility’ or ‘importance’ of the text on the image [0, 1] | ImageSafesearchContentOCRAnnotation | A protocol buffer to store the OCR annotation. Next available tag id: 10. | number |
| pornScore | Image OCR racyness/pornyness, computed by porn query classifier. | ImageSafesearchContentOCRAnnotation | A protocol buffer to store the OCR annotation. Next available tag id: 10. | number |
| prominentOffensiveScore | Same as offensive_score, but weighted by prominence. | ImageSafesearchContentOCRAnnotation | A protocol buffer to store the OCR annotation. Next available tag id: 10. | number |
| prominentVulgarScore | Same as vulgar_score, but weighted by prominence. | ImageSafesearchContentOCRAnnotation | A protocol buffer to store the OCR annotation. Next available tag id: 10. | number |
| qbstOffensiveScore | The score produced by offensive salient terms model. | ImageSafesearchContentOCRAnnotation | A protocol buffer to store the OCR annotation. Next available tag id: 10. | number |
| matches | ImageSafesearchContentOffensiveSymbolDetection | list(ImageSafesearchContentOffensiveSymbolMatch) | ||
| score | Confidence score of the match. The higher, the more likely to match the symbol. | ImageSafesearchContentOffensiveSymbolMatch | Each entry corresponds to an image containing an offensive symbol. | number |
| type | ImageSafesearchContentOffensiveSymbolMatch | Each entry corresponds to an image containing an offensive symbol. | String | |
| imageLinkSelectionInfo | Image Selection Info | ImageSearchImageIndexingInfo | list(ImageSearchImageSelectionInfo) | |
| rejectedNotIndexedImageLink | URLs and Amarna status of images on the page for which image data is not yet available and weren’t selected for indexing in image search. Used by consumers of docjoins that need a complete view of image urls on the page (i.e. Digdug). | ImageSearchImageIndexingInfo | list(ImageSearchUnindexedImageLink) | |
| selectedNotIndexedImageLink | URLs and Amarna status of images on the page for which image data is not yet available and were otherwise selected for indexing in image search. Used by consumers of docjoins that need a complete view of selected image urls on the page (i.e. Hearse, the index selection testbed). | ImageSearchImageIndexingInfo | list(ImageSearchUnindexedImageLink) | |
| acquireLicensePage | Records web page url about how to use the licensed image. | ImageSearchImageLicenseInfo | The image license info for licensable images(go/Licensable-Images-PRD) This proto in design doc: go/licensable-images-edd | String |
| copyrightNotice | Provides copyright info. | ImageSearchImageLicenseInfo | The image license info for licensable images(go/Licensable-Images-PRD) This proto in design doc: go/licensable-images-edd | String |
| copyrightNoticeSourceType | Source type for copyright_notice field. | ImageSearchImageLicenseInfo | The image license info for licensable images(go/Licensable-Images-PRD) This proto in design doc: go/licensable-images-edd | String |
| creator | creator, authors. | ImageSearchImageLicenseInfo | The image license info for licensable images(go/Licensable-Images-PRD) This proto in design doc: go/licensable-images-edd | list(String) |
| creatorSourceType | Source type for creator field. | ImageSearchImageLicenseInfo | The image license info for licensable images(go/Licensable-Images-PRD) This proto in design doc: go/licensable-images-edd | String |
| creditText | Text for crediting persons or organizations. | ImageSearchImageLicenseInfo | The image license info for licensable images(go/Licensable-Images-PRD) This proto in design doc: go/licensable-images-edd | String |
| creditTextSourceType | Source type for credit_text field. | ImageSearchImageLicenseInfo | The image license info for licensable images(go/Licensable-Images-PRD) This proto in design doc: go/licensable-images-edd | String |
| isRetiredCcUrl | Whether this license url is in retired license list, which is from: https://creativecommons.org/retiredlicenses/ | ImageSearchImageLicenseInfo | The image license info for licensable images(go/Licensable-Images-PRD) This proto in design doc: go/licensable-images-edd | boolean |
| licenseType | ImageSearchImageLicenseInfo | The image license info for licensable images(go/Licensable-Images-PRD) This proto in design doc: go/licensable-images-edd | String | |
| licenseUrl | Records license URL. | ImageSearchImageLicenseInfo | The image license info for licensable images(go/Licensable-Images-PRD) This proto in design doc: go/licensable-images-edd | String |
| safesearchFlags | A bitwise-OR of SafeSearch filtering flags. If present, the flags will be a bitwise-AND between this value and all the classifier_porn::query::Vertical enums. If the value is -1, it indicates there is some error with SafeSearch classifier. The default value 0 means no filtering flags are set. | ImageSearchImageLicenseInfo | The image license info for licensable images(go/Licensable-Images-PRD) This proto in design doc: go/licensable-images-edd | integer |
| sourceType | ImageSearchImageLicenseInfo | The image license info for licensable images(go/Licensable-Images-PRD) This proto in design doc: go/licensable-images-edd | String | |
| imageLinkSelectionInfo | Image Selection Info. | ImageSearchImageSelectionInfo | ImageMustangImageLinkSelectionInfo | |
| url | The image URL. | ImageSearchImageSelectionInfo | String | |
| amarnaStatus | Insight on why we do not have data for this imagelink. | ImageSearchUnindexedImageLink | ImageRepositoryAmarnaStatus | |
| crawlStatusInfo | Fields for crawl-status-related debugging information. | ImageSearchUnindexedImageLink | ImageRepositoryCrawlStatusInfo | |
| url | The image URL. | ImageSearchUnindexedImageLink | String | |
| feature | Multiple feature embeddings for this bounding box. | ImageUnderstandingIndexingAnnotation | Annotation packs various recognition, detection, embedding, and parsing results. One Annotation per bounding box detection. | list(ImageUnderstandingIndexingFeature) |
| labelGroup | Multiple label annotations for this bounding box. | ImageUnderstandingIndexingAnnotation | Annotation packs various recognition, detection, embedding, and parsing results. One Annotation per bounding box detection. | list(ImageUnderstandingIndexingLabelGroup) |
| roi | Detected bounding box. Leave it not set for whole image annotation. | ImageUnderstandingIndexingAnnotation | Annotation packs various recognition, detection, embedding, and parsing results. One Annotation per bounding box detection. | ImageUnderstandingIndexingImageRegion |
| annotation | ImageUnderstandingIndexingAnnotationGroup | list(ImageUnderstandingIndexingAnnotation) | ||
| bytesValue | Multiple fields can be set. For example for Starburst V3, they can be used to store compressed byte, raw float feature, and tokens, respectively. | ImageUnderstandingIndexingFeature | Image feature embedding proto. It supports various embedding formats: raw bytes, floating point values, and tokens. | String |
| floatValue | ImageUnderstandingIndexingFeature | Image feature embedding proto. It supports various embedding formats: raw bytes, floating point values, and tokens. | list(number) | |
| imageTemplate | Local features. | ImageUnderstandingIndexingFeature | Image feature embedding proto. It supports various embedding formats: raw bytes, floating point values, and tokens. | PhotosVisionObjectrecImageTemplate |
| int32Value | ImageUnderstandingIndexingFeature | Image feature embedding proto. It supports various embedding formats: raw bytes, floating point values, and tokens. | list(integer) | |
| version | ImageUnderstandingIndexingFeature | Image feature embedding proto. It supports various embedding formats: raw bytes, floating point values, and tokens. | String | |
| box | Bounding box normalized to [0,1] scale independent on the image size. For example if the original image has the size 1600×1200, the rectangle [200, 200, 800, 600] from the image would have a normalized bounding box [1/8, 1/6, 1/2, 1/2]. | ImageUnderstandingIndexingImageRegion | Image region produced by a detector. | PhotosVisionGroundtruthdbNormalizedBoundingBox |
| score | Box confidence score. This is used to store the confidence of the box proposal, not the score associated with any specific labels. The box proposal confidence score is a float number per region between [0, 1] indicating how likely a box contains an “object”. | ImageUnderstandingIndexingImageRegion | Image region produced by a detector. | number |
| version | ImageUnderstandingIndexingImageRegion | Image region produced by a detector. | String | |
| canonicalText | Human readable text. | ImageUnderstandingIndexingLabel | A single label with score and meta data. | String |
| entityId | KG entity id. | ImageUnderstandingIndexingLabel | A single label with score and meta data. | String |
| metaData | Meta data for topicality, visible labels, attribute, etc. | ImageUnderstandingIndexingLabel | A single label with score and meta data. | list(ImageUnderstandingIndexingMetaData) |
| score | Confidence score. | ImageUnderstandingIndexingLabel | A single label with score and meta data. | number |
| label | ImageUnderstandingIndexingLabelGroup | LabelGroup is a set of labels produced by a single model, or by multiple models that share the same versioning. It can be used to store results from ICA, box classifier, visible labels, noun+attribute, and so on. | list(ImageUnderstandingIndexingLabel) | |
| version | ImageUnderstandingIndexingLabelGroup | LabelGroup is a set of labels produced by a single model, or by multiple models that share the same versioning. It can be used to store results from ICA, box classifier, visible labels, noun+attribute, and so on. | String | |
| floatValue | ImageUnderstandingIndexingMetaData | Meta data useful to annotation Label and Feature with extra information. | number | |
| name | ImageUnderstandingIndexingMetaData | Meta data useful to annotation Label and Feature with extra information. | String | |
| stringValue | ImageUnderstandingIndexingMetaData | Meta data useful to annotation Label and Feature with extra information. | String | |
| badSslCertificate | IndexingBadSSLCertificate | This protobuffer stores bad SSL certificate information for a canonical URL, and meant to be included in DocJoins and push to serving time. | TrawlerSSLCertificateInfo | |
| urlWithBadSslCertificate | The URL where the bad SSL certificate really comes from. Present iff it is different from the source URL, i.e. a redirect target of the source URL). | IndexingBadSSLCertificate | This protobuffer stores bad SSL certificate information for a canonical URL, and meant to be included in DocJoins and push to serving time. | String |
| annotationSource | IndexingConverterLocalizedAlternateName | String | ||
| deviceMatchInfo | Device match info calculated only by URL pattern. | IndexingConverterLocalizedAlternateName | String | |
| ecnFp | Fp96 of webmirror ECN as of the last time the canonical was processed. | IndexingConverterLocalizedAlternateName | String | |
| feedUrl | Populated if annotation_source is SITEMAP. | IndexingConverterLocalizedAlternateName | String | |
| language | IndexingConverterLocalizedAlternateName | String | ||
| parsedLanguage | Parsed language and region code from language field. | IndexingConverterLocalizedAlternateName | String | |
| parsedRegion | IndexingConverterLocalizedAlternateName | integer | ||
| url | IndexingConverterLocalizedAlternateName | String | ||
| urlEncoding | see webutil/urlencoding | IndexingConverterLocalizedAlternateName | integer | |
| rawFinalTargetFromRendering | Final redirect target found from rendering. It is the same as the last element of raw_redirect_chain_from_rendering. It is used as an input source for the indexable fragment detection pipeline and also downstream phases. | IndexingConverterRawRedirectInfo | The proto to be stored in raw_redirect_info column of document table. | String |
| rawFinalTargetFromTrawler | This is with-fragment version of redirect_with_contents. This field is populated only if there was a fragment. This field is used by indexing::mobile::GetRedirectTarget() defined in indexing/mobile/internal/smartphone-util.cc, which extracts the redirect target for smartphone optimized pages. The extracted target in turn is served in search results for smartphone users. We need with-fragment version because with-fragment url can return different content than fragment-stripped url. For example, http://www.example.com/m#article=11 and http://www.example.com/m can return different content. These cases are most typical for Ajaxy sites. This fragment does not have to be indexable. | IndexingConverterRawRedirectInfo | The proto to be stored in raw_redirect_info column of document table. | String |
| rawRedirectChainFromRendering | Redirect chain generated from redirect events in rendering. At the beginning of it, there could be some redirects from trawler (i.e. could be partial or entire trawler redirect chain), other redirects have their RedirectParams::is_redirect_from_rendering fields set to true. Redirects here have no RedirectChain::Hop::raw_target fields populated, and targets stored in RedirectChain::Hop::target fields are likely cleaned while keeping fragments (also sometimes they could be uncleaned ones because of cleaning failures), fragments could be indexable or non-indexable. | IndexingConverterRawRedirectInfo | The proto to be stored in raw_redirect_info column of document table. | IndexingConverterRedirectChain |
| renderingRedirectLimit | This is used to describe how many redirect hops from Webkit were kept in the raw_redirect_chain_from_rendering. If it is -1, it means it kept all the hops from Webkit in redirect chain. | IndexingConverterRawRedirectInfo | The proto to be stored in raw_redirect_info column of document table. | integer |
| hop | IndexingConverterRedirectChain | Redirect_chain is present for redirects, and absent for the final target. It contains the chain from the current hop’s target to the final target. | list(IndexingConverterRedirectChainHop) | |
| params | IndexingConverterRedirectChainHop | NOLINT | IndexingConverterRedirectParams | |
| rawTarget | Redirect target with fragment. This field is populated only if there was a fragment. | IndexingConverterRedirectChainHop | NOLINT | String |
| target | Redirect target URL and params of the current hop in the redirect chain. | IndexingConverterRedirectChainHop | NOLINT | String |
| delay | The time difference between page loading and redirect occurrence. When missing, it means the redirect happens immediately (i.e. delay = 0). In seconds. | IndexingConverterRedirectParams | If we detect any server or content based redirect, we will store the characteristics in this message. | integer |
| frameTargetDeniesFraming | Populated for SINGLE_FRAME and SINGLE_IFRAME redirects only and indicates that the target url requested not to be framed, by virtue of using the “X-Frame-Options” HTTP header. | IndexingConverterRedirectParams | If we detect any server or content based redirect, we will store the characteristics in this message. | boolean |
| isDownload | Indicates corresponding redirect is a download. This field is only set when rendering redirect chain is used. This field represents the value of corresponding “RedirectEvent.target_content_downloaded” field. | IndexingConverterRedirectParams | If we detect any server or content based redirect, we will store the characteristics in this message. | boolean |
| isRenderingRedirect | Indicates corresponding redirect is from rendering if set to true. | IndexingConverterRedirectParams | If we detect any server or content based redirect, we will store the characteristics in this message. | boolean |
| metaRedirectFromTrawler | If set, it means that the redirect of type META was detected by Trawler (as opposed to the content processor.) Only makes sense when type is META. | IndexingConverterRedirectParams | If we detect any server or content based redirect, we will store the characteristics in this message. | boolean |
| type | IndexingConverterRedirectParams | If we detect any server or content based redirect, we will store the characteristics in this message. | String | |
| range | IndexingConverterRichContentData | Contains information about 3 versions of the content of a document: 1. Original: the crawled content (possibly patched in ConversionFilters). 2. Processed: the final version of the content indexed in Web search. 3. Intermediate (no longer generated): intermediate version between the original and the processed content. All 3 versions of the content consist of HTTP headers (in unknown encoding) concatenated with the document body (in interchange valid UTF-8 encoding). | list(IndexingConverterRichContentDataRange) | |
| rangeType | IndexingConverterRichContentDataRange | Stores an ordered list of ranges of content from the original, processed, and intermediate content, such that: 1. The original content can be reconstructed from the ranges of type ORIGINAL_AND_PROCESSED, ORIGINAL_ONLY, and ORIGINAL_AND_INTERMEDIATE. 2. The processed content can be reconstructed from the ranges of type ORIGINAL_AND_PROCESSED and PROCESSED_ONLY. 3. The intermediate content (if present) can be reconstructed from the ranges of type ORIGINAL_AND_INTERMEDIATE and INTERMEDIATE_ONLY. | String | |
| size | Range size when uncompressed, in bytes. | IndexingConverterRichContentDataRange | Stores an ordered list of ranges of content from the original, processed, and intermediate content, such that: 1. The original content can be reconstructed from the ranges of type ORIGINAL_AND_PROCESSED, ORIGINAL_ONLY, and ORIGINAL_AND_INTERMEDIATE. 2. The processed content can be reconstructed from the ranges of type ORIGINAL_AND_PROCESSED and PROCESSED_ONLY. 3. The intermediate content (if present) can be reconstructed from the ranges of type ORIGINAL_AND_INTERMEDIATE and INTERMEDIATE_ONLY. | integer |
| sourceType | The source of this range of content. Present iff ‘type’ is PROCESSED_ONLY or INTERMEDIATE_ONLY. Note: ‘source_type’ is not present for ORIGINAL_AND_PROCESSED, ORIGINAL_ONLY, and ORIGINAL_AND_INTERMEDIATE because for those range types the source of their content is the original crawled content. | IndexingConverterRichContentDataRange | Stores an ordered list of ranges of content from the original, processed, and intermediate content, such that: 1. The original content can be reconstructed from the ranges of type ORIGINAL_AND_PROCESSED, ORIGINAL_ONLY, and ORIGINAL_AND_INTERMEDIATE. 2. The processed content can be reconstructed from the ranges of type ORIGINAL_AND_PROCESSED and PROCESSED_ONLY. 3. The intermediate content (if present) can be reconstructed from the ranges of type ORIGINAL_AND_INTERMEDIATE and INTERMEDIATE_ONLY. | String |
| sourceUrl | The source URL of this range of content. Present iff ‘source_type’ is present and ‘source_type’ is FRAME or FLASH or IFRAME. | IndexingConverterRichContentDataRange | Stores an ordered list of ranges of content from the original, processed, and intermediate content, such that: 1. The original content can be reconstructed from the ranges of type ORIGINAL_AND_PROCESSED, ORIGINAL_ONLY, and ORIGINAL_AND_INTERMEDIATE. 2. The processed content can be reconstructed from the ranges of type ORIGINAL_AND_PROCESSED and PROCESSED_ONLY. 3. The intermediate content (if present) can be reconstructed from the ranges of type ORIGINAL_AND_INTERMEDIATE and INTERMEDIATE_ONLY. | String |
| text | The content of the range, compressed with ‘text_compression_method’. Present iff ‘type’ is ORIGINAL_ONLY or ORIGINAL_AND_INTERMEDIATE or INTERMEDIATE_ONLY. Useful to reconstruct the original content or the intermediate content. Note: ‘text’ is not present for ORIGINAL_AND_PROCESSED and PROCESSED_ONLY because the processed content is already stored separately (in the contents column, and in CompositeDoc.doc.Content.Representation). | IndexingConverterRichContentDataRange | Stores an ordered list of ranges of content from the original, processed, and intermediate content, such that: 1. The original content can be reconstructed from the ranges of type ORIGINAL_AND_PROCESSED, ORIGINAL_ONLY, and ORIGINAL_AND_INTERMEDIATE. 2. The processed content can be reconstructed from the ranges of type ORIGINAL_AND_PROCESSED and PROCESSED_ONLY. 3. The intermediate content (if present) can be reconstructed from the ranges of type ORIGINAL_AND_INTERMEDIATE and INTERMEDIATE_ONLY. | String |
| textCompressionMethod | Method used to compress the ‘text’ field. May be present only when the ‘text’ is present. | IndexingConverterRichContentDataRange | Stores an ordered list of ranges of content from the original, processed, and intermediate content, such that: 1. The original content can be reconstructed from the ranges of type ORIGINAL_AND_PROCESSED, ORIGINAL_ONLY, and ORIGINAL_AND_INTERMEDIATE. 2. The processed content can be reconstructed from the ranges of type ORIGINAL_AND_PROCESSED and PROCESSED_ONLY. 3. The intermediate content (if present) can be reconstructed from the ranges of type ORIGINAL_AND_INTERMEDIATE and INTERMEDIATE_ONLY. | String |
| contentExpiry | time in unix time format after which this content should not be shown in the results. This in inferred from the X-Robots-Tag HTTP header with unavailable_after: Do not use this field directly. There is a column called content_expiration in Alexandria that includes this and other signals. | IndexingConverterRobotsInfo | Robots Info encapsulates all robots.txt or related information that we know about the Document collected from multiple sources such as HTTP headers, meta robots tags etc. | integer |
| convertToRobotedReason | IndexingConverterRobotsInfo | Robots Info encapsulates all robots.txt or related information that we know about the Document collected from multiple sources such as HTTP headers, meta robots tags etc. | String | |
| disallowedReason | IndexingConverterRobotsInfo | Robots Info encapsulates all robots.txt or related information that we know about the Document collected from multiple sources such as HTTP headers, meta robots tags etc. | integer | |
| indexifembeddedReason | IMPORTANT: if you add a new field here, update the MergeRobotsInfo() function to merge the new field. | IndexingConverterRobotsInfo | Robots Info encapsulates all robots.txt or related information that we know about the Document collected from multiple sources such as HTTP headers, meta robots tags etc. | integer |
| maxImagePreview | Max image preview restriction applied to this data. A value of THUMBNAIL_UNSPECIFIED can be treated as though there is no restriction. | IndexingConverterRobotsInfo | Robots Info encapsulates all robots.txt or related information that we know about the Document collected from multiple sources such as HTTP headers, meta robots tags etc. | String |
| maxSnippetLength | Max snippet preview restriction applied to this data. If this field is zero, it indicates that no snippet data can be displayed, therefore this field should be checked using has_max_snippet_length to determine if it was set. | IndexingConverterRobotsInfo | Robots Info encapsulates all robots.txt or related information that we know about the Document collected from multiple sources such as HTTP headers, meta robots tags etc. | String |
| noarchiveReason | IndexingConverterRobotsInfo | Robots Info encapsulates all robots.txt or related information that we know about the Document collected from multiple sources such as HTTP headers, meta robots tags etc. | integer | |
| nofollowReason | IndexingConverterRobotsInfo | Robots Info encapsulates all robots.txt or related information that we know about the Document collected from multiple sources such as HTTP headers, meta robots tags etc. | integer | |
| noimageframeoverlayReason | IndexingConverterRobotsInfo | Robots Info encapsulates all robots.txt or related information that we know about the Document collected from multiple sources such as HTTP headers, meta robots tags etc. | integer | |
| noimageindexReason | IndexingConverterRobotsInfo | Robots Info encapsulates all robots.txt or related information that we know about the Document collected from multiple sources such as HTTP headers, meta robots tags etc. | integer | |
| noindexReason | Bit map of RobotedReasons values. When set to a non-zero value, the document should not be indexed or archived etc. based on the name of the tag. | IndexingConverterRobotsInfo | Robots Info encapsulates all robots.txt or related information that we know about the Document collected from multiple sources such as HTTP headers, meta robots tags etc. | integer |
| nopreviewReason | IndexingConverterRobotsInfo | Robots Info encapsulates all robots.txt or related information that we know about the Document collected from multiple sources such as HTTP headers, meta robots tags etc. | integer | |
| nosnippetReason | IndexingConverterRobotsInfo | Robots Info encapsulates all robots.txt or related information that we know about the Document collected from multiple sources such as HTTP headers, meta robots tags etc. | integer | |
| notranslateReason | IndexingConverterRobotsInfo | Robots Info encapsulates all robots.txt or related information that we know about the Document collected from multiple sources such as HTTP headers, meta robots tags etc. | integer | |
| metadata | IndexingConverterShingleFingerprint | Used for storing fingerprints, along with meta-data that expresses how the fingerprint was computed. The metadata can be anything that fits in an uint64. | String | |
| value | Repeated to allow for fingerprints larger than 64-bits. | IndexingConverterShingleFingerprint | Used for storing fingerprints, along with meta-data that expresses how the fingerprint was computed. The metadata can be anything that fits in an uint64. | list(String) |
| doubleIndexingExperimentId | Only for double indexing experiments. This field is set for duplicated documents so that docjoin users will not see duplicated docs. | IndexingCrawlerIdServingDocumentIdentifier | String | |
| dupExperimentId | Only for Experimental clusters, not relevant for production serving data: Index-Dups can run experiments in Quality Clusters where different versions of the same document (e.g. with different signals) are serving in parallel. They are uniquely identified by the dup-experiment-IDs. This is for experimental clusters only. In prod-versions the member will not be set. | IndexingCrawlerIdServingDocumentIdentifier | String | |
| key | The primary identifier of a production document is the document key, which is the same as the row-key in Alexandria, and represents a URL and its crawling context. The document key is the unique identifier for each document, but multiple document keys can cover the same URL (e.g. crawled with different device types). In your production code, please always assume that the document key is the only way to uniquely identify a document. Link for more background information: http://go/url The document key is populated for all docs in indexing since 2014-03. ## Recommended way of reading: const string& doc_key = cdoc.doc().id().key(); ## CHECK(!doc_key.empty()); Note: For older DocJoins (e.g. historical DocJoins), the field is not populated. In those scenarios it is recommended to use the function ‘GetDocumentKeyFromCompositeDoc’ in ‘//indexing/crawler_id/utils/compositedoc/compositedoc_util.h’ instead. | IndexingCrawlerIdServingDocumentIdentifier | String | |
| phraseAnchorSpamCount | How many spam phrases found in the anchors among unique domains. | IndexingDocjoinerAnchorPhraseSpamInfo | Following signals identify spike of spammy anchor phrases. Anchors created during the spike are tagged with LINK_SPAM_PHRASE_SPIKE. | number |
| phraseAnchorSpamDays | Over how many days 80% of these phrases were discovered. | IndexingDocjoinerAnchorPhraseSpamInfo | Following signals identify spike of spammy anchor phrases. Anchors created during the spike are tagged with LINK_SPAM_PHRASE_SPIKE. | number |
| phraseAnchorSpamDemoted | Total number of demoted anchors. | IndexingDocjoinerAnchorPhraseSpamInfo | Following signals identify spike of spammy anchor phrases. Anchors created during the spike are tagged with LINK_SPAM_PHRASE_SPIKE. | integer |
| phraseAnchorSpamEnd | Time when anchor spam spike ended with padding. | IndexingDocjoinerAnchorPhraseSpamInfo | Following signals identify spike of spammy anchor phrases. Anchors created during the spike are tagged with LINK_SPAM_PHRASE_SPIKE. | integer |
| phraseAnchorSpamFraq | Spam phrases fraction of all anchors of the document. | IndexingDocjoinerAnchorPhraseSpamInfo | Following signals identify spike of spammy anchor phrases. Anchors created during the spike are tagged with LINK_SPAM_PHRASE_SPIKE. | number |
| phraseAnchorSpamPenalty | Combined penalty for anchor demotion. | IndexingDocjoinerAnchorPhraseSpamInfo | Following signals identify spike of spammy anchor phrases. Anchors created during the spike are tagged with LINK_SPAM_PHRASE_SPIKE. | number |
| phraseAnchorSpamProcessed | Total number of observed anchors. | IndexingDocjoinerAnchorPhraseSpamInfo | Following signals identify spike of spammy anchor phrases. Anchors created during the spike are tagged with LINK_SPAM_PHRASE_SPIKE. | integer |
| phraseAnchorSpamRate | Average daily rate of spam anchor discovery. | IndexingDocjoinerAnchorPhraseSpamInfo | Following signals identify spike of spammy anchor phrases. Anchors created during the spike are tagged with LINK_SPAM_PHRASE_SPIKE. | number |
| phraseAnchorSpamStart | Time when anchor spam spike started with padding. | IndexingDocjoinerAnchorPhraseSpamInfo | Following signals identify spike of spammy anchor phrases. Anchors created during the spike are tagged with LINK_SPAM_PHRASE_SPIKE. | integer |
| anchorEnd | End date of the last anchor of the document. | IndexingDocjoinerAnchorSpamInfo | Following structure summarizes output of AnchorSpamPenalizer. Spammy anchors are tagged with LINK_SPAM_PHRASE_PENALIZER and demoted to SPAM locality in anchor-localizer.cc | integer |
| anchorFraq | Ratio of spam demoted period to all anchor period. | IndexingDocjoinerAnchorSpamInfo | Following structure summarizes output of AnchorSpamPenalizer. Spammy anchors are tagged with LINK_SPAM_PHRASE_PENALIZER and demoted to SPAM locality in anchor-localizer.cc | number |
| anchorStart | Start date of the first anchor of the document. | IndexingDocjoinerAnchorSpamInfo | Following structure summarizes output of AnchorSpamPenalizer. Spammy anchors are tagged with LINK_SPAM_PHRASE_PENALIZER and demoted to SPAM locality in anchor-localizer.cc | integer |
| demoted | Following field record details of anchor demotion in action. How many anchors were demoted. | IndexingDocjoinerAnchorSpamInfo | Following structure summarizes output of AnchorSpamPenalizer. Spammy anchors are tagged with LINK_SPAM_PHRASE_PENALIZER and demoted to SPAM locality in anchor-localizer.cc | integer |
| demotedAll | Demoted all anchors in the period or only anchors classified as spam. | IndexingDocjoinerAnchorSpamInfo | Following structure summarizes output of AnchorSpamPenalizer. Spammy anchors are tagged with LINK_SPAM_PHRASE_PENALIZER and demoted to SPAM locality in anchor-localizer.cc | boolean |
| demotedEnd | End date of the demotion period. | IndexingDocjoinerAnchorSpamInfo | Following structure summarizes output of AnchorSpamPenalizer. Spammy anchors are tagged with LINK_SPAM_PHRASE_PENALIZER and demoted to SPAM locality in anchor-localizer.cc | integer |
| demotedStart | Start date of the demotion period. | IndexingDocjoinerAnchorSpamInfo | Following structure summarizes output of AnchorSpamPenalizer. Spammy anchors are tagged with LINK_SPAM_PHRASE_PENALIZER and demoted to SPAM locality in anchor-localizer.cc | integer |
| phraseCount | Following fields record signals used in anchor spam classification. How many spam phrases found in the anchors among unique domains. | IndexingDocjoinerAnchorSpamInfo | Following structure summarizes output of AnchorSpamPenalizer. Spammy anchors are tagged with LINK_SPAM_PHRASE_PENALIZER and demoted to SPAM locality in anchor-localizer.cc | number |
| phraseDays | Over how many days 80% of these phrases were discovered. | IndexingDocjoinerAnchorSpamInfo | Following structure summarizes output of AnchorSpamPenalizer. Spammy anchors are tagged with LINK_SPAM_PHRASE_PENALIZER and demoted to SPAM locality in anchor-localizer.cc | number |
| phraseFraq | Spam phrases fraction of all anchors of the document. | IndexingDocjoinerAnchorSpamInfo | Following structure summarizes output of AnchorSpamPenalizer. Spammy anchors are tagged with LINK_SPAM_PHRASE_PENALIZER and demoted to SPAM locality in anchor-localizer.cc | number |
| phraseRate | Average daily rate of spam anchor discovery. | IndexingDocjoinerAnchorSpamInfo | Following structure summarizes output of AnchorSpamPenalizer. Spammy anchors are tagged with LINK_SPAM_PHRASE_PENALIZER and demoted to SPAM locality in anchor-localizer.cc | number |
| processed | Total number of processed anchors. | IndexingDocjoinerAnchorSpamInfo | Following structure summarizes output of AnchorSpamPenalizer. Spammy anchors are tagged with LINK_SPAM_PHRASE_PENALIZER and demoted to SPAM locality in anchor-localizer.cc | integer |
| sampled | True if anchors were sampled during observation phrase. | IndexingDocjoinerAnchorSpamInfo | Following structure summarizes output of AnchorSpamPenalizer. Spammy anchors are tagged with LINK_SPAM_PHRASE_PENALIZER and demoted to SPAM locality in anchor-localizer.cc | boolean |
| sources | Detailed information about trusted sources and match computation. Populated only when –anchorspam_penalizer_debug=true. | IndexingDocjoinerAnchorSpamInfo | Following structure summarizes output of AnchorSpamPenalizer. Spammy anchors are tagged with LINK_SPAM_PHRASE_PENALIZER and demoted to SPAM locality in anchor-localizer.cc | list(IndexingDocjoinerAnchorTrustedInfo) |
| spamDebugInfo | Additional debug information about computation of spam probability. | IndexingDocjoinerAnchorSpamInfo | Following structure summarizes output of AnchorSpamPenalizer. Spammy anchors are tagged with LINK_SPAM_PHRASE_PENALIZER and demoted to SPAM locality in anchor-localizer.cc | String |
| spamPenalty | Combined penalty for anchor demotion. | IndexingDocjoinerAnchorSpamInfo | Following structure summarizes output of AnchorSpamPenalizer. Spammy anchors are tagged with LINK_SPAM_PHRASE_PENALIZER and demoted to SPAM locality in anchor-localizer.cc | number |
| spamProbability | Predicted probability of spam. | IndexingDocjoinerAnchorSpamInfo | Following structure summarizes output of AnchorSpamPenalizer. Spammy anchors are tagged with LINK_SPAM_PHRASE_PENALIZER and demoted to SPAM locality in anchor-localizer.cc | number |
| trustedDemoted | Number of trusted anchors used in computation of spam probability. | IndexingDocjoinerAnchorSpamInfo | Following structure summarizes output of AnchorSpamPenalizer. Spammy anchors are tagged with LINK_SPAM_PHRASE_PENALIZER and demoted to SPAM locality in anchor-localizer.cc | integer |
| trustedExamples | Examples of trusted sources. | IndexingDocjoinerAnchorSpamInfo | Following structure summarizes output of AnchorSpamPenalizer. Spammy anchors are tagged with LINK_SPAM_PHRASE_PENALIZER and demoted to SPAM locality in anchor-localizer.cc | String |
| trustedMatching | Number of trusted anchors with anchor text matching spam terms. | IndexingDocjoinerAnchorSpamInfo | Following structure summarizes output of AnchorSpamPenalizer. Spammy anchors are tagged with LINK_SPAM_PHRASE_PENALIZER and demoted to SPAM locality in anchor-localizer.cc | integer |
| trustedTarget | Following fields record details about trusted anchors True if is this URL is on trusted source. | IndexingDocjoinerAnchorSpamInfo | Following structure summarizes output of AnchorSpamPenalizer. Spammy anchors are tagged with LINK_SPAM_PHRASE_PENALIZER and demoted to SPAM locality in anchor-localizer.cc | boolean |
| trustedTotal | Total number of trusted sources for this URL. | IndexingDocjoinerAnchorSpamInfo | Following structure summarizes output of AnchorSpamPenalizer. Spammy anchors are tagged with LINK_SPAM_PHRASE_PENALIZER and demoted to SPAM locality in anchor-localizer.cc | integer |
| penguinLastUpdate | BEGIN: Penguin related fields. Timestamp when penguin scores were last updated. Measured in days since Jan. 1st 1995. | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer |
| anchorCount | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer | |
| badbacklinksPenalized | Whether this doc is penalized by BadBackLinks, in which case we should not use improvanchor score in mustang ascorer. | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | boolean |
| penguinPenalty | Page-level penguin penalty (0 = good, 1 = bad). | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | number |
| minHostHomePageLocalOutdegree | Minimum local outdegree of all anchor sources that are host home pages as well as on the same host as the current target URL. | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer |
| droppedRedundantAnchorCount | Sum of anchors_dropped in the repeated group RedundantAnchorInfo, but can go higher if the latter reaches the cap of kMaxRecordsToKeep. (indexing/docjoiner/anchors/anchor-loader.cc), currently 10,000 | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer |
| nonLocalAnchorCount | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer | |
| mediumCorpusAnchorCount | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer | |
| penguinEarlyAnchorProtected | Doc is protected by goodness of early anchors. | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | boolean |
| droppedHomepageAnchorCount | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer | |
| redundantanchorinfoforphrasecap | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | list(IndexingDocjoinerAnchorStatisticsRedundantAnchorInfoForPhraseCap) | |
| forwardedOffdomainAnchorCount | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer | |
| droppedNonLocalAnchorCount | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer | |
| perdupstats | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | list(IndexingDocjoinerAnchorStatisticsPerDupStats) | |
| onsiteAnchorCount | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer | |
| droppedLocalAnchorCount | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer | |
| penguinTooManySources | Doc not scored because it has too many anchor sources. END: Penguin related fields. | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | boolean |
| forwardedAnchorCount | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer | |
| anchorSpamInfo | This structure contains signals and penalties of AnchorSpamPenalizer. It replaces phrase_anchor_spam_info above, that is deprecated. | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | IndexingDocjoinerAnchorSpamInfo |
| lowCorpusAnchorCount | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer | |
| lowCorpusOffdomainAnchorCount | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer | |
| baseAnchorCount | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer | |
| minDomainHomePageLocalOutdegree | Minimum local outdegree of all anchor sources that are domain home pages as well as on the same domain as the current target URL. | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer |
| skippedAccumulate | A count of the number of times anchor accumulation has been skipped for this document. Note: Only used when canonical. | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer |
| topPrOnsiteAnchorCount | According to anchor quality bucket, anchor with pagrank > 51000 is the best anchor. anchors with pagerank < 47000 are all same. | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer |
| pageMismatchTaggedAnchors | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer | |
| spamLog10Odds | The log base 10 odds that this set of anchors exhibits spammy behavior. Computed in the AnchorLocalizer. | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | number |
| redundantanchorinfo | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | list(IndexingDocjoinerAnchorStatisticsRedundantAnchorInfo) | |
| pageFromExpiredTaggedAnchors | Set in SignalPenalizer::FillInAnchorStatistics. | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer |
| baseOffdomainAnchorCount | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer | |
| phraseAnchorSpamInfo | Following signals identify spike of spammy anchor phrases. Anchors created during the spike are tagged with LINK_SPAM_PHRASE_SPIKE. | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | IndexingDocjoinerAnchorPhraseSpamInfo |
| anchorPhraseCount | The number of unique anchor phrases. Capped by the constant kMaxAnchorPhraseCountInStats (=5000) defined in indexing/docjoiner/anchors/anchor-manager.cc. | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer |
| ondomainAnchorCount | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer | |
| totalDomainsAbovePhraseCap | Number of domains above per domain phrase cap. We see too many phrases in the domains. | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer |
| totalDomainsSeen | Number of domains seen in total. | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer |
| topPrOffdomainAnchorCount | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer | |
| scannedAnchorCount | The total number of anchors being scanned from storage. | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer |
| localAnchorCount | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer | |
| linkBeforeSitechangeTaggedAnchors | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer | |
| globalAnchorDelta | Metric of number of changed global anchors computed as, size(union(previous, new) – intersection(previous, new)). | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer |
| topPrOndomainAnchorCount | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer | |
| mediumCorpusOffdomainAnchorCount | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer | |
| offdomainAnchorCount | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer | |
| totalDomainPhrasePairsSeenApprox | Number of domain/phrase pairs in total — i.e. how many anchors we would have if the domain/phrase cutoff was set to 1 instead of 200. This is “approx” for large anchor clusters because there can be double counting when the LRU cache forgets about rare domain/phrase pairs. | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer |
| skippedOrReusedReason | Reason to skip accumulate, when skipped, or Reason for reprocessing when not skipped. | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | String |
| anchorsWithDedupedImprovanchors | The number of anchors for which some ImprovAnchors phrases have been removed due to duplication within source org. | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer |
| fakeAnchorCount | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer | |
| redundantAnchorForPhraseCapCount | Total anchor dropped due to exceed per domain phrase cap. Equals to sum of anchors_dropped in the repeated group RedundantAnchorInfoForPhraseCap, but can go higher if the latter reaches the cap of kMaxDomainsToKeepForPhraseCap (indexing/docjoiner/anchors/anchor-loader.h), currently 1000. | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer |
| totalDomainPhrasePairsAboveLimit | The following should be equal to the size of the following repeated group, except that it can go higher than 10,000. | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer |
| timestamp | Walltime of when anchors were accumulated last. | IndexingDocjoinerAnchorStatistics | Statistics of the anchors in a docjoin. Next available tag ID: 63. | integer |
| anchorCount | Count of anchors kept from forwarding. | IndexingDocjoinerAnchorStatisticsPerDupStats | ————————————————————————- The total number of anchors collected per dupforwarding (including the canonical itself). Includes additional data about redundant and offdomain counts and the last timestamp it was collected from. | integer |
| collectType | This is EcnCollectType in anchor-ecn-matcher.h for the latest ECN of this dup: – kCollectNormal = 0, // Normal collection. – kCollectUnforwarded = 1, // Forwarding leader docid match only. – kCollectWhitelisted = 2, // Collected anchors matching whitelist. – kCollectNone = 4 // Skipped ECN anchor cluster. | IndexingDocjoinerAnchorStatisticsPerDupStats | ————————————————————————- The total number of anchors collected per dupforwarding (including the canonical itself). Includes additional data about redundant and offdomain counts and the last timestamp it was collected from. | integer |
| dupUrl | If missing, the same as the canonical. | IndexingDocjoinerAnchorStatisticsPerDupStats | ————————————————————————- The total number of anchors collected per dupforwarding (including the canonical itself). Includes additional data about redundant and offdomain counts and the last timestamp it was collected from. | String |
| offdomainAnchorCount | Count of offdomain anchors. | IndexingDocjoinerAnchorStatisticsPerDupStats | ————————————————————————- The total number of anchors collected per dupforwarding (including the canonical itself). Includes additional data about redundant and offdomain counts and the last timestamp it was collected from. | integer |
| redundantAnchorCount | Count of redundant anchors. | IndexingDocjoinerAnchorStatisticsPerDupStats | ————————————————————————- The total number of anchors collected per dupforwarding (including the canonical itself). Includes additional data about redundant and offdomain counts and the last timestamp it was collected from. | integer |
| scannedAnchorCount | The number of anchors being scanned from storage per dupforwarding. | IndexingDocjoinerAnchorStatisticsPerDupStats | ————————————————————————- The total number of anchors collected per dupforwarding (including the canonical itself). Includes additional data about redundant and offdomain counts and the last timestamp it was collected from. | integer |
| timestamp | Walltime when this was scanned last. | IndexingDocjoinerAnchorStatisticsPerDupStats | ————————————————————————- The total number of anchors collected per dupforwarding (including the canonical itself). Includes additional data about redundant and offdomain counts and the last timestamp it was collected from. | integer |
| anchorsDropped | IndexingDocjoinerAnchorStatisticsRedundantAnchorInfo | ————————————————————————- The total number of redundant anchors dropped per (domain, text). If we receive a large number of anchors from a particular domain, then we’ll throw out all but 200 of them from that domain. The data is sorted by the (domain, text) pairs. This is capped at 10,000 entries (if less, it will have the same number of elements as the above_limit count). | String | |
| domain | IndexingDocjoinerAnchorStatisticsRedundantAnchorInfo | ————————————————————————- The total number of redundant anchors dropped per (domain, text). If we receive a large number of anchors from a particular domain, then we’ll throw out all but 200 of them from that domain. The data is sorted by the (domain, text) pairs. This is capped at 10,000 entries (if less, it will have the same number of elements as the above_limit count). | String | |
| text | IndexingDocjoinerAnchorStatisticsRedundantAnchorInfo | ————————————————————————- The total number of redundant anchors dropped per (domain, text). If we receive a large number of anchors from a particular domain, then we’ll throw out all but 200 of them from that domain. The data is sorted by the (domain, text) pairs. This is capped at 10,000 entries (if less, it will have the same number of elements as the above_limit count). | String | |
| anchorsDropped | IndexingDocjoinerAnchorStatisticsRedundantAnchorInfoForPhraseCap | integer | ||
| domain | IndexingDocjoinerAnchorStatisticsRedundantAnchorInfoForPhraseCap | String | ||
| matchedScore | Difference in KL-divergence from spam and non-spam anchors. Value >0 indicate that anchor text from this trusted source is similar to anchors classified as spam which means that spammy anchors are legitimate. | IndexingDocjoinerAnchorTrustedInfo | This message summarized anchors of one trusted site. | number |
| matchedScoreInfo | Detailed debug information about computation of trusted anchors match. Populated only when –anchorspam_penalizer_debug=true | IndexingDocjoinerAnchorTrustedInfo | This message summarized anchors of one trusted site. | list(String) |
| phrasesScore | Count of anchors classified as spam using anchor text. | IndexingDocjoinerAnchorTrustedInfo | This message summarized anchors of one trusted site. | number |
| site | Site name from anchor.source().site(). | IndexingDocjoinerAnchorTrustedInfo | This message summarized anchors of one trusted site. | String |
| text | Tokenized text of all anchors from the site. | IndexingDocjoinerAnchorTrustedInfo | This message summarized anchors of one trusted site. | list(String) |
| trustedScore | Fraction of pages with newsy anchors on the site, >0 for trusted sites. | IndexingDocjoinerAnchorTrustedInfo | This message summarized anchors of one trusted site. | number |
| extraMessage | IndexingDocjoinerCDocBuildInfo | Holds extra info except annotations and raw cdoc for buildint the final cdoc. | Proto2BridgeMessageSet | |
| timeAnnotationTags | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| photosGeoAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryAnnotationsSnippetSegmentSnippetSegmentAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanRightsOptOutRequest | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityAuthorshipAuthorAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| newsCorpusPositionRankAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| babelEncoderBabelEncodings | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| sitemapsSitemapsSignals | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWikipediaSentenceCompressionAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingConverterFileMetaInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsDocImportance | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualitySosGoldmineSosAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityNavboostCrapsCrapsData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityAnchorsOutdegreeOutdegreeInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| knowledgeMiningFactsProductCompositionSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| udrConverterProductBlockData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityTangramInformationTypes | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| videoCrawlVideoScoringSignals | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityPanopticStorytimeScoringSignals | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| foundationSplinterSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityResultFilteringIndexingClusterAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| analyticsSiteidAnalyticsPropertyAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| localyp | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualitySalientStuffSalientStuffSet | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanReviewsForWork | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingMobileSpeedPageSpeedFieldData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| nlpAtcClaraAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| udrConverterDocumentShoppingData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryAnnotationsSporeSporeEtlInputAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| nlxDocAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityRealtimeBoostSeismographEventAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| imageMustangFaviconInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| i2eV2ImageEntitiesInfos | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWikipediaWikiJoin | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| knowledgeMiningFactsServingData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingSelectionDoubleIndexingExtension | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingPlusoneSocialScoreSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityFreshnessAbacusInstantNegativeClicksInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| knowledgeMumStorytimeStampEngagementAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| newsCorpusNewsinessAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| knowledgeMiningFactsUniversalTableSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingInstantClusterScorerSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| spamCookbookCookbookSitechunkAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| scienceIndexSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanMetadataPhysicalMeasurementsComponent | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| modernFormatContent | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityPagemasterPagemasterAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryAnnotationsSporeSporeEtlAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| websitetoolsFeedsLinkedFeedLinkedFeed | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| imageQualityRichdataProtoImageAnchor | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| spamHackedSitesGpgbGpgbNgramStats | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingSelectionFreshdocsPassthroughExtension | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsTwitterEmbeddedTweetsAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| volt | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryProtiumEncyclojoinsEncycloJoin | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| spamContentAnchorDist | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryAnnotationsSporeDeeplinkAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityQ2QualityBoost | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityNegativeClicksNegativeClicksInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| priceAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityImprovImprovAnchors | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| videoCrawlVideoClickData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| knowledgeMiningFactsUdrExtraFactData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| imageRepositoryPicasaGeoData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| websitetoolsFeedsAnnotationsFeedContentAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsPcuSignedExchangeInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| adsAdsaiMagicApfelApfelRegionFinderAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityPanopticIndexingDiscoverCorpusAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| imageQualityRichdataProtoRichdata | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| acceleratedShoppingSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| smearingSmearedTerms | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualitySimilarpagesRelatedInfoSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| newsCorpusNewsCorpusAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingUrlPatternUrlTreeUrlPatternAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanMetadataLanguageInfoComponent | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAppsAffiliatedInstantAppInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityWebanswersTranscriptAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| commerceDataqualityOrganicCrawledSellerData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityWebanswersAltTitleSaftDoc | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanMetadataClusteringTomeHorizontalLinkDescriptor | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| firstseen | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| fatcatSiteVerticalsAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingRaffiaMediaProcessingMetadata | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| richsnippetsFeedPageMap | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityNsrSiteAuthority | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| amphtmlSignedExchangeValidationPayload | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityPopfeedsUrlSourceAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| imageContentColorSearchColorDetectionResults | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| spamJsJsInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingSignalsImpressionsPerDayContainer | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingUgcPageParamInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityPanopticIndexingPanopticAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| rankBoostDocAttachment | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanMetadataSeriesInfoComponent | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingDocskeletonRepeatedPatternRepeatedPatternAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| udrProtoDetailedEntityScores | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryAnnotationsAmenitiesAmenitiesAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| numberAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanMetadataClusterHorizontalReference | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanMetadataClusterRecord | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| officialPagesQuerySet | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| datacommonsDatacommonsTriplesSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingThirdpartyThirdPartyInputs | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualitySearchoversiteAnnotatorStructuredResultsAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingDocjoinerServingTimeClusterIds | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| freshboxFreshboxArticleAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| knowledgeMiningFactsFactEvaluationSignals | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| universalFacts | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingSpeechSpeechPagePropertiesProto | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingSelectionPriorScorerParameterSet | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| spamGooglebombsGooglebombsAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingCenterpieceCenterPieceAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingMlVerticalVerticalClassificationResult | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWebrefExperimentalWebrefEntitiesAttachment | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| imageDataList | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| verticalsDiscussionDiscussionAnnotationTag | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWebrefReconcileResponse | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| spamContentAuthenticAuthenticTextAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityLisztomaniaDocument | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingConverterLinkRelOutlinks | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingMobileClientDependentInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityRichsnippetsAppsProtosApplicationInformationAttachment | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| newsNarRow | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityDniPcuAuxiliaryData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityTwiddlerDomainClassification | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| imageExtraImageExtraTerms | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| creator | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityNsrNsrData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityPricedetectorKefirPriceAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| lensVsaiDatasets | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingMetricsUrlIndexingProps | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| ucpSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| knowledgeMiningFactsHtmlTableSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| crawzallSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| imageSearchRejectedImageInfoList | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| searchEngagementHighlightSharedHighlightSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingCenterpieceSectionTitleAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| discussion | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| adsAdsaiMagicMagicPageTypeAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| udrConverterOffer | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| telephoneNumberAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanMetadataContributorLinks | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| navboost | BEGIN DATA FIELDS | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo |
| knowledgeMiningFactsUdrExtraFactMentionData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingInstantHistoricalContentSignals | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| geostoreAddressProto | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| knowledgeMumStoryTeaserAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| authenticSiteRankData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingInstantBaseReindexWhitelistData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsAppsDocRestrictionsDocPreviewRestrictionsAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanMetadataParsedAccessTerms | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryAnnotationsMicroformatsHproduct | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWikipediaAnnotatorWikipediaPageComponentAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingCenterpieceComponentLearningSource | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWebrefEntityJoin | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualitySummarySummary | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| videoScoringSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| documentIntent | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| spamScamScamness | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualitySnippetsHiddenTextHiddenSpanAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| newsNarRowContainer | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| newsExtractionNewsPbeAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWikipediaAliasList | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| mapsSyntheticsGeoDocFetchKey | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsTypedNumberTypedNumberAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| knowledgeMiningShoppingBrowseonomyData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWikipediaWikiMapperTripleSet | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityNsrPairwiseqPairwiseQData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| videoCrawlAutomatedAudioExtractionSignals | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| spamBrainSpamBrainPageClassifierAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityAuthorityTopicEmbeddings | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| videoCrawlDomainVideoClickData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| unwantedImageDataList | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| spamTokensSpamTokensAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWebrefSalientEntitySet | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| knowledgeMiningFactsStructuredSnippetsSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| fatcatCompactDocClassification | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsDatesDateTimes | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingSignalsAccumulatedOnlineSignals | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingSpeechGoldminePodcastAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryAnnotationsSporeExtractorTopicAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWikipediaWikidataOrgTripleSet | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingUnionKeyData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingSelectionImageImageSelectionAttachment | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsDatasetModelAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingSelectionFastServingPush | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityShoppingProductReviewPage | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| spamScamUnauthoritativeSite | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| knowledgeMiningFactsObjectAnnotationsSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| knowledgeMiningFactsWebKvSiteGroupSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityPanopticIndexingDiscoverDocumentSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWebrefPiannoTvSeasonEpisode | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| newsCorpusHubPageAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsCommentBlockGroups | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingMlShoppingUniverseAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| knowledgeMiningFactsUniversalFactScores | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsWaPassagesQueryToPassageAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsCanonicalUrl | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| nlpSentimentSentimentAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWebrefWebitIntermediaryMids | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityTitlesSitelinksTargetTitleInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| localsearchAuthoritySiteAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingPlusonePlusOneSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryAnnotationsSporeAuthoritySignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsPcuAmpError | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityPeoplesearchNamedetectorNameOccurrenceAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingRaffiaDataRecoveryInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWikipediaWikibaseEntity | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingBadpagesLoginPageResult | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| safesearchPageClassifierOutput | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| tableTalkStrideOfferPagePriceAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanMetadataAvailabilitySnapshotHolder | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWebrefGraphMention | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityRodinRodinSiteSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| badurlsBadurlsForceSelectionSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| knowledgeTpfHowtodoHowtoVideoAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| spamBrainSpamBrainData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanMetadataKgTopicLinks | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| researchStructuredDataInadvertentAnchorScoreAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryAnnotationsCrawzallAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityPopfeedsChromeBackgroundAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| newsCorpusNewsCorpusStatusAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryAnnotationsMicroformatsMicroformatAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryAnnotationsSporeExtractorTripleAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| spamGodclusterAffIdAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityBreadcrumbsBreadcrumbAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| infoextractionPinpointPinpointSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsPersonPersonAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingMlDomNodeSegments | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingCenterpieceCenterpieceChecksums | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityVisualwebVisualWebModelsAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingSignalAggregatorUrlPatternSignals | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| contraCuratedContent | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| spamGodclusterServerHeaderAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanMetadataParsedSuDoc | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsIBertEmbeddingAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryAnnotationsListFilterAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| contraContentReviewAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWebrefWebrefStatus | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingBadpagesIndexSelectionRemoval | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| newsAnnotationsContentAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingConverterMetaDetectorsResultsProto | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityRealtimeRtFactAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| videoCrawlVideoSalientTermSet | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| imageembed | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityNavboostCrapsCrapsPatternSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| searcharSearchArPipelineSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| newsCorpusNewsAggregateSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| imageContentAnnotationLabels | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| dateAnnotationTags | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsAppMarketAppMarketAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityCalypsoAppsLink | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingMlVerticalVerticalClassificationV2 | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| imageQualityLayoutDocument | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| knowledgeMiningFactsUniversalFactMetadata | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| instantChromeViews | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| dotsNewsstandSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| udrProtoWebrefMention | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingSocialCountsSocialWidgetsIndicator | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWebrefRefconJugglerReferencePageMappings | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityNsrNsrSitechunksAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityAnimaRoutinesRoutinesPropertiesProto | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingMlSemanticArticle | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanMetadataBibkeyComponent | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryProtiumWikiaWikiaInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| orbitIntents | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| researchStructuredDataKnowledgeExplorationAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityFringeFringeQueryPrior | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityRealtimeRealtimeResultInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsCollectionsDocCollections | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| videoCrawlYoutubeEmbedSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAppsMergedAppInfoAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityVisualwebVisualWebAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| richsnippetsSchemaThing | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityDniPcuRawData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWikipediaWikitrustWikiTrustInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| countryCountryAttachment | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingDocjoinerWikiInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| udrProtoOverlay | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| timeAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanLibrarianPopulatorData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityNsrUvSitechunksAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| knowledgeMumStorytimeStampQualityAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityPanopticVoiceUgcAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingConverterPdfFileMetaInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| extractedBookInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityRealtimeBoostRealtimeBoostResponse | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityViewsAnswersAnswerAnnotationInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityHorizonRecordInfoAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualitySitemapThirdPartyCarouselsItemLists | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryAnnotationsWebanswersContextItemAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| spamFatpingIndexFeed | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityCopiaFireflySiteInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityHistoricalContentAge | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingWebChannelsWebChannelAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| commerceDataqualityOrganicShoppingAnnotationSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| travelAssistantTravelDocClassification | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingBeringPublisherOnPageAdsAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsImageRepositoryImageLicenseInfoAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| imageQualitySalientTermsImageQuerySmearingList | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWebrefJuggernautIndices | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanMetadataItemSpecificBibdataComponent | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| dateAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| commonsenseStoneSoupProtoRaffiaInstructionsSeq | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| emailAddressAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanLibrarianBookMetadata | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| imageQualitySensitiveMediaOrPeopleEntities | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualitySitemapDocument | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| websitetoolsFeedsPodcastPodcastSignals | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityWebfeederDocEmbedding | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| noindexedImageDataList | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| imageQualitySensitiveFaceSkinToneSignals | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualitySalientCountriesSalientCountrySet | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| imageMustangWebsearchImageSnippetResponse | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| imageQualityLandingPageProtoLandingPageSalientTextSet | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityPricedetectorProductBlockAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| newsNarIndexingMetadata | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsWaPassagesTrimmedQueryToPassageAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityGeoBrainlocGoldmineBrainlocAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| personalizationGameWebeventsEvents | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWebrefPiannoDocumentIntents | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanMetadataAvailabilityInfoComponent | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityDniNewsstandPcu | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryProtiumGoldmineTriplificationResult | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| imageQualitySalientTermsImageSalientTermSetMap | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsFeedbackSet | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWebrefPageClassificationSignalsSet | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingMlEntityInfoboxes | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanMetadataClusterVolumes | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| imageQualityLabelmakerDocMediaLabels | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| amphtmlSignedExchangeErrorDetails | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| safesearchSafeSearchInternalPageSignals | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingMobileInterstitialsProtoDesktopInterstitials | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsDocRestrictionsInDocRestrictionsAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanMetadataRightsComponent | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| personalizationGameWebeventsEvent | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| spamCookbookCookbookAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingImagesRelatedImageSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| imageembedDomainNorm | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualitySalientTermsQuerySmearingModel | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityAnimaLivewebLivewebAttachment | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryAnnotationsDiscussionThreadDiscussionViewProto | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| knowledgeMiningFactsKatsSignals | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWebrefWebitScopeSignals | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| newsNewsClassifications | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsCleanTextProto | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityNsrPqData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| researchCoauthorOpinionAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| spamHackedSitesDocSpamInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanMetadataAllItemSpecificBibdatas | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingDupsLocalizedLocalizedCluster | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingInstantNewsImagesInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingConverterPdfPageAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryProtiumGoldmineTypeAssertionOutput | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryProtiumWebkvWebKv | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWebrefWebitTripleSignals | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| chromeCounts | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| shoppingQualityShoppingSiteClassifierShopfab | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| discoverSource | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| boilerplateAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| instantNavboost | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsAnnotationMeta | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| dotsGaramondSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| measurementAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| youtubeAlexandriaYoutubeBody | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| shoppingQualityShoppingSiteClassifier | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryAnnotationsRodinArticleAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| spamHackedSitesWordFrequencies | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| imageStockStockImageAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingBadpagesBadPageParseResult | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityNsrDokiAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryAnnotationsStorehoursStoreHoursAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingConverterContentParserResults | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| socialPersonalizationKnexAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| newsNewsArticleChecksum | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityImprovDocToQueries | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityPopfeedsHubDataAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityExploreQueryableFeedHashtagListAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingSelectionTensorFlowExtension | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| imageRepositoryGeolocation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| imageMonetizationFeaturedDocumentProperties | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityChardPredictedXlq | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityPanopticStorytimeAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| robotsPolicy | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanMetadataAvailabilitySnapshot | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryUpdaterIndexSelectionAttachment | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| fontsAnalysisAnnotatorFontsAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingMlPageStructure | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWebtablesDataTableMidAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWebrefUndermergedEntities | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingRaffiaIndexingIntermediate | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityProseJsonLdAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| predictedAuthenticity | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| websitetoolsFeedsSporeFeedsSporeTriples | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryAnnotationsListSummaryAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingInstantSignalSourceTagsExtension | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanMetadataTomeMembersComponent | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| nlpSaftNlxDocAnnotatorMigration | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| tasksTabaTabaDocSignals | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsAppsCacheColonAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| knowledgeTablesTableInternalData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| boilerplateVisibleBytesEstimates | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| knowledgeMiningFactsLocalizedFact | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryAnnotationsVerseAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualitySalientStructuresSalientStructureSet | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingCustomCorpusCdmAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingRaffiaOverlayCDocAttachment | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingDeepwebStoreListAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| researchStructuredDataNewsEmbeddingAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| videoCrawlWatchPagePatternClassification | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityDiscoverUgcScatScatEmbeddingAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityQ2SiteQualityFeatures | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingMobileSmartphonePatternClassification | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| knowledgeMiningShoppingTwdModelVersions | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| forumRankingForumPostsSafeSearchAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryAnnotationsPhoneTypePhoneTypeAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityShoppingProductReview | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| richsnippetsPageMapAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| newsVideosNewsVideoAnnotationSignals | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| adsShoppingWebpxRawShoppingAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityChardDocument | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| commonsenseQueriosityGoldmineQnaAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryAnnotationsLicensedResources | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| knowledgeTablesUniversalTableAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualitySnippetsSnippetSpansInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| videoWebGallery | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| commerceDataqualityOrganicShoppingSiteQuality | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWebrefWebitScopeFprint | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanMetadataTomeDetailsComponent | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingBadpagesUnifiedModelFeatures | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingConverterContentGenerationInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityTimebasedTimeSensitivityTimeSensitivityAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingInstantNewsHighlyCitedDocumentSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingBadpagesCollapserInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| relativeDateAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| shoppingWebentityShoppingAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| geoPointAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| infoextractionPinpointPinpointAnnotationSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityNlqStructuredSearchAnnotationAnalysisAutomaticExtractionAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWebtablesDataTableAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingSelectionProtoBasePromotionInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanMetadataTomePriceInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| richsnippetsPageMap | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsSubscribewithgoogleSwgAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsSocialLinksSocialLinksAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| commonsenseScoredCompoundReferenceAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| newsNearDupsInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityOrbitAsteroidBeltIntermediateDocumentIntentScores | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityProseThumbnailSelection | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| knowledgeTasksUniversalTaskAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWebrefUniversalEmbeddingRetrievalDebug | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWebtablesTranslationMessage | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| navBoostDocument | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| langIdLangReasonerDocumentLanguages | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWebrefPageClassificationAnchorSignalsSet | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| watchpageLanguageWatchPageLanguageResult | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| newsCrawlFilterNewsLinkCrawlSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualitySixfaceSixfaceUrlData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualitySalientTermsSalientTermSet | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| richsnippetsDataObject | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| utilStatusProto | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| dateRangeAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsAutomobileVinAnnotatorAutomobileVinAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingLatticeLatticeAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityRealtimeBoostRealtimeBoostEvent | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingVideosVideoAnchorSourceInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| metawebExtractionDocumentEvidence | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualitySnippetsListSnippetsAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingInstantClusterScorerArticle | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| timeRangeAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| newsNewromanIndexingNewRomanSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| knowledgeGraphAcquisitionFeedsQuotesQuotesAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| newsCorpusLeafPageAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| newsVideosNewsAnchorSourceInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingVideosVideoPlaylistAnchorSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| newsNewsContentSignals | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| nsrFdpData | Must be used together with quality_nsr_nsr_data | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo |
| indexingSelectionProcessingPriorityExtension | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWebrefWebrefEntities | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| whatshappStrideExtractions | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryAnnotationsSectionHeadingAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| dateTimeAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| knowledgeMiningFactsShoppingSignals | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanMetadataPublicDomainInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityExploreQueryableFeedEcsAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityShoppingShoppingProductReviewAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| spamContentImageMapPb | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualitySnippetsMetadescriptionDuplicateMetaSiteSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingSelectionAcquisitionMetadataAttachment | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanMetadataPublicationDetailsComponent | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| personalizationGameWebeventsConsolidatedEvents | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingInstantActiveClusterScorerSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanLibrarianPopulatorPageData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryAnnotationsRdfaRdfaAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| geoPointResolution | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityExploreQueryableFeedTopicFeedScoringSignals | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityExploreQueryableFeedHashtagAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| spamContentSiteAgeStats | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityPopfeedsUrlPredictionAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingFreshSchedulerFreshSchedulerDoubleInstantExtension | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| perDocLangidData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| youtubeAlexandriaYoutubeSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingFreshSchedulerOutlinkDiscoveryHistoricalHubsSignal | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| videoYoutubeLiveCardioCardioStats | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| nlpSaftRodinClassification | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityNlqStructuredSearchListingPagesListingPageAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsSduPageTypeAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingMobileSmartphoneContentAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| newsNewsForEducationReadingStatistics | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryAnnotationsMicrodataMicrodataAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWebrefReferencePagesClassifierScoredPage | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityDniPcuParsedData | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| nlpSaftDocument | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityWebshineDocResources | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| videoCrawlAutomatedExtractionSignals | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| uriAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanMetadataClusteringSeriesSeriesInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityChardPredictedQueryFringeScore | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityHorizonProtoHorizonEmbeddings | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| analyticsSiteidAnalyticsRenderedOutput | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityDniPcuMetaAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanMetadataMaterialInfoComponent | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualitySherlockKnexAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| spambrainDomainSitechunkData | END DATA FIELDS | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo |
| qualityTitlesAlternativeTitlesInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingAnnotationsEntityPage | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityGeoLoglocGoldmineDocumentLocationAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| knowledgeMiningFactsDocumentSignals | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryAnnotationsAddressAnnotations | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| newsCorpusNewsCorpusRootAnnotation | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| oceanMetadataPatentPublicationDetails | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| qualityContraSelectedAttributions | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| rankembed | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| repositoryWebrefPreprocessingReferencePageCandidateList | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| rosettaLanguage | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingMobileObelixInfo | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| indexingSelectionLanguageExtension | IndexingDocjoinerDataVersion | DataVersion tracks the version of data in CompositeDoc. The notion of “data” here is loose and people can define the name of their own. For example, a signal generated by Index Signals or an annotation generated by Goldmine (and other components) can all be considered as data here. Each field in this proto represents the human readable version string and the timestamp of one particular data. We choose to explicitly list out all of the data here for better understanding about which data are tracked. NOTE that human_readable_version is not intended for comparison, use timestamp_micros. In addition, we have an annotation about the field paths of each data. With proto reflection (using google3/net/proto2/util/public/field_path.h), downstream systems can take advantage of this annotation to automatically handle newly introduced data without modifying their code. Please also see the comment of FieldProjector above. There are also some fields in DataInfo that annotate who generates the data, the Index Signals or Goldmine annotator name for the fields already onboarded or being onboarded to FDP. Fields without annotation of signal_names or goldmine_annotator_names are not onboarded. Next ID: 543 | IndexingDocjoinerDataVersionVersionInfo | |
| considerationTimestampMicros | Sometimes, a piece of data may not exist for a document (and we don’t want to delete it), so timestamp_micros won’t exist. However, consideration_timestamp_micros will be set to indicate we tried to update that piece of data for tracking purposes. | IndexingDocjoinerDataVersionVersionInfo | String | |
| humanReadableVersion | IndexingDocjoinerDataVersionVersionInfo | String | ||
| timestampMicros | The timestamp when a piece of data is updated (or deleted if the data doesn’t exist in the update). | IndexingDocjoinerDataVersionVersionInfo | String | |
| clusterId | The unique id to distinguish members in cluster. It could be generated in different ways according to reason, e.g. LINK_REL_NEXT_PREVIOUS: it is the fingerprint of the URL of index 0; PAGE_PARAMETER_INFO: it is the fingerprint of pagination pattern (pagination_pattern_fp field in PageParamInfo message). | IndexingDocjoinerServingTimeClusterId | The serving cluster id metadata. Why we cluster the documents. The default value is UNKNOWN. Serving-Side Clustering is used for pages which represent the same content but are not identical (e.g. translated pages, or paginated content). Those documents are not dup-clustered in Alexandria so that all documents (and their tokens) are available to search queries. However, those documents are assigned the same Serving-Time-Cluster-ID (on the same reasontype), which during serving guarantees that only one of them is shown to the user. | String |
| indexForDebugging | The member index of this document in cluster. Starts from “0”. Note that indices of pages in a cluster may not be consistent with each other, because we may update them at different points in time. Currently only used for debugging. | IndexingDocjoinerServingTimeClusterId | The serving cluster id metadata. Why we cluster the documents. The default value is UNKNOWN. Serving-Side Clustering is used for pages which represent the same content but are not identical (e.g. translated pages, or paginated content). Those documents are not dup-clustered in Alexandria so that all documents (and their tokens) are available to search queries. However, those documents are assigned the same Serving-Time-Cluster-ID (on the same reasontype), which during serving guarantees that only one of them is shown to the user. | integer |
| reason | The reason why this document is clustered into this cluster. | IndexingDocjoinerServingTimeClusterId | The serving cluster id metadata. Why we cluster the documents. The default value is UNKNOWN. Serving-Side Clustering is used for pages which represent the same content but are not identical (e.g. translated pages, or paginated content). Those documents are not dup-clustered in Alexandria so that all documents (and their tokens) are available to search queries. However, those documents are assigned the same Serving-Time-Cluster-ID (on the same reasontype), which during serving guarantees that only one of them is shown to the user. | String |
| clusterId | The exact cluster metadata for each individual cluster if any. | IndexingDocjoinerServingTimeClusterIds | This message contains a set of cluster ids used to de-dup at serving time. A document could be clustered into different clusters according to different properties. | list(IndexingDocjoinerServingTimeClusterId) |
| clusterId | Cluster-ID of that locale entry. Not Populated if the message is part of a Cluster-Proto (e.g. when loaded as a signal). The data is being populated when the proto is used outside of the cluster context. For instance, when being used as a dups-computed-localized-alternate-name. | IndexingDupsComputedLocalizedAlternateNamesLocaleEntry | String | |
| deviceMatchInfo | Device match info calculated only by URL pattern. | IndexingDupsComputedLocalizedAlternateNamesLocaleEntry | String | |
| language | Language/Region code. E.g. “en-US” or “de”. Allowed values are language-region codes based on the W3C recommendation http://www.w3.org/TR/html401/struct/dirlang.html#langcodes | IndexingDupsComputedLocalizedAlternateNamesLocaleEntry | String | |
| url | The alternate url representing the content for a specific language and region (or language only). | IndexingDupsComputedLocalizedAlternateNamesLocaleEntry | String | |
| urlEncoding | see webutil/urlencoding | IndexingDupsComputedLocalizedAlternateNamesLocaleEntry | integer | |
| urlRegionCode | The region code that was extracted from the URL, either by the TLD or via a pattern (like ‘en-ca’ as a path element).. Always filled in if known, unlike the sometimes left out region part of the language field. Unknown Region Code | IndexingDupsComputedLocalizedAlternateNamesLocaleEntry | integer | |
| boostSourceBlocker | Defined as a source-blocker, a result which can be a boost target but should itself not be boosted (e.g. roboted documents). For more details on source and target blocking, please read through the code for quality/twiddler/impls/PROTECTED/local_result_twiddler_v2.cc | IndexingDupsLocalizedLocalizedCluster | boolean | |
| cluster | IndexingDupsLocalizedLocalizedCluster | list(IndexingDupsLocalizedLocalizedClusterCluster) | ||
| deprecatedHreflangInfo | Since July 2014 those two fiels are no longer populated, the data is stored in the TargetLinkSets instead. The deprecated fields contain values only for docs which have not been processed since July 2014. | IndexingDupsLocalizedLocalizedCluster | IndexingDupsLocalizedLocalizedClusterLinkBasedClusterInfo | |
| deprecatedOutlinksInfo | IndexingDupsLocalizedLocalizedCluster | IndexingDupsLocalizedLocalizedClusterLinkBasedClusterInfo | ||
| documentLanguage | The language of this document (as detected by on-page language detection, not influenced by external anchor signals or other indirect conclusions). | IndexingDupsLocalizedLocalizedCluster | String | |
| hreflangTargetLink | IndexingDupsLocalizedLocalizedCluster | IndexingDupsLocalizedLocalizedClusterTargetLinkSets | ||
| inbodyTargetLink | IndexingDupsLocalizedLocalizedCluster | IndexingDupsLocalizedLocalizedClusterTargetLinkSets | ||
| outlinksTargetLink | IndexingDupsLocalizedLocalizedCluster | IndexingDupsLocalizedLocalizedClusterTargetLinkSets | ||
| sitedupRuleId | The list of Sitedup rule IDs for this specific URL. The value is only populated if the URL has at least one localized cluster fulfilling the following conditions: – spans more than one host – does not have filtering enabled due to other input (e.g. due to being a hreflang cluster). | IndexingDupsLocalizedLocalizedCluster | list(String) | |
| warningMessage | A warning indicator that a problem has occurred, e.g. cross-domain links being filtered early. The warning is just presented for debugging purposes. | IndexingDupsLocalizedLocalizedCluster | list(String) | |
| clusterId | The cluster id, a unique int64 id for the cluster. | IndexingDupsLocalizedLocalizedClusterCluster | String | |
| clusterType | IndexingDupsLocalizedLocalizedClusterCluster | String | ||
| deprecatedDebugInfo | Debug Info being attached to each cluster, to understand how it was created. That info is stored in Alexandria, but not available during serving. | IndexingDupsLocalizedLocalizedClusterCluster | list(String) | |
| filteringEnabled | Indicates that filtering can be applied on the category (if many results of one cluster show up on the SERP, only one should be kept). | IndexingDupsLocalizedLocalizedClusterCluster | boolean | |
| language | The language as represented by the URL, e.g. ‘use this document on the cluster for German queries’. | IndexingDupsLocalizedLocalizedClusterCluster | String | |
| regionCode | Same as language, except for the country. This is the Stable Region Code. This value may be UNKNOWN even though the URL region code is known, namely when the known region code was the main region for the language and for that language no other region is specified (e.g. de-DE being the only german variation). Unknown Region Code | IndexingDupsLocalizedLocalizedClusterCluster | integer | |
| urlRegionCode | Similar to region_code, but always has the value filled in if known. Unknown Region Code | IndexingDupsLocalizedLocalizedClusterCluster | integer | |
| fpOutlinks | A fingerprint of all outlink-URLs of this document that have been used as algorithmic input. | IndexingDupsLocalizedLocalizedClusterLinkBasedClusterInfo | ClusterInfo no longer being populated (they are the ‘old’ version of storing meta-information only available in old not-reprocessed documents, all documents processed since July 2014 use the ‘TargetLinkSet’ instead. | String |
| lastModifiedInputTimestampMs | The last time the set of outgoing links of this document was modified. This is the input for our calculation. | IndexingDupsLocalizedLocalizedClusterLinkBasedClusterInfo | ClusterInfo no longer being populated (they are the ‘old’ version of storing meta-information only available in old not-reprocessed documents, all documents processed since July 2014 use the ‘TargetLinkSet’ instead. | String |
| lastProcessedOutputTimestampMs | The last time the cross-validation of the links was done. Between that last timestamp and now, only cached results have been used. | IndexingDupsLocalizedLocalizedClusterLinkBasedClusterInfo | ClusterInfo no longer being populated (they are the ‘old’ version of storing meta-information only available in old not-reprocessed documents, all documents processed since July 2014 use the ‘TargetLinkSet’ instead. | String |
| linkMember | All verified members of the cluster (including recursive inclusions). | IndexingDupsLocalizedLocalizedClusterLinkBasedClusterInfo | ClusterInfo no longer being populated (they are the ‘old’ version of storing meta-information only available in old not-reprocessed documents, all documents processed since July 2014 use the ‘TargetLinkSet’ instead. | list(IndexingDupsLocalizedLocalizedClusterLinkBasedClusterInfoLinkMember) |
| unvalidatedOutlink | IndexingDupsLocalizedLocalizedClusterLinkBasedClusterInfo | ClusterInfo no longer being populated (they are the ‘old’ version of storing meta-information only available in old not-reprocessed documents, all documents processed since July 2014 use the ‘TargetLinkSet’ instead. | list(IndexingDupsLocalizedLocalizedClusterLinkBasedClusterInfoLinkData) | |
| annotationSource | IndexingDupsLocalizedLocalizedClusterLinkBasedClusterInfoLinkData | String | ||
| crawlTimestamp | If set, represents the crawl timestamp. If not set, there is no known crawl timestamp for that url. | IndexingDupsLocalizedLocalizedClusterLinkBasedClusterInfoLinkData | integer | |
| url | IndexingDupsLocalizedLocalizedClusterLinkBasedClusterInfoLinkData | String | ||
| annotationSource | IndexingDupsLocalizedLocalizedClusterLinkBasedClusterInfoLinkMember | String | ||
| languageCode | IndexingDupsLocalizedLocalizedClusterLinkBasedClusterInfoLinkMember | list(String) | ||
| url | IndexingDupsLocalizedLocalizedClusterLinkBasedClusterInfoLinkMember | String | ||
| linkData | IndexingDupsLocalizedLocalizedClusterTargetLink | Message containing information about the localized URL linked to from this document in a localized-variation-context. | IndexingDupsLocalizedLocalizedClusterTargetLinkLink | |
| metaData | IndexingDupsLocalizedLocalizedClusterTargetLink | Message containing information about the localized URL linked to from this document in a localized-variation-context. | IndexingDupsLocalizedLocalizedClusterTargetLinkMetadata | |
| targetDocData | IndexingDupsLocalizedLocalizedClusterTargetLink | Message containing information about the localized URL linked to from this document in a localized-variation-context. | IndexingDupsLocalizedLocalizedClusterTargetLinkTargetDocData | |
| validationStatus | IndexingDupsLocalizedLocalizedClusterTargetLink | Message containing information about the localized URL linked to from this document in a localized-variation-context. | String | |
| annotationSourceInfo | IndexingDupsLocalizedLocalizedClusterTargetLinkLink | Basic information about the link target, i.e. the URL or the language code it’s believed to represent. | list(IndexingDupsLocalizedLocalizedClusterTargetLinkLinkAnnotationSourceInfo) | |
| crossDomain | For a link A->B where B is represented by this proto, cross_domain := Host(A) != Host(B). | IndexingDupsLocalizedLocalizedClusterTargetLinkLink | Basic information about the link target, i.e. the URL or the language code it’s believed to represent. | boolean |
| url | The URL the information in TargetLink refers to. | IndexingDupsLocalizedLocalizedClusterTargetLinkLink | Basic information about the link target, i.e. the URL or the language code it’s believed to represent. | String |
| anchorText | Optional field for storing the anchor text the language code was extracted from. Applies to outlinks only. | IndexingDupsLocalizedLocalizedClusterTargetLinkLinkAnnotationSourceInfo | Message describing where was the link discovered and with what language annotation. | String |
| annotationSource | Information about where the language code was extracted from. | IndexingDupsLocalizedLocalizedClusterTargetLinkLinkAnnotationSourceInfo | Message describing where was the link discovered and with what language annotation. | String |
| languageCode | Language code extracted from the URL (hreflang or outlink). One URL can represent multiple language codes, like e.g. de-at and de-ch | IndexingDupsLocalizedLocalizedClusterTargetLinkLinkAnnotationSourceInfo | Message describing where was the link discovered and with what language annotation. | String |
| sourceFeedUrl | Optional field that stores the feed URL where a Sitemap annotation was discovered. Only populated if annotation_source is SITEMAP. | IndexingDupsLocalizedLocalizedClusterTargetLinkLinkAnnotationSourceInfo | Message describing where was the link discovered and with what language annotation. | String |
| firstSeenMs | When was the first time a link seen. Defaults to last crawled timestamp. | IndexingDupsLocalizedLocalizedClusterTargetLinkMetadata | Information derived from alexandria when processing the cross-link validation (e.g. when this was done the last time, or when we started to see the outlink for the first time). | String |
| lastVerifiedMs | When was the last time a link validated. Validation is the process of (re)reading the relevant information for a linked document from its respective row in the document table. Data needed for understanding the correctness of the cluster is copied over to have it available locally. | IndexingDupsLocalizedLocalizedClusterTargetLinkMetadata | Information derived from alexandria when processing the cross-link validation (e.g. when this was done the last time, or when we started to see the outlink for the first time). | String |
| directTargetLink | Direct links are the simplest scenarios where A simply links to B. | IndexingDupsLocalizedLocalizedClusterTargetLinkSets | list(IndexingDupsLocalizedLocalizedClusterTargetLink) | |
| indirectTargetLink | Repeated field for URLs that are not directly linking to the document TargetLink refers to. We can encounter the following scenario: A -> Links to B -> links to C (i.e. without (A) linking to (C)). In the context of B, indirect_inclusion would include the link to ‘C’ but not the link back to ‘A’. | IndexingDupsLocalizedLocalizedClusterTargetLinkSets | list(IndexingDupsLocalizedLocalizedClusterTargetLink) | |
| contentLanguage | The detected on-page content language of the document. | IndexingDupsLocalizedLocalizedClusterTargetLinkTargetDocData | Information about the URLs being validated. | String |
| crawlStatus | IndexingDupsLocalizedLocalizedClusterTargetLinkTargetDocData | Information about the URLs being validated. | String | |
| crawlTimestampSeconds | The timestamp of the last crawl attempt from crawl_timestamp column. | IndexingDupsLocalizedLocalizedClusterTargetLinkTargetDocData | Information about the URLs being validated. | integer |
| isCanonical | Whether the URL being validated is canonical at the time of processing. | IndexingDupsLocalizedLocalizedClusterTargetLinkTargetDocData | Information about the URLs being validated. | boolean |
| outgoingLinkData | Repeated field for data about the outgoing hreflang links that appear in the document that the currently processed URL refers to. | IndexingDupsLocalizedLocalizedClusterTargetLinkTargetDocData | Information about the URLs being validated. | list(IndexingDupsLocalizedLocalizedClusterTargetLinkLink) |
| compressedDocumentTrees | The document’s DOM and render tree produced by WebKit as a side effect of rendering the page. It might be compressed or not. Thus, use indexing::embedded_content::UncompressWebkitDocument to decode it. | IndexingEmbeddedContentEmbeddedContentInfo | This protobuf is used (1) To pass data between EmbeddedExporter and the publisher, and (2) As a member of CompositeDoc, to stick embedded content output into the docjoins. Next tag available: 21 | String |
| convertedContents | The converted contents, as produced by the same DocumentUpdater transaction that generated the render tree. Useful whenever one of our users wants to experiment with deriving an annotation from the render tree. | IndexingEmbeddedContentEmbeddedContentInfo | This protobuf is used (1) To pass data between EmbeddedExporter and the publisher, and (2) As a member of CompositeDoc, to stick embedded content output into the docjoins. Next tag available: 21 | String |
| embeddedLinksInfo | Information about all external resources needed to render this page, a.k.a. embedded links. This includes .css files, images embedded in a page, external javascripts, iframes etc. | IndexingEmbeddedContentEmbeddedContentInfo | This protobuf is used (1) To pass data between EmbeddedExporter and the publisher, and (2) As a member of CompositeDoc, to stick embedded content output into the docjoins. Next tag available: 21 | IndexingEmbeddedContentEmbeddedLinksInfo |
| headlessResponse | The headless response for rendering the document. | IndexingEmbeddedContentEmbeddedContentInfo | This protobuf is used (1) To pass data between EmbeddedExporter and the publisher, and (2) As a member of CompositeDoc, to stick embedded content output into the docjoins. Next tag available: 21 | HtmlrenderWebkitHeadlessProtoRenderResponse |
| isAlternateSnapshot | Indicate if the snapshot is generated from alternate snapshot. If true, the snapshot will be exported even if the snapshot quality score is low. | IndexingEmbeddedContentEmbeddedContentInfo | This protobuf is used (1) To pass data between EmbeddedExporter and the publisher, and (2) As a member of CompositeDoc, to stick embedded content output into the docjoins. Next tag available: 21 | boolean |
| originalEncoding | The original encoding of the content crawled from trawler. It’s the value of enum i18n::encodings::encoding. We put a int32 here instead of encoding proto to maintain the compatibility of “py_api_version = 1” | IndexingEmbeddedContentEmbeddedContentInfo | This protobuf is used (1) To pass data between EmbeddedExporter and the publisher, and (2) As a member of CompositeDoc, to stick embedded content output into the docjoins. Next tag available: 21 | integer |
| rawRedirectInfo | *** DEPRECATED *** This field is only populated in fresh_doc which is shutting down. | IndexingEmbeddedContentEmbeddedContentInfo | This protobuf is used (1) To pass data between EmbeddedExporter and the publisher, and (2) As a member of CompositeDoc, to stick embedded content output into the docjoins. Next tag available: 21 | IndexingConverterRawRedirectInfo |
| referencedResource | Information about all external resources used to render this page, a.k.a. embedded links. This includes .css files, images embedded in a page, external javascripts, iframes etc. | IndexingEmbeddedContentEmbeddedContentInfo | This protobuf is used (1) To pass data between EmbeddedExporter and the publisher, and (2) As a member of CompositeDoc, to stick embedded content output into the docjoins. Next tag available: 21 | list(HtmlrenderWebkitHeadlessProtoReferencedResource) |
| renderedSnapshot | Only exist in dry run mode. | IndexingEmbeddedContentEmbeddedContentInfo | This protobuf is used (1) To pass data between EmbeddedExporter and the publisher, and (2) As a member of CompositeDoc, to stick embedded content output into the docjoins. Next tag available: 21 | HtmlrenderWebkitHeadlessProtoImage |
| renderedSnapshotImage | Snapshot image of a rendered html document (possibly encoded as png, jpeg, or webp). | IndexingEmbeddedContentEmbeddedContentInfo | This protobuf is used (1) To pass data between EmbeddedExporter and the publisher, and (2) As a member of CompositeDoc, to stick embedded content output into the docjoins. Next tag available: 21 | String |
| renderedSnapshotMetadata | A collection of values which are needed by the users of the Kodachrome bigtable. | IndexingEmbeddedContentEmbeddedContentInfo | This protobuf is used (1) To pass data between EmbeddedExporter and the publisher, and (2) As a member of CompositeDoc, to stick embedded content output into the docjoins. Next tag available: 21 | SnapshotSnapshotMetadata |
| renderedSnapshotQualityScore | The quality of the image, 0.0 is the worst, 1.0 is the best. If all dependencies are successfully crawled, the quality should be 1.0. If one or more of the dependencies are unknown, the quality will be lower. | IndexingEmbeddedContentEmbeddedContentInfo | This protobuf is used (1) To pass data between EmbeddedExporter and the publisher, and (2) As a member of CompositeDoc, to stick embedded content output into the docjoins. Next tag available: 21 | float |
| renderingOutputMetadata | IndexingEmbeddedContentEmbeddedContentInfo | This protobuf is used (1) To pass data between EmbeddedExporter and the publisher, and (2) As a member of CompositeDoc, to stick embedded content output into the docjoins. Next tag available: 21 | IndexingEmbeddedContentRenderingOutputMetadata | |
| richcontentData | The rich content data to recover the original contents from the converted_contents. Useful for offline content analysis. | IndexingEmbeddedContentEmbeddedContentInfo | This protobuf is used (1) To pass data between EmbeddedExporter and the publisher, and (2) As a member of CompositeDoc, to stick embedded content output into the docjoins. Next tag available: 21 | IndexingConverterRichContentData |
| embedderInfo | This field is optional only because we’re adding it late and want to support records written before that. For newly produced records, this field should always be set. | IndexingEmbeddedContentEmbeddedLinksInfo | IndexingEmbeddedContentEmbedderInfo | |
| link | IndexingEmbeddedContentEmbeddedLinksInfo | list(IndexingEmbeddedContentLinkInfo) | ||
| pageSizeInfo | Page download size. | IndexingEmbeddedContentEmbeddedLinksInfo | IndexingEmbeddedContentPageSizeInfo | |
| sumHttpResponseLength | This field is the sum of http_response_length for the embedder and all embedded resources. This is expected to be set only in the docjoins, not in the pinax tables or the exported bigtable. | IndexingEmbeddedContentEmbeddedLinksInfo | integer | |
| uncrawledLinkUrl | IndexingEmbeddedContentEmbeddedLinksInfo | list(String) | ||
| importanceAsEmbedder | IndexingEmbeddedContentEmbedderInfo | integer | ||
| linkInfo | IndexingEmbeddedContentEmbedderInfo | IndexingEmbeddedContentLinkInfo | ||
| counter | IndexingEmbeddedContentFetchHostCount | Log how many urls finally goes to trawler on a host in rendering. | list(IndexingEmbeddedContentFetchHostCountCounter) | |
| host | IndexingEmbeddedContentFetchHostCount | Log how many urls finally goes to trawler on a host in rendering. | String | |
| num | IndexingEmbeddedContentFetchHostCount | Log how many urls finally goes to trawler on a host in rendering. | integer | |
| name | IndexingEmbeddedContentFetchHostCountCounter | String | ||
| num | IndexingEmbeddedContentFetchHostCountCounter | integer | ||
| adsResourceType | IndexingEmbeddedContentFetchUrlResponseMetadata | Capsulate all metadata annotated from fetch server. This message will typically go through: – EmbeddedContentFetcher, or – EmbeddedLinkGetter-> DenormalizedContent -> ContentStore. And finally deposit in referenced_resources and link_info. | String | |
| crawlStatus | The field always exists, and has four options: UNKNOWN, CONTENT, ROBOTED and ERROR, which are defined in indexing.converter.CrawlStatus. | IndexingEmbeddedContentFetchUrlResponseMetadata | Capsulate all metadata annotated from fetch server. This message will typically go through: – EmbeddedContentFetcher, or – EmbeddedLinkGetter-> DenormalizedContent -> ContentStore. And finally deposit in referenced_resources and link_info. | integer |
| criticalResourceType | IndexingEmbeddedContentFetchUrlResponseMetadata | Capsulate all metadata annotated from fetch server. This message will typically go through: – EmbeddedContentFetcher, or – EmbeddedLinkGetter-> DenormalizedContent -> ContentStore. And finally deposit in referenced_resources and link_info. | String | |
| fetchWithSmartphoneUa | True if the response is fetched with SMARTPHONE user agent. | IndexingEmbeddedContentFetchUrlResponseMetadata | Capsulate all metadata annotated from fetch server. This message will typically go through: – EmbeddedContentFetcher, or – EmbeddedLinkGetter-> DenormalizedContent -> ContentStore. And finally deposit in referenced_resources and link_info. | boolean |
| isAdsResource | IndexingEmbeddedContentFetchUrlResponseMetadata | Capsulate all metadata annotated from fetch server. This message will typically go through: – EmbeddedContentFetcher, or – EmbeddedLinkGetter-> DenormalizedContent -> ContentStore. And finally deposit in referenced_resources and link_info. | boolean | |
| isCriticalResource | IndexingEmbeddedContentFetchUrlResponseMetadata | Capsulate all metadata annotated from fetch server. This message will typically go through: – EmbeddedContentFetcher, or – EmbeddedLinkGetter-> DenormalizedContent -> ContentStore. And finally deposit in referenced_resources and link_info. | boolean | |
| isTrivialResource | IndexingEmbeddedContentFetchUrlResponseMetadata | Capsulate all metadata annotated from fetch server. This message will typically go through: – EmbeddedContentFetcher, or – EmbeddedLinkGetter-> DenormalizedContent -> ContentStore. And finally deposit in referenced_resources and link_info. | boolean | |
| numTrawlerFetches | Number of trawler fetches while fetching this URL. In most cases, this number will be 0 or 1. | IndexingEmbeddedContentFetchUrlResponseMetadata | Capsulate all metadata annotated from fetch server. This message will typically go through: – EmbeddedContentFetcher, or – EmbeddedLinkGetter-> DenormalizedContent -> ContentStore. And finally deposit in referenced_resources and link_info. | integer |
| rewriteMethod | Used for logging purposes only here. | IndexingEmbeddedContentFetchUrlResponseMetadata | Capsulate all metadata annotated from fetch server. This message will typically go through: – EmbeddedContentFetcher, or – EmbeddedLinkGetter-> DenormalizedContent -> ContentStore. And finally deposit in referenced_resources and link_info. | String |
| robotsInfo | Note that this robots_info should only be used for noindex_reason and will only be present for TARGET_MAIN_FRAME / TARGET_SUBFRAME fetches. | IndexingEmbeddedContentFetchUrlResponseMetadata | Capsulate all metadata annotated from fetch server. This message will typically go through: – EmbeddedContentFetcher, or – EmbeddedLinkGetter-> DenormalizedContent -> ContentStore. And finally deposit in referenced_resources and link_info. | IndexingConverterRobotsInfo |
| contentLength | Size of the HTTP body (payload of the HTTP response, excluding headers), pre-decompression. Equal to the value of the Content-Length header if any. NOTE: if this proto is converted to from ReferencedResource, we have to use the size of the full HTTP response (i.e. http_response_length) as an approximation, as we could not get the size of HTTP headers. | IndexingEmbeddedContentLinkInfo | Information about one embedded link. Next tag: 18 | integer |
| contentType | IndexingEmbeddedContentLinkInfo | Information about one embedded link. Next tag: 18 | integer | |
| crawlDuration | Time spent downloading this resource, in milliseconds. Not a timestamp! | IndexingEmbeddedContentLinkInfo | Information about one embedded link. Next tag: 18 | integer |
| crawlStatus | Enum values for crawl_status are defined in indexing/converter/proto/converter.proto | IndexingEmbeddedContentLinkInfo | Information about one embedded link. Next tag: 18 | integer |
| crawlTimestamp | IndexingEmbeddedContentLinkInfo | Information about one embedded link. Next tag: 18 | integer | |
| deprecatedRedirect | IndexingEmbeddedContentLinkInfo | Information about one embedded link. Next tag: 18 | list(String) | |
| fetchSourceInfo | Where this resource comes from. | IndexingEmbeddedContentLinkInfo | Information about one embedded link. Next tag: 18 | list(WirelessTranscoderFetchFetchSourceInfo) |
| fetchStatus | Fetch status from trawler. | IndexingEmbeddedContentLinkInfo | Information about one embedded link. Next tag: 18 | TrawlerFetchStatus |
| fetchUrlResponseMetadata | Populated from embedded-content fetch server. | IndexingEmbeddedContentLinkInfo | Information about one embedded link. Next tag: 18 | IndexingEmbeddedContentFetchUrlResponseMetadata |
| frd | FetchReplyData from trawler. | IndexingEmbeddedContentLinkInfo | Information about one embedded link. Next tag: 18 | TrawlerFetchReplyData |
| httpResponseLength | Size of the full HTTP response (headers and body pre-decompression). Semantically equal to content_length plus size of the HTTP headers. | IndexingEmbeddedContentLinkInfo | Information about one embedded link. Next tag: 18 | integer |
| isCacheable | IndexingEmbeddedContentLinkInfo | Information about one embedded link. Next tag: 18 | boolean | |
| isRobotedContentFromFastnet | IndexingEmbeddedContentLinkInfo | Information about one embedded link. Next tag: 18 | boolean | |
| uncompressedContentLength | Size of the HTTP body (payload of the HTTP response, excluding headers), post-decompression. Equal to content_length if the body was not compressed to begin with. NOTE: if this proto is converted to from ReferencedResource, we have to use the size of the full HTTP response as an approximation, as we could not get the size of HTTP headers. | IndexingEmbeddedContentLinkInfo | Information about one embedded link. Next tag: 18 | integer |
| url | IndexingEmbeddedContentLinkInfo | Information about one embedded link. Next tag: 18 | String | |
| webkitFetchMetadata | IndexingEmbeddedContentLinkInfo | Information about one embedded link. Next tag: 18 | HtmlrenderWebkitHeadlessProtoWebKitFetchMetadata | |
| documentData | IndexingEmbeddedContentOutputGenerationTimestamps | For each of the output fields generated by the embedded content system, the Unix timestamp of when it was most recently generated. Used for controlling the frequency of generation (and thus exporting) of the fields which are expensive to generate and/or the consumers of which are not able to handle the high load of daily/hourly updates. If a timestamp corresponding to an output field is missing, it means the last attempt to generate this field failed (which could be mean that the document was not important enough for this field to be generated, or that we hit a bug in WebKit). In case we choose not to regenerate the field (because the latest generation timestamp is too fresh) the corresponding timestamp doesn’t change. Next tag available: 8 | integer | |
| renderedSnapshot | IndexingEmbeddedContentOutputGenerationTimestamps | For each of the output fields generated by the embedded content system, the Unix timestamp of when it was most recently generated. Used for controlling the frequency of generation (and thus exporting) of the fields which are expensive to generate and/or the consumers of which are not able to handle the high load of daily/hourly updates. If a timestamp corresponding to an output field is missing, it means the last attempt to generate this field failed (which could be mean that the document was not important enough for this field to be generated, or that we hit a bug in WebKit). In case we choose not to regenerate the field (because the latest generation timestamp is too fresh) the corresponding timestamp doesn’t change. Next tag available: 8 | integer | |
| numImages | Images are also resources. num_images <= num_resources. | IndexingEmbeddedContentPageSizeInfo | Page download size information. | integer |
| numImagesWithContent | Number of images whose crawl status is CONTENT. | IndexingEmbeddedContentPageSizeInfo | Page download size information. | integer |
| numResources | Numbers below don’t include embedder. | IndexingEmbeddedContentPageSizeInfo | Page download size information. | integer |
| numResourcesWithContent | Number of resources whose crawl status is CONTENT. | IndexingEmbeddedContentPageSizeInfo | Page download size information. | integer |
| sumHttpResponseLength | Sum of embedder and all referenced resources. | IndexingEmbeddedContentPageSizeInfo | Page download size information. | integer |
| cacheExpireTimestampUsec | When the rendered content would expire from the cache in microseconds. | IndexingEmbeddedContentRenderCacheStats | Fields used to track cache use in the rendering microservice. Next tag available: 6 | String |
| crawledSimhashDistance | IndexingEmbeddedContentRenderCacheStats | Fields used to track cache use in the rendering microservice. Next tag available: 6 | integer | |
| lastRenderedTimestampUsec | The last time the document was rendered, in microseconds. Does not update in case of cache use. | IndexingEmbeddedContentRenderCacheStats | Fields used to track cache use in the rendering microservice. Next tag available: 6 | String |
| renderCache | IndexingEmbeddedContentRenderCacheStats | Fields used to track cache use in the rendering microservice. Next tag available: 6 | String | |
| renderedSimhashDistance | IndexingEmbeddedContentRenderCacheStats | Fields used to track cache use in the rendering microservice. Next tag available: 6 | integer | |
| fetchHostCount | A host->count mapping to log how many embedded_links in each host finally goes to trawler during rendering. | IndexingEmbeddedContentRenderingFetchStats | Fetch stats during rendering. | list(IndexingEmbeddedContentFetchHostCount) |
| configParams | IndexingEmbeddedContentRenderingOutputMetadata | Small values from rendering output. It’s stored as a column in alexandria document table. Next tag available: 30 | IndexingEmbeddedContentRenderRequestConfigConfigParams | |
| exceptions | The exceptions observed during the rendering. In bit-field encoding of enum values of RenderResponse.RenderingException. | IndexingEmbeddedContentRenderingOutputMetadata | Small values from rendering output. It’s stored as a column in alexandria document table. Next tag available: 30 | String |
| experimentalRenderTimeMsec | Total GCU time for rendering the document in millisecond. This data is from render_stats.render_cost_mgcu in RenderResponse proto. Note that this is *experimental* field. Please check with rendering-infra@ if you want to use. | IndexingEmbeddedContentRenderingOutputMetadata | Small values from rendering output. It’s stored as a column in alexandria document table. Next tag available: 30 | integer |
| generationTimestamps | IndexingEmbeddedContentRenderingOutputMetadata | Small values from rendering output. It’s stored as a column in alexandria document table. Next tag available: 30 | IndexingEmbeddedContentOutputGenerationTimestamps | |
| importance | The importance value of the rendered document. | IndexingEmbeddedContentRenderingOutputMetadata | Small values from rendering output. It’s stored as a column in alexandria document table. Next tag available: 30 | integer |
| lastNewContentProbingTimestamp | The timestamp of last new content probing. | IndexingEmbeddedContentRenderingOutputMetadata | Small values from rendering output. It’s stored as a column in alexandria document table. Next tag available: 30 | integer |
| newTokensPercentageAfterRendering | Percentage of new tokens in the rendered the document content. | IndexingEmbeddedContentRenderingOutputMetadata | Small values from rendering output. It’s stored as a column in alexandria document table. Next tag available: 30 | float |
| numNewTokensFoundInRendering | IndexingEmbeddedContentRenderingOutputMetadata | Small values from rendering output. It’s stored as a column in alexandria document table. Next tag available: 30 | integer | |
| refresh | IndexingEmbeddedContentRenderingOutputMetadata | Small values from rendering output. It’s stored as a column in alexandria document table. Next tag available: 30 | boolean | |
| renderCacheStats | A collection of fields to track stats on cache use in the Rendering microservice. | IndexingEmbeddedContentRenderingOutputMetadata | Small values from rendering output. It’s stored as a column in alexandria document table. Next tag available: 30 | IndexingEmbeddedContentRenderCacheStats |
| renderEngine | IndexingEmbeddedContentRenderingOutputMetadata | Small values from rendering output. It’s stored as a column in alexandria document table. Next tag available: 30 | String | |
| renderEvent | Different types of events which happened during rendering. | IndexingEmbeddedContentRenderingOutputMetadata | Small values from rendering output. It’s stored as a column in alexandria document table. Next tag available: 30 | list(HtmlrenderWebkitHeadlessProtoRenderEvent) |
| renderServerCl | The CL from which the render engine was built. | IndexingEmbeddedContentRenderingOutputMetadata | Small values from rendering output. It’s stored as a column in alexandria document table. Next tag available: 30 | String |
| renderTreeQualityScore | IndexingEmbeddedContentRenderingOutputMetadata | Small values from rendering output. It’s stored as a column in alexandria document table. Next tag available: 30 | float | |
| renderedSnapshotSignature | Short signature (usually less than 1 KB) which captures a perceptual hash on the rendered image. This is used to determine whether successive renderings should be output. See the library in googlen/snapshot/shared/similarity.* for more info about how this value is interpreted and used. | IndexingEmbeddedContentRenderingOutputMetadata | Small values from rendering output. It’s stored as a column in alexandria document table. Next tag available: 30 | String |
| renderedTimeUsec | Current time in microseconds the document is going through rendering system. This field is set regardless of whether the document is being rendered or if we are skipping rendering by using a cache. | IndexingEmbeddedContentRenderingOutputMetadata | Small values from rendering output. It’s stored as a column in alexandria document table. Next tag available: 30 | String |
| renderingFetchStats | IndexingEmbeddedContentRenderingOutputMetadata | Small values from rendering output. It’s stored as a column in alexandria document table. Next tag available: 30 | IndexingEmbeddedContentRenderingFetchStats | |
| selectionResult | The corpus selection result. Can be used for offline analysis. | IndexingEmbeddedContentRenderingOutputMetadata | Small values from rendering output. It’s stored as a column in alexandria document table. Next tag available: 30 | IndexingEmbeddedContentSelectionResult |
| snapshotQualityScore | These scores are copied from htmlrender_webkit_headless_proto.Document. | IndexingEmbeddedContentRenderingOutputMetadata | Small values from rendering output. It’s stored as a column in alexandria document table. Next tag available: 30 | float |
| withMissingResources | True if there were any missing resources during the rendering. | IndexingEmbeddedContentRenderingOutputMetadata | Small values from rendering output. It’s stored as a column in alexandria document table. Next tag available: 30 | boolean |
| virtualTime | IndexingEmbeddedContentRenderRequestConfigConfigParams | float | ||
| renderEffort | IndexingEmbeddedContentSelectionResult | Output that indicates a url should be in our corpus. | String | |
| selectorId | Indicate which selector has made the decision. | IndexingEmbeddedContentSelectionResult | Output that indicates a url should be in our corpus. | String |
| id | Unique ID. | IndexingMlVerticalVerticalItem | integer | |
| name | The description name. | IndexingMlVerticalVerticalItem | String | |
| petacatId | The corresponding Petacat ID. | IndexingMlVerticalVerticalItem | integer | |
| probability | The probability of the vertical, whose value is in [0.0, 1.0]. | IndexingMlVerticalVerticalItem | number | |
| details | IndexingMobileInterstitialsProtoDesktopInterstitials | Desktop interstitials signal. The message contains both fields for site-level signal lookup in Index Signals (go/index-signals) and fields for final attachment in DocJoin. | list(IndexingMobileInterstitialsProtoDesktopInterstitialsDetails) | |
| pipelineEpoch | Epoch of the interstitial offline pipeline generating this signal. | IndexingMobileInterstitialsProtoDesktopInterstitials | Desktop interstitials signal. The message contains both fields for site-level signal lookup in Index Signals (go/index-signals) and fields for final attachment in DocJoin. | String |
| pipelinePattern | If present, pipeline_pattern identifies the cluster of URLs for which the signal value was smeared. | IndexingMobileInterstitialsProtoDesktopInterstitials | Desktop interstitials signal. The message contains both fields for site-level signal lookup in Index Signals (go/index-signals) and fields for final attachment in DocJoin. | String |
| urlTree | URL tree of interstitial patterns belong to the host, to be used as site-level signal in Index Signals. A pattern may contain a payload InterstitialPatternPayload, which will indicate the violated interstitial types of this pattern. | IndexingMobileInterstitialsProtoDesktopInterstitials | Desktop interstitials signal. The message contains both fields for site-level signal lookup in Index Signals (go/index-signals) and fields for final attachment in DocJoin. | IndexingUrlPatternUrlTreeUrlTree |
| violatesDesktopInterstitialPolicy | Overall policy violation status. If this is true, at least one of the InterstitialSignal below indicates a violation. | IndexingMobileInterstitialsProtoDesktopInterstitials | Desktop interstitials signal. The message contains both fields for site-level signal lookup in Index Signals (go/index-signals) and fields for final attachment in DocJoin. | boolean |
| basicInfo | IndexingMobileInterstitialsProtoDesktopInterstitialsDetails | An optional message that may contain details of the signals computation. | IndexingMobileInterstitialsProtoInterstitialBasicInfo | |
| isSmearedSignal | Indicates whether the signal value is “smeared”, e.g. extrapolated from other URLs. | IndexingMobileInterstitialsProtoDesktopInterstitialsDetails | An optional message that may contain details of the signals computation. | boolean |
| absoluteBox | Stores the geometry of detected interstitial in absolute page pixels. | IndexingMobileInterstitialsProtoInterstitialBasicInfo | Basic interstitial info, shared by all layout types. This message can be used to quickly iterate through detected interstitials, if layout type specific details are not required. Note: this message stores info for one primary interstitial as detected by a particular layout codepath. Some codepaths, e.g. overlay interstitial detection, may find multiple interstitial candidates; such details can be found in codepath-specific messages below. | HtmlrenderWebkitHeadlessProtoBox |
| contentType | IndexingMobileInterstitialsProtoInterstitialBasicInfo | Basic interstitial info, shared by all layout types. This message can be used to quickly iterate through detected interstitials, if layout type specific details are not required. Note: this message stores info for one primary interstitial as detected by a particular layout codepath. Some codepaths, e.g. overlay interstitial detection, may find multiple interstitial candidates; such details can be found in codepath-specific messages below. | String | |
| detectionMode | IndexingMobileInterstitialsProtoInterstitialBasicInfo | Basic interstitial info, shared by all layout types. This message can be used to quickly iterate through detected interstitials, if layout type specific details are not required. Note: this message stores info for one primary interstitial as detected by a particular layout codepath. Some codepaths, e.g. overlay interstitial detection, may find multiple interstitial candidates; such details can be found in codepath-specific messages below. | String | |
| layoutType | IndexingMobileInterstitialsProtoInterstitialBasicInfo | Basic interstitial info, shared by all layout types. This message can be used to quickly iterate through detected interstitials, if layout type specific details are not required. Note: this message stores info for one primary interstitial as detected by a particular layout codepath. Some codepaths, e.g. overlay interstitial detection, may find multiple interstitial candidates; such details can be found in codepath-specific messages below. | String | |
| cls | Cumulative Layout Shift. | IndexingMobileVoltCoreWebVitals | Core Web Vitals (https://web.dev/vitals/) carried in VoltSignal: the field data metrics extracted from UKM aggregated 75-percentile data. | String |
| fid | First Input Delay. | IndexingMobileVoltCoreWebVitals | Core Web Vitals (https://web.dev/vitals/) carried in VoltSignal: the field data metrics extracted from UKM aggregated 75-percentile data. | String |
| inp | IndexingMobileVoltCoreWebVitals | Core Web Vitals (https://web.dev/vitals/) carried in VoltSignal: the field data metrics extracted from UKM aggregated 75-percentile data. | String | |
| lcp | Largest Contentful Paint. | IndexingMobileVoltCoreWebVitals | Core Web Vitals (https://web.dev/vitals/) carried in VoltSignal: the field data metrics extracted from UKM aggregated 75-percentile data. | String |
| desktopCwv | Desktop Core Wev Vital metrics. NOTE(yunchengz): This field will not be populated in Muppet. | IndexingMobileVoltVoltPerDocData | The protocol buffer stored in the legacyperdocdata muppet attachment for VOLT (go/volt). The data is used for ranking changes. Only CWV signals and secure signal are stored. MobileFriendliness is stored separately in the legacyperdocdata. Safe browsing and BAS/AER conditions are not used for ranking. | IndexingMobileVoltCoreWebVitals |
| desktopDisplayUrlIsHttps | IndexingMobileVoltVoltPerDocData | The protocol buffer stored in the legacyperdocdata muppet attachment for VOLT (go/volt). The data is used for ranking changes. Only CWV signals and secure signal are stored. MobileFriendliness is stored separately in the legacyperdocdata. Safe browsing and BAS/AER conditions are not used for ranking. | boolean | |
| displayUrlIsHttps | IndexingMobileVoltVoltPerDocData | The protocol buffer stored in the legacyperdocdata muppet attachment for VOLT (go/volt). The data is used for ranking changes. Only CWV signals and secure signal are stored. MobileFriendliness is stored separately in the legacyperdocdata. Safe browsing and BAS/AER conditions are not used for ranking. | boolean | |
| mobileCwv | Mobile Core Web Vital metrics. NOTE(yunchengz): This field will not be populated in Muppet. | IndexingMobileVoltVoltPerDocData | The protocol buffer stored in the legacyperdocdata muppet attachment for VOLT (go/volt). The data is used for ranking changes. Only CWV signals and secure signal are stored. MobileFriendliness is stored separately in the legacyperdocdata. Safe browsing and BAS/AER conditions are not used for ranking. | IndexingMobileVoltCoreWebVitals |
| restrictionCategories | IndexingPrivacyAccessAccessRequirements | list(String) | ||
| clicksGoodInterval | IndexingSignalAggregatorAdaptiveIntervalData | State data for AdaptiveFrequencyEstimator | float | |
| clicksGoodPriorWeight | IndexingSignalAggregatorAdaptiveIntervalData | State data for AdaptiveFrequencyEstimator | float | |
| clicksTotalInterval | IndexingSignalAggregatorAdaptiveIntervalData | State data for AdaptiveFrequencyEstimator | float | |
| clicksTotalPriorWeight | IndexingSignalAggregatorAdaptiveIntervalData | State data for AdaptiveFrequencyEstimator | float | |
| ctrwiInterval | IndexingSignalAggregatorAdaptiveIntervalData | State data for AdaptiveFrequencyEstimator | float | |
| ctrwiPriorWeight | IndexingSignalAggregatorAdaptiveIntervalData | State data for AdaptiveFrequencyEstimator | float | |
| dwellsInterval | IndexingSignalAggregatorAdaptiveIntervalData | State data for AdaptiveFrequencyEstimator | float | |
| dwellsPriorWeight | IndexingSignalAggregatorAdaptiveIntervalData | State data for AdaptiveFrequencyEstimator | float | |
| luDwellsInterval | IndexingSignalAggregatorAdaptiveIntervalData | State data for AdaptiveFrequencyEstimator | float | |
| luDwellsPriorWeight | IndexingSignalAggregatorAdaptiveIntervalData | State data for AdaptiveFrequencyEstimator | float | |
| averageChanceTime | Weighted averged timestamps of the decayed chances. | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | float |
| chances | Numbers below are all total in the decayed manner. To get rate of impression/clicks, divide by chances. | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | float |
| clicksBad | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | float | |
| clicksGood | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | float | |
| clicksImage | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | float | |
| clicksTotal | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | float | |
| clicksUnclassified | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | float | |
| coverageTimestamp | Epoch seconds at which this weighted coverage data was calculated. | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | String |
| ctrWeightedImpressions | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | float | |
| dwells | Dwells from KnowledgePanel and WebAnswers. | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | float |
| firstBaseCoverageTimestamp | Epoch seconds at which this url first gets coverage in BASE. | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | String |
| firstCoveragePagerankNs | The pagerank when the url was serving for the first time. | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | integer |
| firstCoverageTimestamp | Epoch seconds at which this url first gets coverage data. | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | String |
| firstseen | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | String | |
| impressions | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | float | |
| intervalData | Interval Data to track the average time between clicks_total, clicks_good, and ctr_weighted_impression. | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | IndexingSignalAggregatorAdaptiveIntervalData |
| language | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | integer | |
| lastDwellDateInDays | Indicates the date when this document received the last KnowledgePanel or WebAnswer dwell. Note: The date is identified in terms of number of days since Epoch. | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | integer |
| lastGoodClickDateInDays | Indicates the date when this document received the last good click. Note: The date is identified in terms of number of days since Epoch. | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | integer |
| lastImpressionDateInDays | Indicates the date when this document received the last impression. Note: The date is identified in terms of number of days since Epoch. | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | integer |
| lastLuDwellDateInDays | Indicates the date when this document received the last LocalUniversal dwell. Note: The date is identified in terms of number of days since Epoch. | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | integer |
| lastPseudoImpressionsDateInDays | Indicates the date when this document received the last pseudo-impression. I.e., when it was retrieved as a result but GWS would not show it because of the document’s age in the index. Note: The date is identified in terms of number of days since Epoch. | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | integer |
| luDwells | Dwells from LocalUniversal. | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | float |
| repid | Repid in Alexandria pipeline. | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | String |
| totalChances | Total number of chances on this urls (not decayed). | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | String |
| url | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | String | |
| urlfp | Temporary variable, only used during mapreduce. | IndexingSignalAggregatorAgeWeightedCoverageData | Accumulated coverage data for an url using a constant half-life time. Next tag: 28 | String |
| deviation | A number reflecting the deviation of Url scores. | IndexingSignalAggregatorAggregatedScore | Aggregated signal used by NumericSignalAggregator. Next field id: 25 | float |
| m2 | State variables for West & Chan variance algorithm used to be stored here directly. Now they are stored inside RunningMeanAndVarianceInternalState. | IndexingSignalAggregatorAggregatedScore | Aggregated signal used by NumericSignalAggregator. Next field id: 25 | float |
| maxScoreUrl | Input UrlScore with max score. | IndexingSignalAggregatorAggregatedScore | Aggregated signal used by NumericSignalAggregator. Next field id: 25 | IndexingSignalAggregatorUrlScore |
| mean | IndexingSignalAggregatorAggregatedScore | Aggregated signal used by NumericSignalAggregator. Next field id: 25 | float | |
| meanScore | Overall stats that are only available in final aggregation results. The aggregated score. | IndexingSignalAggregatorAggregatedScore | Aggregated signal used by NumericSignalAggregator. Next field id: 25 | float |
| minScoreUrl | Input UrlScore with min score. | IndexingSignalAggregatorAggregatedScore | Aggregated signal used by NumericSignalAggregator. Next field id: 25 | IndexingSignalAggregatorUrlScore |
| numImportantUrls | IndexingSignalAggregatorAggregatedScore | Aggregated signal used by NumericSignalAggregator. Next field id: 25 | String | |
| numUrlsMatched | Final Stats that are also available in intermediate output. Number of Urls matching the class. | IndexingSignalAggregatorAggregatedScore | Aggregated signal used by NumericSignalAggregator. Next field id: 25 | String |
| numUrlsWithSignal | Not every matching url has a signal. | IndexingSignalAggregatorAggregatedScore | Aggregated signal used by NumericSignalAggregator. Next field id: 25 | String |
| patternLayer | Experimental layer of the corresponding pattern. | IndexingSignalAggregatorAggregatedScore | Aggregated signal used by NumericSignalAggregator. Next field id: 25 | String |
| patternsUsedInMediation | Optionally populated in mediators. A list of patterns that actually contributed to the final mediated signal. | IndexingSignalAggregatorAggregatedScore | Aggregated signal used by NumericSignalAggregator. Next field id: 25 | list(String) |
| percentile | Score percentile of matching urls. If present, it has N entries for buckets of roughly equal number of urls. N is specified the aggregation. The value is the min score in that bucket. | IndexingSignalAggregatorAggregatedScore | Aggregated signal used by NumericSignalAggregator. Next field id: 25 | list(float) |
| runningMeanAndVarianceInternalState | IndexingSignalAggregatorAggregatedScore | Aggregated signal used by NumericSignalAggregator. Next field id: 25 | IndexingSignalAggregatorRunningMeanAndVarianceInternalState | |
| samples | Random samples. | IndexingSignalAggregatorAggregatedScore | Aggregated signal used by NumericSignalAggregator. Next field id: 25 | list(IndexingSignalAggregatorUrlScore) |
| scores | for calculating percentile | IndexingSignalAggregatorAggregatedScore | Aggregated signal used by NumericSignalAggregator. Next field id: 25 | list(float) |
| signalId | For debugging purposes, this is an id of the signal associated with this AggregatedScore. For pattern score, this may be the length of the pattern. | IndexingSignalAggregatorAggregatedScore | Aggregated signal used by NumericSignalAggregator. Next field id: 25 | integer |
| singleUrlScore | If this field presents, it is for a single url. No other field should appear. | IndexingSignalAggregatorAggregatedScore | Aggregated signal used by NumericSignalAggregator. Next field id: 25 | IndexingSignalAggregatorUrlScore |
| totalScore | summation varaible used to get mean | IndexingSignalAggregatorAggregatedScore | Aggregated signal used by NumericSignalAggregator. Next field id: 25 | float |
| totalScoreLow | low-order part of total_score | IndexingSignalAggregatorAggregatedScore | Aggregated signal used by NumericSignalAggregator. Next field id: 25 | float |
| totalScoreSqr | summation variable for calculating deviation note, these are now only used for legacy and debugging purposes | IndexingSignalAggregatorAggregatedScore | Aggregated signal used by NumericSignalAggregator. Next field id: 25 | float |
| totalScoreSqrLow | low order part of total_score_sq | IndexingSignalAggregatorAggregatedScore | Aggregated signal used by NumericSignalAggregator. Next field id: 25 | float |
| totalWeight | for calculating weighted mean/dev | IndexingSignalAggregatorAggregatedScore | Aggregated signal used by NumericSignalAggregator. Next field id: 25 | float |
| totalWeightLow | low order part of total_weight | IndexingSignalAggregatorAggregatedScore | Aggregated signal used by NumericSignalAggregator. Next field id: 25 | float |
| m2 | The variable which in the Wikipedia page is referred to as M_2: m2 = w_1 * (x_1 – mean)^2 + … + w_n * (x_n – mean)^2. The algorithm implemented in RunningMeanAndVarianceUtil provides a way to update m2 in a numerically stable way when the data set grows. If total_weight = 0, then m2 is meaningless, and its value is unspecified, except that it must be finite and >= 0. | IndexingSignalAggregatorRunningMeanAndVarianceInternalState | Internal state of the West & Chan running variance algorithm. Fields of this proto should not be accessed directly; instead, please use RunningMeanAndVarianceUtil. The fields of this message only have meaning in the context of the West & Chan algorithm, which is documented (or Wikipedia-linked) in the doc comments of RunningMeanAndVarianceUtil. We do however give some explanation of the meanings of these fields in the context of the algorithm (i.e. if you have the Wikipedia page open and are ready to do some math). Also see the file doc of RunningMeanAndVarianceUtil for a specification and more info about the algorithm. Notation: The data set is X = {(x_1, w_1), …, (x_n, w_n)}. It consists of n weighted data points. The ith data point has value x_i and weight w_i. REQUIRES: x_i is finite for each i. w_i is finite for each i. w_i >= 0 for each i. | float |
| mean | Mean of the data set, mean = (w_1 * x_1 + … + w_n * x_n) / total_weight. The algorithm implemented in RunningMeanAndVarianceUtil provides a way to update this mean in a numerically stable way when the data set grows. If total_weight = 0, then mean is meaningless, and its value is unspecified, except that it must be finite. | IndexingSignalAggregatorRunningMeanAndVarianceInternalState | Internal state of the West & Chan running variance algorithm. Fields of this proto should not be accessed directly; instead, please use RunningMeanAndVarianceUtil. The fields of this message only have meaning in the context of the West & Chan algorithm, which is documented (or Wikipedia-linked) in the doc comments of RunningMeanAndVarianceUtil. We do however give some explanation of the meanings of these fields in the context of the algorithm (i.e. if you have the Wikipedia page open and are ready to do some math). Also see the file doc of RunningMeanAndVarianceUtil for a specification and more info about the algorithm. Notation: The data set is X = {(x_1, w_1), …, (x_n, w_n)}. It consists of n weighted data points. The ith data point has value x_i and weight w_i. REQUIRES: x_i is finite for each i. w_i is finite for each i. w_i >= 0 for each i. | float |
| totalWeight | Total weight of the data set, total_weight = w_1 + … + w_n. | IndexingSignalAggregatorRunningMeanAndVarianceInternalState | Internal state of the West & Chan running variance algorithm. Fields of this proto should not be accessed directly; instead, please use RunningMeanAndVarianceUtil. The fields of this message only have meaning in the context of the West & Chan algorithm, which is documented (or Wikipedia-linked) in the doc comments of RunningMeanAndVarianceUtil. We do however give some explanation of the meanings of these fields in the context of the algorithm (i.e. if you have the Wikipedia page open and are ready to do some math). Also see the file doc of RunningMeanAndVarianceUtil for a specification and more info about the algorithm. Notation: The data set is X = {(x_1, w_1), …, (x_n, w_n)}. It consists of n weighted data points. The ith data point has value x_i and weight w_i. REQUIRES: x_i is finite for each i. w_i is finite for each i. w_i >= 0 for each i. | float |
| parentPattern | IndexingSignalAggregatorSccData | IndexingSignalAggregatorSccSignal | ||
| pattern | The most immediate pattern data. | IndexingSignalAggregatorSccData | IndexingSignalAggregatorSccSignal | |
| clicksBad | IndexingSignalAggregatorSccSignal | float | ||
| clicksImage | IndexingSignalAggregatorSccSignal | float | ||
| clicksTotal | IndexingSignalAggregatorSccSignal | float | ||
| debugInfo | For debugging purpose only. | IndexingSignalAggregatorSccSignal | list(String) | |
| numImageUrls | This represents the number of urls with image clicks. A url can have both image and non-image clicks, in which case we set num_image_urls to be the ratio of image_clicks vs total clicks. For example, if a url has 10 total clicks and 7 image clicks, num_image_urls will be set to 0.7. | IndexingSignalAggregatorSccSignal | float | |
| numUrls | IndexingSignalAggregatorSccSignal | String | ||
| pattern | For debugging purpose only. | IndexingSignalAggregatorSccSignal | String | |
| coverage | IndexingSignalAggregatorUrlPatternSignals | Contains only the signals necessary to perform per-URL click prediction. Used by Index Selection for scoring. NEXT ID TO USE: 7 | IndexingSignalAggregatorAgeWeightedCoverageData | |
| pagerankScore | IndexingSignalAggregatorUrlPatternSignals | Contains only the signals necessary to perform per-URL click prediction. Used by Index Selection for scoring. NEXT ID TO USE: 7 | IndexingSignalAggregatorAggregatedScore | |
| patternScore | IndexingSignalAggregatorUrlPatternSignals | Contains only the signals necessary to perform per-URL click prediction. Used by Index Selection for scoring. NEXT ID TO USE: 7 | IndexingSignalAggregatorAggregatedScore | |
| priorSignal | IndexingSignalAggregatorUrlPatternSignals | Contains only the signals necessary to perform per-URL click prediction. Used by Index Selection for scoring. NEXT ID TO USE: 7 | list(IndexingSignalAggregatorUrlPatternSignalsPriorSignal) | |
| regexpPatternScore | IndexingSignalAggregatorUrlPatternSignals | Contains only the signals necessary to perform per-URL click prediction. Used by Index Selection for scoring. NEXT ID TO USE: 7 | IndexingSignalAggregatorAggregatedScore | |
| sccData | IndexingSignalAggregatorUrlPatternSignals | Contains only the signals necessary to perform per-URL click prediction. Used by Index Selection for scoring. NEXT ID TO USE: 7 | IndexingSignalAggregatorSccData | |
| aggregatedScore | IndexingSignalAggregatorUrlPatternSignalsPriorSignal | This message provides a container for any signal used in scoring, and allows UrlPatternSignals to extend beyond (regexp_)pattern_score and pagerank_score. | IndexingSignalAggregatorAggregatedScore | |
| priorSignalId | IndexingSignalAggregatorUrlPatternSignalsPriorSignal | This message provides a container for any signal used in scoring, and allows UrlPatternSignals to extend beyond (regexp_)pattern_score and pagerank_score. | String | |
| dsacNumWeeklyPerfRecords | The number of weekly performance records if the UrlScore is extracted from the DSAC data. It should be used in case a URL is no longer served. As of 2014-10-14, this field is for the evaluation purpose only. | IndexingSignalAggregatorUrlScore | Representation of numeric signal of a url. | integer |
| eligibleExperimentalLayer | If this field is set, it indicates the url is eligible to be aggregated to one of the experimental layers. | IndexingSignalAggregatorUrlScore | Representation of numeric signal of a url. | String |
| firstServedTimestamp | The timestamp of the first time this document is served anywhere. | IndexingSignalAggregatorUrlScore | Representation of numeric signal of a url. | String |
| isImportant | Whether this url has important signal. Used for keeping patterns that match too few URLs but some of them have good clicks. | IndexingSignalAggregatorUrlScore | Representation of numeric signal of a url. | boolean |
| score | score might be missing if the url does not have signal. | IndexingSignalAggregatorUrlScore | Representation of numeric signal of a url. | float |
| url | url might be missing if we can get it from sstable key. | IndexingSignalAggregatorUrlScore | Representation of numeric signal of a url. | String |
| weight | weight for this url. | IndexingSignalAggregatorUrlScore | Representation of numeric signal of a url. | float |
| audioDuration | Duration of audio in processed fragment (including non-speech), in seconds. | IndexingSpeechSpeechPropertiesProto | The information about spoken content that’s based on purely the media resource contents (and not the embedding page or context, etc). | integer |
| audioOnly | If true, the media file is audio-only. If false, also has video track(s). | IndexingSpeechSpeechPropertiesProto | The information about spoken content that’s based on purely the media resource contents (and not the embedding page or context, etc). | boolean |
| estimatedAudioDuration | Estimated duration of audio in the whole file (including non-speech), in seconds. If this is greater than 0, then it will either be equal to audio_duration (when truncated_file is false), or to the length of the content (audio or video) according to the file header (when truncated_file is true). | IndexingSpeechSpeechPropertiesProto | The information about spoken content that’s based on purely the media resource contents (and not the embedding page or context, etc). | integer |
| estimatedAudioDurationConfidence | Our confidence in the duration estimate, on a scale from 0 (not confident) to 1 (very confident). An estimate should have a confidence of at least 0.5 if it is to be shown to users. | IndexingSpeechSpeechPropertiesProto | The information about spoken content that’s based on purely the media resource contents (and not the embedding page or context, etc). | number |
| languageCode | The spoken language, see i18n/identifiers/languagecode.h and go/gl2014. This may or may not match the language of the written page. (Examples: “en”, “sv”, “zh-CN”). | IndexingSpeechSpeechPropertiesProto | The information about spoken content that’s based on purely the media resource contents (and not the embedding page or context, etc). | String |
| numWords | Total number of recognized words in processed fragment. | IndexingSpeechSpeechPropertiesProto | The information about spoken content that’s based on purely the media resource contents (and not the embedding page or context, etc). | integer |
| recognizerAccuracy | Measure of the estimated output accuracy from the speech recognition code, from 0 to 1. Based on word-level confidence and possibly other factors. | IndexingSpeechSpeechPropertiesProto | The information about spoken content that’s based on purely the media resource contents (and not the embedding page or context, etc). | number |
| speechDuration | Duration of speech in processed fragment, in seconds. | IndexingSpeechSpeechPropertiesProto | The information about spoken content that’s based on purely the media resource contents (and not the embedding page or context, etc). | integer |
| truncatedFile | If true, we may have processed a truncated file (most likely due to a size-cutoff when crawling). As a result, the audio duration is a lower bound and the other fields reflect only the processed prefix of the file. | IndexingSpeechSpeechPropertiesProto | The information about spoken content that’s based on purely the media resource contents (and not the embedding page or context, etc). | boolean |
| features | IndexingUrlPatternUrlTreeBigTreeBranch | Representing a dominating branch of the URL tree. | IndexingUrlPatternUrlTreeUrlFeatures | |
| patternId | The fingerprint of the features string. | IndexingUrlPatternUrlTreeBigTreeBranch | Representing a dominating branch of the URL tree. | String |
| payload | IndexingUrlPatternUrlTreeBigTreeBranch | Representing a dominating branch of the URL tree. | Proto2BridgeMessageSet | |
| fingerprint | IndexingUrlPatternUrlTreeUrlFeature | String | ||
| fingerprintWithGroupInType | If consider position when calculating fingerprint of url feature. | IndexingUrlPatternUrlTreeUrlFeature | boolean | |
| groupInType | Used together w/ type field to group features, for finding features with too many possible values. | IndexingUrlPatternUrlTreeUrlFeature | String | |
| type | IndexingUrlPatternUrlTreeUrlFeature | String | ||
| value | IndexingUrlPatternUrlTreeUrlFeature | String | ||
| feature | IndexingUrlPatternUrlTreeUrlFeatures | list(IndexingUrlPatternUrlTreeUrlFeature) | ||
| bigBranch | Keeping information for dominating branches separately, to prevent docs on smaller branches from being dropping during sampling. | IndexingUrlPatternUrlTreeUrlTree | list(IndexingUrlPatternUrlTreeBigTreeBranch) | |
| debugInfo | IndexingUrlPatternUrlTreeUrlTree | IndexingUrlPatternUrlTreeUrlTreeDebugInfo | ||
| key | IndexingUrlPatternUrlTreeUrlTree | IndexingUrlPatternUrlTreeUrlTreeKey | ||
| node | node(0) is root. | IndexingUrlPatternUrlTreeUrlTree | list(IndexingUrlPatternUrlTreeUrlTreeNode) | |
| retrievalTimestamp | Used in url pattern matcher for cache invalidation. | IndexingUrlPatternUrlTreeUrlTree | integer | |
| site | The key for this UrlTree, also will be the key in sstable. The old format is site, while the new format will be UrlTreeKey. Only one field can be set in the same time for site and key. | IndexingUrlPatternUrlTreeUrlTree | String | |
| timestamp | The time when this UrlTree is built, encoded as seconds past the epoch (Jan 1, 1970). | IndexingUrlPatternUrlTreeUrlTree | integer | |
| treeInfo | Any additional information. | IndexingUrlPatternUrlTreeUrlTree | Proto2BridgeMessageSet | |
| innerSimilarity | IndexingUrlPatternUrlTreeUrlTreeDebugInfo | float | ||
| crawlerId | IndexingUrlPatternUrlTreeUrlTreeKey | A UID of URL Tree. There is a hash function and a equality function for UrlTreeKey in //indexing/url_pattern/url_tree/util/url-tree-key-util.h. When adding or deprecating a field in this proto, please also update the hash function and the equality function. LINT.IfChange | String | |
| domain | IndexingUrlPatternUrlTreeUrlTreeKey | A UID of URL Tree. There is a hash function and a equality function for UrlTreeKey in //indexing/url_pattern/url_tree/util/url-tree-key-util.h. When adding or deprecating a field in this proto, please also update the hash function and the equality function. LINT.IfChange | String | |
| hostname | IndexingUrlPatternUrlTreeUrlTreeKey | A UID of URL Tree. There is a hash function and a equality function for UrlTreeKey in //indexing/url_pattern/url_tree/util/url-tree-key-util.h. When adding or deprecating a field in this proto, please also update the hash function and the equality function. LINT.IfChange | String | |
| indexOfSubTreeWithSplittingFeature | IndexingUrlPatternUrlTreeUrlTreeNode | integer | ||
| indexOfSubTreeWithoutSplittingFeature | IndexingUrlPatternUrlTreeUrlTreeNode | integer | ||
| parent | IndexingUrlPatternUrlTreeUrlTreeNode | integer | ||
| pathFromRoot | The path from root to current node. This is only used for debugging. | IndexingUrlPatternUrlTreeUrlTreeNode | String | |
| patternId | This is only used in leaf nodes which represents a url pattern. It is the fingerprint of the splitting url features from root to the leaf. | IndexingUrlPatternUrlTreeUrlTreeNode | String | |
| payload | IndexingUrlPatternUrlTreeUrlTreeNode | Proto2BridgeMessageSet | ||
| splittingFeature | IndexingUrlPatternUrlTreeUrlTreeNode | IndexingUrlPatternUrlTreeUrlFeature | ||
| splittingFeatureScore | The information gain of content features when selecting this splitting feature to split the node. | IndexingUrlPatternUrlTreeUrlTreeNode | float | |
| gibberishResult | IndexingVideosAsrTranscriptRepairAnnotation | This proto captures the output of analyses that ran on Automatic Speech Recogntion produced by the recognizer. | String | |
| numGibberishSegments | The number of the above segments that were classified as gibberish. | IndexingVideosAsrTranscriptRepairAnnotation | This proto captures the output of analyses that ran on Automatic Speech Recogntion produced by the recognizer. | integer |
| numSegmentsClassified | The number of ASR segments that were sent for classification. | IndexingVideosAsrTranscriptRepairAnnotation | This proto captures the output of analyses that ran on Automatic Speech Recogntion produced by the recognizer. | integer |
| KaltixRank | approx. 2 bytes for top 1B | KaltixPerDocData | integer | |
| LocalKaltixRank | empty for now | KaltixPerDocData | integer | |
| SiteKaltixRank | empty for now | KaltixPerDocData | integer | |
| regionType | The particular type of region should be explicitly set to disambiguate. | KeGovernanceTypedRegions | Wrapper message containing list of regions and their corresponding type of region signal to use in data governance. | String |
| regions | Values are go/iii RegionCode in capital case. It is a good practice to keep elements in this list unique, although not enforced. In case of duplicated entries, they’ll be treated as if there were only one entry of the same value. | KeGovernanceTypedRegions | Wrapper message containing list of regions and their corresponding type of region signal to use in data governance. | list(String) |
| componentSpecificContracts | Contains data about the contracts that this ValueType level is available for. For more information see go/contract-based-conformance. | KnowledgeAnswersAnyType | Accepts any non-empty value. This is meant for special cases allowing any value or any composition to be valid in a slot. If you are thinking of using this, please contact mrf-team@. | NlpMeaningComponentSpecificContracts |
| remodelings | Contains data about current schema remodelings at this ValueType level. For more information see go/meaning-remodeling-framework. | KnowledgeAnswersAnyType | Accepts any non-empty value. This is meant for special cases allowing any value or any composition to be valid in a slot. If you are thinking of using this, please contact mrf-team@. | NlpMeaningMeaningRemodelings |
| attribute | Use in parsing: the value filled with must be in the list of this. If no attribute ids are specified, this value can be filled with any attribute. | KnowledgeAnswersAttributeType | An attribute type configures a value whose type is intended to be a attribute defined in the schema. | list(String) |
| componentSpecificContracts | Contains data about the contracts that this ValueType level is available for. For more information see go/contract-based-conformance. | KnowledgeAnswersAttributeType | An attribute type configures a value whose type is intended to be a attribute defined in the schema. | NlpMeaningComponentSpecificContracts |
| pivotEntitySlot | If exist, the attribute will be applied on the given pivot slot. This helps type checking when qrewrite constructs function calls with an attribute-typed slot. | KnowledgeAnswersAttributeType | An attribute type configures a value whose type is intended to be a attribute defined in the schema. | String |
| remodelings | Contains data about current schema remodelings at this ValueType level. For more information see go/meaning-remodeling-framework. | KnowledgeAnswersAttributeType | An attribute type configures a value whose type is intended to be a attribute defined in the schema. | NlpMeaningMeaningRemodelings |
| componentSpecificContracts | Contains data about the contracts that this ValueType level is available for. For more information see go/contract-based-conformance. | KnowledgeAnswersBooleanType | A BooleanType configures a yes/no value. | NlpMeaningComponentSpecificContracts |
| remodelings | Contains data about current schema remodelings at this ValueType level. For more information see go/meaning-remodeling-framework. | KnowledgeAnswersBooleanType | A BooleanType configures a yes/no value. | NlpMeaningMeaningRemodelings |
| collection | The collection this value is filled with must be one of these collections (denoted by a /collection/* id). If no collections are specified, this value can be filled with any collection. | KnowledgeAnswersCollectionType | A CollectionType configures a value whose type is intended to be a collection. | list(String) |
| componentSpecificContracts | Contains data about the contracts that this ValueType level is available for. For more information see go/contract-based-conformance. | KnowledgeAnswersCollectionType | A CollectionType configures a value whose type is intended to be a collection. | NlpMeaningComponentSpecificContracts |
| remodelings | Contains data about current schema remodelings at this ValueType level. For more information see go/meaning-remodeling-framework. | KnowledgeAnswersCollectionType | A CollectionType configures a value whose type is intended to be a collection. | NlpMeaningMeaningRemodelings |
| componentSpecificContracts | Contains data about the contracts that this ValueType level is available for. For more information see go/contract-based-conformance. | KnowledgeAnswersCompoundType | A CompoundType configures a value composed of multiple answer values. | NlpMeaningComponentSpecificContracts |
| remodelings | Contains data about current schema remodelings at this ValueType level. For more information see go/meaning-remodeling-framework. | KnowledgeAnswersCompoundType | A CompoundType configures a value composed of multiple answer values. | NlpMeaningMeaningRemodelings |
| slotNames | KnowledgeAnswersContainerType | list(String) | ||
| allowAllRangeResolutions | If true, will allow all resolutions that are ranges. | KnowledgeAnswersDateType | A DateType configures a value whose type is intended to be a date. LINT.IfChange Next id: 17 | boolean |
| allowAllResolutions | If true, overrides all other options in this message and allows any kind of DateTime annotation. | KnowledgeAnswersDateType | A DateType configures a value whose type is intended to be a date. LINT.IfChange Next id: 17 | boolean |
| allowAllResolutionsExceptHolidays | If true, will allow all resolutions except holidays. | KnowledgeAnswersDateType | A DateType configures a value whose type is intended to be a date. LINT.IfChange Next id: 17 | boolean |
| allowAllResolutionsWithout4digit24hrTime | If true, will allow resolutions that aren’t contiguous sequences of 4 digits annotated as 24-hr times. These are often mis-interpreted years or postcodes. | KnowledgeAnswersDateType | A DateType configures a value whose type is intended to be a date. LINT.IfChange Next id: 17 | boolean |
| allowAllResolutionsWithoutTime | If true, will allow resolutions without an explicit hour. Symbolic ranges such as [this evening] are not considered as explicit hour, but the range [1-3pm] is considered as explicit. | KnowledgeAnswersDateType | A DateType configures a value whose type is intended to be a date. LINT.IfChange Next id: 17 | boolean |
| allowDayResolution | If true, will parse a mention to DateTime of resolution day. This allows parsing strings like “August 30th”, “2012-12-25”; | KnowledgeAnswersDateType | A DateType configures a value whose type is intended to be a date. LINT.IfChange Next id: 17 | boolean |
| allowDayResolutionExceptHolidaysOrOrdinal | If true, will allow day resolutions except holidays or ordinal numbers, such as “today”, “December 13”, but “Christmas”, “first” are not allowed. | KnowledgeAnswersDateType | A DateType configures a value whose type is intended to be a date. LINT.IfChange Next id: 17 | boolean |
| allowHourResolution | If true, will allow resolutions with an explicit hour such as “8am”, “5pm”. | KnowledgeAnswersDateType | A DateType configures a value whose type is intended to be a date. LINT.IfChange Next id: 17 | boolean |
| allowMonthResolution | If true, will parse a mention to DateTime of resolution month. This allows parsing strings like “this August”, “2012-12”; | KnowledgeAnswersDateType | A DateType configures a value whose type is intended to be a date. LINT.IfChange Next id: 17 | boolean |
| allowNowResolution | If true, will allow “now” resolutions, but not any other time | KnowledgeAnswersDateType | A DateType configures a value whose type is intended to be a date. LINT.IfChange Next id: 17 | boolean |
| allowSymbolicTime | If true, will allow symbolic time resolutions such as “tonight”. | KnowledgeAnswersDateType | A DateType configures a value whose type is intended to be a date. LINT.IfChange Next id: 17 | boolean |
| allowTimeResolutionsWithoutExplicitTimezone | If true, will allow time resolutions without an explicit timezone. | KnowledgeAnswersDateType | A DateType configures a value whose type is intended to be a date. LINT.IfChange Next id: 17 | boolean |
| allowYearResolution | If true, will parse a mention to DateTime of resolution year. This allows parsing strings like “Next year “, “2010”; | KnowledgeAnswersDateType | A DateType configures a value whose type is intended to be a date. LINT.IfChange Next id: 17 | boolean |
| componentSpecificContracts | Contains data about the contracts that this ValueType level is available for. For more information see go/contract-based-conformance. | KnowledgeAnswersDateType | A DateType configures a value whose type is intended to be a date. LINT.IfChange Next id: 17 | NlpMeaningComponentSpecificContracts |
| remodelings | Contains data about current schema remodelings at this ValueType level. For more information see go/meaning-remodeling-framework. | KnowledgeAnswersDateType | A DateType configures a value whose type is intended to be a date. LINT.IfChange Next id: 17 | NlpMeaningMeaningRemodelings |
| subType | KnowledgeAnswersDateType | A DateType configures a value whose type is intended to be a date. LINT.IfChange Next id: 17 | String | |
| componentSpecificContracts | Contains data about the contracts that this ValueType level is available for. For more information see go/contract-based-conformance. | KnowledgeAnswersDependencyType | NlpMeaningComponentSpecificContracts | |
| containerType | KnowledgeAnswersDependencyType | KnowledgeAnswersContainerType | ||
| intersectType | KnowledgeAnswersDependencyType | KnowledgeAnswersIntersectType | ||
| remodelings | Contains data about current schema remodelings at this ValueType level. For more information see go/meaning-remodeling-framework. | KnowledgeAnswersDependencyType | NlpMeaningMeaningRemodelings | |
| sameType | KnowledgeAnswersDependencyType | KnowledgeAnswersSameType | ||
| unionType | KnowledgeAnswersDependencyType | KnowledgeAnswersUnionType | ||
| refersToFullMrf | True iff this ReferentialResolution is part of an intent and refers to the full MRF subtree (rather than just the intent). | KnowledgeAnswersDialogReferentialResolution | How a piece of data was resolved through external data (either elsewhere in the query, or from a previous query). Examples: [obama and his age] -> “his” is resolved from the Obama entity obama -> “he” is resolved from the Obama entity starbucks -> Q2 is resolved from the list of shops | boolean |
| resolutionType | KnowledgeAnswersDialogReferentialResolution | How a piece of data was resolved through external data (either elsewhere in the query, or from a previous query). Examples: [obama and his age] -> “his” is resolved from the Obama entity obama -> “he” is resolved from the Obama entity starbucks -> Q2 is resolved from the list of shops | String | |
| componentSpecificContracts | Contains data about the contracts that this ValueType level is available for. For more information see go/contract-based-conformance. | KnowledgeAnswersDurationType | A DurationType configures a value whose type is a duration. | NlpMeaningComponentSpecificContracts |
| rangeConstraint | Range constraint limits the set of durations accepted. The values of the range are in milliseconds. Currently, this constraint is only enforced in Loose Parser. | KnowledgeAnswersDurationType | A DurationType configures a value whose type is a duration. | KnowledgeAnswersRangeConstraint |
| remodelings | Contains data about current schema remodelings at this ValueType level. For more information see go/meaning-remodeling-framework. | KnowledgeAnswersDurationType | A DurationType configures a value whose type is a duration. | NlpMeaningMeaningRemodelings |
| collection | This field specifies that containing entity must be: – in *any* ‘collection’ if ‘in_all_collections’ is false (default) – in *every* ‘collection’ if ‘in_all_collections’ is true. The collection field contains strings of the form ‘/collection/’. If no collections are specified, this value can be filled with any entity. A collection specified as an empty string has a special meaning for Aqua induction, which is that the type includes all entities. | KnowledgeAnswersEntityType | An EntityType configures a value whose type is intended to be an entity. Entities may be specified using either the collection(s) to which they belong, or explicitly via a list of KG-ids. Both collections and ids can be specified, in which case the type will be the union of the id(s) and all mids within the collection(s). Next available tag: 10 | list(String) |
| componentSpecificContracts | Contains data about the contracts that this ValueType level is available for. For more information see go/contract-based-conformance. | KnowledgeAnswersEntityType | An EntityType configures a value whose type is intended to be an entity. Entities may be specified using either the collection(s) to which they belong, or explicitly via a list of KG-ids. Both collections and ids can be specified, in which case the type will be the union of the id(s) and all mids within the collection(s). Next available tag: 10 | NlpMeaningComponentSpecificContracts |
| excludedCollection | The entity that this value is filled with must not be any of these collections (denoted by a /collection/* id). This restriction does not affect parsing; it is used only to filter attributes in the extraction flow. | KnowledgeAnswersEntityType | An EntityType configures a value whose type is intended to be an entity. Entities may be specified using either the collection(s) to which they belong, or explicitly via a list of KG-ids. Both collections and ids can be specified, in which case the type will be the union of the id(s) and all mids within the collection(s). Next available tag: 10 | list(String) |
| id | The entity that this value is filled with must be one of the following explicitly specified KG-ids. | KnowledgeAnswersEntityType | An EntityType configures a value whose type is intended to be an entity. Entities may be specified using either the collection(s) to which they belong, or explicitly via a list of KG-ids. Both collections and ids can be specified, in which case the type will be the union of the id(s) and all mids within the collection(s). Next available tag: 10 | list(String) |
| identifier | The entity that this value is filled with must be of the explicit type and/or contain the explicitly specified id. This field can not be used for kg mids, which should directly use the id field above. | KnowledgeAnswersEntityType | An EntityType configures a value whose type is intended to be an entity. Entities may be specified using either the collection(s) to which they belong, or explicitly via a list of KG-ids. Both collections and ids can be specified, in which case the type will be the union of the id(s) and all mids within the collection(s). Next available tag: 10 | list(KnowledgeAnswersIntentQueryIdentifier) |
| inAllCollections | KnowledgeAnswersEntityType | An EntityType configures a value whose type is intended to be an entity. Entities may be specified using either the collection(s) to which they belong, or explicitly via a list of KG-ids. Both collections and ids can be specified, in which case the type will be the union of the id(s) and all mids within the collection(s). Next available tag: 10 | boolean | |
| includeGeolocationData | If this is set to true for a slot and the entity is a location, the latitude and longitude will be available in variables $SlotName_Latitude and $SlotName_Longitude, respectively. The latitude and longitude data comes from KG. | KnowledgeAnswersEntityType | An EntityType configures a value whose type is intended to be an entity. Entities may be specified using either the collection(s) to which they belong, or explicitly via a list of KG-ids. Both collections and ids can be specified, in which case the type will be the union of the id(s) and all mids within the collection(s). Next available tag: 10 | boolean |
| remodelings | Contains data about current schema remodelings at this ValueType level. For more information see go/meaning-remodeling-framework. | KnowledgeAnswersEntityType | An EntityType configures a value whose type is intended to be an entity. Entities may be specified using either the collection(s) to which they belong, or explicitly via a list of KG-ids. Both collections and ids can be specified, in which case the type will be the union of the id(s) and all mids within the collection(s). Next available tag: 10 | NlpMeaningMeaningRemodelings |
| facetName | Optional, as this can take the name of the slot/schema its associated with or it might need to map onto something different. | KnowledgeAnswersFacetParsing | Construct for how to construe a facet when parse from neural or lexical models. Unlike regular intent annotations, facets are post-hoc grounded to indicated spoans, so they also need to provide their input and output slot independently. | String |
| inputSlotName | Required, the slot into which we put any ungrounded string or mid | KnowledgeAnswersFacetParsing | Construct for how to construe a facet when parse from neural or lexical models. Unlike regular intent annotations, facets are post-hoc grounded to indicated spoans, so they also need to provide their input and output slot independently. | String |
| outputSlotName | Optional, if absent output_type will be used for typing, or this is a MRF operator | KnowledgeAnswersFacetParsing | Construct for how to construe a facet when parse from neural or lexical models. Unlike regular intent annotations, facets are post-hoc grounded to indicated spoans, so they also need to provide their input and output slot independently. | String |
| alternateLanguage | Language of all of the non-annotation tokens of the query interpretation, if it is different than |language|. This can happen with English smearing, e.g. [height rousseau] will trigger as “fr” when issued in fr/FR, but really the language is “en”. This can also happen when we have extra information about the language model, e.g. language=”zh”, alternate_language=”zh-Hant”. | KnowledgeAnswersIntentModifiers | Modifiers decorate a Meaning Expression (i.e. intent FunctionCall) with signals that depend on the source language’s grammar and syntax. See go/intent-modifiers for details. NOTE: Modifiers don’t necessarily impact go/intent-resolution semantics. LINT.IfChange | String |
| definiteness | KnowledgeAnswersIntentModifiers | Modifiers decorate a Meaning Expression (i.e. intent FunctionCall) with signals that depend on the source language’s grammar and syntax. See go/intent-modifiers for details. NOTE: Modifiers don’t necessarily impact go/intent-resolution semantics. LINT.IfChange | String | |
| language | Language of parsed query. | KnowledgeAnswersIntentModifiers | Modifiers decorate a Meaning Expression (i.e. intent FunctionCall) with signals that depend on the source language’s grammar and syntax. See go/intent-modifiers for details. NOTE: Modifiers don’t necessarily impact go/intent-resolution semantics. LINT.IfChange | String |
| mood | Since there’s only IMPERATIVE, consider using Marker.command instead. | KnowledgeAnswersIntentModifiers | Modifiers decorate a Meaning Expression (i.e. intent FunctionCall) with signals that depend on the source language’s grammar and syntax. See go/intent-modifiers for details. NOTE: Modifiers don’t necessarily impact go/intent-resolution semantics. LINT.IfChange | String |
| plurality | KnowledgeAnswersIntentModifiers | Modifiers decorate a Meaning Expression (i.e. intent FunctionCall) with signals that depend on the source language’s grammar and syntax. See go/intent-modifiers for details. NOTE: Modifiers don’t necessarily impact go/intent-resolution semantics. LINT.IfChange | String | |
| polarQuestion | Whether or not the question is a polar (yes/no) question. | KnowledgeAnswersIntentModifiers | Modifiers decorate a Meaning Expression (i.e. intent FunctionCall) with signals that depend on the source language’s grammar and syntax. See go/intent-modifiers for details. NOTE: Modifiers don’t necessarily impact go/intent-resolution semantics. LINT.IfChange | boolean |
| sentiment | Sentiment analysis attached to an intent implies the sentiment user expressed behind that query. This is generated by the Empathetic Servlet in the QRewrite. | KnowledgeAnswersIntentModifiers | Modifiers decorate a Meaning Expression (i.e. intent FunctionCall) with signals that depend on the source language’s grammar and syntax. See go/intent-modifiers for details. NOTE: Modifiers don’t necessarily impact go/intent-resolution semantics. LINT.IfChange | SentimentSentiment |
| tense | KnowledgeAnswersIntentModifiers | Modifiers decorate a Meaning Expression (i.e. intent FunctionCall) with signals that depend on the source language’s grammar and syntax. See go/intent-modifiers for details. NOTE: Modifiers don’t necessarily impact go/intent-resolution semantics. LINT.IfChange | String | |
| customVehicleActionArgumentAnnotatorSignals | KnowledgeAnswersIntentQueryAnnotationLayerSignals | Signals coming from the Annotation Layer of TUIG. See more details at http://go/unified-intent-generation-apis. | KnowledgeAnswersIntentQueryCustomVehicleActionArgumentAnnotatorSignals | |
| freetextAnnotationSignals | KnowledgeAnswersIntentQueryAnnotationLayerSignals | Signals coming from the Annotation Layer of TUIG. See more details at http://go/unified-intent-generation-apis. | KnowledgeAnswersIntentQueryFreetextAnnotationSignals | |
| nimbleAnnotationSignals | KnowledgeAnswersIntentQueryAnnotationLayerSignals | Signals coming from the Annotation Layer of TUIG. See more details at http://go/unified-intent-generation-apis. | KnowledgeAnswersIntentQueryNimbleAnnotationSignals | |
| ntprAnnotationSignals | KnowledgeAnswersIntentQueryAnnotationLayerSignals | Signals coming from the Annotation Layer of TUIG. See more details at http://go/unified-intent-generation-apis. | KnowledgeAnswersIntentQueryNTPRAnnotationSignals | |
| qrefAnnotationSignals | KnowledgeAnswersIntentQueryAnnotationLayerSignals | Signals coming from the Annotation Layer of TUIG. See more details at http://go/unified-intent-generation-apis. | KnowledgeAnswersIntentQueryQrefAnnotationSignals | |
| semanticAnnotationSignals | KnowledgeAnswersIntentQueryAnnotationLayerSignals | Signals coming from the Annotation Layer of TUIG. See more details at http://go/unified-intent-generation-apis. | KnowledgeAnswersIntentQuerySemanticAnnotationSignals | |
| teleportArgumentAnnotatorSignals | KnowledgeAnswersIntentQueryAnnotationLayerSignals | Signals coming from the Annotation Layer of TUIG. See more details at http://go/unified-intent-generation-apis. | KnowledgeAnswersIntentQueryTeleportArgumentAnnotatorSignals | |
| components | KnowledgeAnswersIntentQueryArgPath | list(KnowledgeAnswersIntentQueryArgPathComponent) | ||
| argName | KnowledgeAnswersIntentQueryArgPathComponent | LINT.IfChange(ArgPath) Given a FunctionCall and an Argument somewhere in it, an ArgPath is a list of name-index pairs that uniquely determines the path down to that Argument. For each pair, the |index|, starting from zero, distinguishes between “sibling” (i.e. belonging to the same sub-FunctionCall) Arguments with the same name. For example, given the following FunctionCall: A(X=D(W=5), Z=B(Z=6), Z=C(Y=7)) The path to the Z=6 argument is {{“Z”, 0}, {“Z”, 0}} It’s the first of two Z “siblings” under A, then the only Z under B. The path to the Y=7 argument is {{“Z”, 1}, {“Y”, 0}} It’s the second of two Z “siblings” under A, then the only Y under C. The path to the Z=B(…) argument is {{“Z”, 0}} It’s the first of two Z “siblings” under A. | String | |
| index | KnowledgeAnswersIntentQueryArgPathComponent | LINT.IfChange(ArgPath) Given a FunctionCall and an Argument somewhere in it, an ArgPath is a list of name-index pairs that uniquely determines the path down to that Argument. For each pair, the |index|, starting from zero, distinguishes between “sibling” (i.e. belonging to the same sub-FunctionCall) Arguments with the same name. For example, given the following FunctionCall: A(X=D(W=5), Z=B(Z=6), Z=C(Y=7)) The path to the Z=6 argument is {{“Z”, 0}, {“Z”, 0}} It’s the first of two Z “siblings” under A, then the only Z under B. The path to the Y=7 argument is {{“Z”, 1}, {“Y”, 0}} It’s the second of two Z “siblings” under A, then the only Y under C. The path to the Z=B(…) argument is {{“Z”, 0}} It’s the first of two Z “siblings” under A. | integer | |
| evalData | This field is used inside Aqua and outside Aqua for identifying the token indices and/or byte offsets of this argument | KnowledgeAnswersIntentQueryArgument | A message representing the function argument. Next ID: 9 Important: If you add new fields that do not reflect signals data, but actual semantics of the FunctionCall, please also update CreateFuncallCopyWithoutSignals and CreateFuncallCopyWithArgumentSignals in function_call_utils. LINT.IfChange | NlpSemanticParsingAnnotationEvalData |
| heuristicEvalData | Eval_data was not derived at parsing time (i.e. is not expected to be produced by the IG), but heuristically determined by matching the ArgumentValue to an annotation/query fragment. | KnowledgeAnswersIntentQueryArgument | A message representing the function argument. Next ID: 9 Important: If you add new fields that do not reflect signals data, but actual semantics of the FunctionCall, please also update CreateFuncallCopyWithoutSignals and CreateFuncallCopyWithArgumentSignals in function_call_utils. LINT.IfChange | NlpSemanticParsingAnnotationEvalData |
| key | Slot schema key for this Argument. Note: This is still under development and not available for general use. Contact meaning-platform-eng@ for questions. Note: Currently MeaningSchemaSlotKey proto has both mid and unique_id. In future, only mid will be present in it. We are in the process of moving “unique_id” out of it. See (b/168907943). Note: The logged version of intent_query will only have “mid” populated in it to save space and avoid data duplication. | KnowledgeAnswersIntentQueryArgument | A message representing the function argument. Next ID: 9 Important: If you add new fields that do not reflect signals data, but actual semantics of the FunctionCall, please also update CreateFuncallCopyWithoutSignals and CreateFuncallCopyWithArgumentSignals in function_call_utils. LINT.IfChange | KnowledgeAnswersMeaningSchemaSlotKey |
| modifiers | A flattened representation of all intent modifiers that apply to this argument. | KnowledgeAnswersIntentQueryArgument | A message representing the function argument. Next ID: 9 Important: If you add new fields that do not reflect signals data, but actual semantics of the FunctionCall, please also update CreateFuncallCopyWithoutSignals and CreateFuncallCopyWithArgumentSignals in function_call_utils. LINT.IfChange | KnowledgeAnswersIntentModifiers |
| name | Name of this argument. If this Argument is part of a FunctionCall, it must have a name or it is not well-formed. If this Argument is from an Annotator, the name field should be empty. | KnowledgeAnswersIntentQueryArgument | A message representing the function argument. Next ID: 9 Important: If you add new fields that do not reflect signals data, but actual semantics of the FunctionCall, please also update CreateFuncallCopyWithoutSignals and CreateFuncallCopyWithArgumentSignals in function_call_utils. LINT.IfChange | String |
| signals | Signals associated with this argument. | KnowledgeAnswersIntentQueryArgument | A message representing the function argument. Next ID: 9 Important: If you add new fields that do not reflect signals data, but actual semantics of the FunctionCall, please also update CreateFuncallCopyWithoutSignals and CreateFuncallCopyWithArgumentSignals in function_call_utils. LINT.IfChange | KnowledgeAnswersIntentQueryArgumentSignals |
| value | The value of this argument. | KnowledgeAnswersIntentQueryArgument | A message representing the function argument. Next ID: 9 Important: If you add new fields that do not reflect signals data, but actual semantics of the FunctionCall, please also update CreateFuncallCopyWithoutSignals and CreateFuncallCopyWithArgumentSignals in function_call_utils. LINT.IfChange | KnowledgeAnswersIntentQueryArgumentValue |
| anaphor | If populated, the current query contains an anaphor that refers to the value. For example: U: Weather in Paris. [Weather(location=paris)] G: 65 degrees and sunny. U: How many people live there? [Population(city=paris)] The “there” in the current query would have the “anaphor” field set. NOTE: after a string rewrite this field will not be populated anymore if the rewrite replaced the anaphor with the corresponding value. For example, if we rewrite [How many people there] to [How many people in Paris], the CurrentQuerySignals for “paris” will not contain an “anaphor” message anymore in the following turns. It will only contain an eval_data for the span that corresponds to “paris” in the query. | KnowledgeAnswersIntentQueryArgumentProvenance | NextId: 11 | KnowledgeAnswersIntentQueryArgumentProvenanceQueryAnaphor |
| attentionalEntity | KnowledgeAnswersIntentQueryArgumentProvenance | NextId: 11 | KnowledgeAnswersIntentQueryArgumentProvenanceAttentionalEntity | |
| currentQuery | NOTE: PreviousQuery is used for values that originate directly from QRef entities annotated in the user query. AttentionalEntity is used for values that come from the system (entities published by a dialog). These values could also originate from an entity annotated by QRef in the query, but this is not necessarily the case. SearchAnswerValue is used for values that come from the system as part of the answer of the user query. For example: U: Wife of Barack Obama G: Barack Obama’s wife is Michelle Obama Here “Barack Obama” can have an ArgumentProvenance of PreviousQuery, or AttentionalEntity if a dialog publishes that entity and the interpretation pulls the value from it. “Michelle Obama” can have an ArgumentProvenance of SearchAnswerValue, or AttentionalEntity if the dialog publishes that entity and the interpretation pulls the value it. | KnowledgeAnswersIntentQueryArgumentProvenance | NextId: 11 | KnowledgeAnswersIntentQueryArgumentProvenanceCurrentQuery |
| injectedContextualSchema | KnowledgeAnswersIntentQueryArgumentProvenance | NextId: 11 | KnowledgeAnswersIntentQueryArgumentProvenanceInjectedContextualSchema | |
| previousQuery | KnowledgeAnswersIntentQueryArgumentProvenance | NextId: 11 | KnowledgeAnswersIntentQueryArgumentProvenancePreviousQuery | |
| previousResponseMeaning | KnowledgeAnswersIntentQueryArgumentProvenance | NextId: 11 | KnowledgeAnswersIntentQueryArgumentProvenancePreviousResponseMeaning | |
| previousTaskState | KnowledgeAnswersIntentQueryArgumentProvenance | NextId: 11 | KnowledgeAnswersIntentQueryArgumentProvenancePreviousTaskState | |
| searchAnswerValue | KnowledgeAnswersIntentQueryArgumentProvenance | NextId: 11 | KnowledgeAnswersIntentQueryArgumentProvenanceSearchAnswerValue | |
| attentionalEntityKey | This key can be used to recover the attentional entity from the corresponding attentional_entities::EntityCache. | KnowledgeAnswersIntentQueryArgumentProvenanceAttentionalEntity | The value is carried over from an attentional entity. For example, in a dialog about a movie that publishes an attentional entity for /m/matrix: U: What is the cast. [Cast(location=/m/matrix)] G: The cast includes Keanu Reeves and others. U: Great, buy some tickets. [BuyTickets(movie=/m/matrix)] On the second user query, the “movie” argument would have a provenance of ATTENTIONAL_ENTITY. | String |
| mentionProperties | Source information from the AttentionalEntityReader. | KnowledgeAnswersIntentQueryArgumentProvenanceAttentionalEntity | The value is carried over from an attentional entity. For example, in a dialog about a movie that publishes an attentional entity for /m/matrix: U: What is the cast. [Cast(location=/m/matrix)] G: The cast includes Keanu Reeves and others. U: Great, buy some tickets. [BuyTickets(movie=/m/matrix)] On the second user query, the “movie” argument would have a provenance of ATTENTIONAL_ENTITY. | AttentionalEntitiesMentionProperties |
| evalData | The span(s) in the query where the value comes from. Note that if the argument is split across the current and previous query, this message should *NOT* be populated. Please use PreviousQuery below, populating it’s eval-data fields accordingly. | KnowledgeAnswersIntentQueryArgumentProvenanceCurrentQuery | NOTE: These comments should stay in sync with the comments in logs/proto/knowledge/interpretation/intent_query.proto LINT.IfChange The argument comes from the current query. For example: U: Book a hotel in Paris. [BookHotel(location=/m/paris)] The “location” argument would have a provenance of CURRENT_QUERY. | list(NlpSemanticParsingAnnotationEvalData) |
| neuralLocationAnnotator | KnowledgeAnswersIntentQueryArgumentProvenanceCurrentQuery | NOTE: These comments should stay in sync with the comments in logs/proto/knowledge/interpretation/intent_query.proto LINT.IfChange The argument comes from the current query. For example: U: Book a hotel in Paris. [BookHotel(location=/m/paris)] The “location” argument would have a provenance of CURRENT_QUERY. | KnowledgeAnswersIntentQueryArgumentProvenanceNeuralLocationAnnotator | |
| currentQueryEvalData | The span(s) in the current query where the value comes from. This is used when the argument spans both the current and previous query. Eg jfk death -> [death, when] spans both queries. | KnowledgeAnswersIntentQueryArgumentProvenancePreviousQuery | The value is carried over from either the previous winning IntentQuery or an entity annotated by QRef in a previous query. For example: U: How old is Obama. [Age(person=/m/obama)] G: Barack Obama is 56 years old. U: Who is his wife. [Spouse(person=/m/obama)] The “person” argument would have a provenance of PREVIOUS_QUERY. However, if a dialog publishes an attentional entity for “Obama”, the “person” argument can have a provenance of ATTENTIONAL_ENTITY instead. This includes arguments with provenance that spans both the current and previous query. | list(NlpSemanticParsingAnnotationEvalData) |
| evalData | The span(s) in the query where the value comes from. | KnowledgeAnswersIntentQueryArgumentProvenancePreviousQuery | The value is carried over from either the previous winning IntentQuery or an entity annotated by QRef in a previous query. For example: U: How old is Obama. [Age(person=/m/obama)] G: Barack Obama is 56 years old. U: Who is his wife. [Spouse(person=/m/obama)] The “person” argument would have a provenance of PREVIOUS_QUERY. However, if a dialog publishes an attentional entity for “Obama”, the “person” argument can have a provenance of ATTENTIONAL_ENTITY instead. This includes arguments with provenance that spans both the current and previous query. | list(NlpSemanticParsingAnnotationEvalData) |
| eventId | The event ID of the query where this value was pulled from. | KnowledgeAnswersIntentQueryArgumentProvenancePreviousQuery | The value is carried over from either the previous winning IntentQuery or an entity annotated by QRef in a previous query. For example: U: How old is Obama. [Age(person=/m/obama)] G: Barack Obama is 56 years old. U: Who is his wife. [Spouse(person=/m/obama)] The “person” argument would have a provenance of PREVIOUS_QUERY. However, if a dialog publishes an attentional entity for “Obama”, the “person” argument can have a provenance of ATTENTIONAL_ENTITY instead. This includes arguments with provenance that spans both the current and previous query. | EventIdMessage |
| neuralLocationAnnotator | KnowledgeAnswersIntentQueryArgumentProvenancePreviousQuery | The value is carried over from either the previous winning IntentQuery or an entity annotated by QRef in a previous query. For example: U: How old is Obama. [Age(person=/m/obama)] G: Barack Obama is 56 years old. U: Who is his wife. [Spouse(person=/m/obama)] The “person” argument would have a provenance of PREVIOUS_QUERY. However, if a dialog publishes an attentional entity for “Obama”, the “person” argument can have a provenance of ATTENTIONAL_ENTITY instead. This includes arguments with provenance that spans both the current and previous query. | KnowledgeAnswersIntentQueryArgumentProvenanceNeuralLocationAnnotator | |
| role | KnowledgeAnswersIntentQueryArgumentProvenancePreviousQuery | The value is carried over from either the previous winning IntentQuery or an entity annotated by QRef in a previous query. For example: U: How old is Obama. [Age(person=/m/obama)] G: Barack Obama is 56 years old. U: Who is his wife. [Spouse(person=/m/obama)] The “person” argument would have a provenance of PREVIOUS_QUERY. However, if a dialog publishes an attentional entity for “Obama”, the “person” argument can have a provenance of ATTENTIONAL_ENTITY instead. This includes arguments with provenance that spans both the current and previous query. | KnowledgeAnswersIntentQueryArgumentProvenancePreviousQueryRole | |
| source | KnowledgeAnswersIntentQueryArgumentProvenancePreviousQuery | The value is carried over from either the previous winning IntentQuery or an entity annotated by QRef in a previous query. For example: U: How old is Obama. [Age(person=/m/obama)] G: Barack Obama is 56 years old. U: Who is his wife. [Spouse(person=/m/obama)] The “person” argument would have a provenance of PREVIOUS_QUERY. However, if a dialog publishes an attentional entity for “Obama”, the “person” argument can have a provenance of ATTENTIONAL_ENTITY instead. This includes arguments with provenance that spans both the current and previous query. | String | |
| intentId | KnowledgeAnswersIntentQueryArgumentProvenancePreviousQueryRole | The role that this data played in the previous query. | String | |
| slotName | KnowledgeAnswersIntentQueryArgumentProvenancePreviousQueryRole | The role that this data played in the previous query. | String | |
| argumentName | Argument names in the DialogIntentState that the argument corresponds to. This is repeated so it can handle complex argument update paths. (ordered from outermost argument to innermost argument) | KnowledgeAnswersIntentQueryArgumentProvenancePreviousTaskState | Value is derived from previous task state (go/taskstates). | list(String) |
| currentQueryEvalData | The span(s) in the current query (if any) used to resolve the previous query’s DIS. Example: U: Barack Obama G: Do you want his age or his height? U: The first one. G: Age(/m/obama) In this example, the intent is derived from the previous query’s DIS, but also needs to be resolved in the current query since the user was presented with multiple options. | KnowledgeAnswersIntentQueryArgumentProvenancePreviousTaskState | Value is derived from previous task state (go/taskstates). | list(NlpSemanticParsingAnnotationEvalData) |
| dialogIntentStateId | The id of the specific DialogIntentState instance that the argument corresponds to. | KnowledgeAnswersIntentQueryArgumentProvenancePreviousTaskState | Value is derived from previous task state (go/taskstates). | String |
| intentName | Intent name of the DialogIntentState that the argument corresponds to. | KnowledgeAnswersIntentQueryArgumentProvenancePreviousTaskState | Value is derived from previous task state (go/taskstates). | String |
| listCandidate | KnowledgeAnswersIntentQueryArgumentProvenancePreviousTaskState | Value is derived from previous task state (go/taskstates). | KnowledgeAnswersIntentQueryArgumentProvenancePreviousTaskStateListCandidate | |
| previousFunctionCall | KnowledgeAnswersIntentQueryArgumentProvenancePreviousTaskState | Value is derived from previous task state (go/taskstates). | KnowledgeAnswersIntentQueryArgumentProvenancePreviousTaskStatePreviousFunctionCall | |
| candidateIndex | The presented_index of the field_candidate in the DialogIntentState field_signals that the argument corresponds to. | KnowledgeAnswersIntentQueryArgumentProvenancePreviousTaskStateListCandidate | The value is carried over from a field_candidate in a DialogIntentState. For example: U: Send a message to John. G: Which John do you want to message? U: John A. [ListPresentationIntent(contact_disambiguation.person=0)] On the second user query, the “contact_disambiguation.person” argument would have a provenance of PREVIOUS_TASK_STATE_LIST_CANDIDATE. | integer |
| evalData | If populated, the spans in the current query where this value was annotated. This is a repeated field because some values can be annotated from a set of discontiguous spans (e.g. some intent phrases), but in most cases this field will contain only one item or it will be empty (for values inferred from context without the use of anaphora). | KnowledgeAnswersIntentQueryArgumentProvenanceQueryAnaphor | Signals about an anaphor in the query: for example an occurrence of the pronoun “it”. | list(NlpSemanticParsingAnnotationEvalData) |
| eventId | This identifies the SearchAnswerValues where this value was pulled from. | KnowledgeAnswersIntentQueryArgumentProvenanceSearchAnswerValue | The value was carried over from a SearchAnswerValue triggered by a previous query (go/search-answer-values). For example: U: Movies with Tom Cruise. [Movies(actor=/m/tom_cruise)] G: Tom Cruise’s movies include Top Gun, The Mummy, and 52 others. U: Reviews for the second one. [Reviews(movie=/m/the_mummy)] The “movie” argument in the last query would have a provenance of SEARCH_ANSWER_VALUE. | EventIdMessage |
| metadataValueIndex | Each SearchAnswerValue can have a primary value and a list of metadata values. If this index is set, this value was pulled from the metadata value at this index, otherwise it was pulled from the primary value. | KnowledgeAnswersIntentQueryArgumentProvenanceSearchAnswerValue | The value was carried over from a SearchAnswerValue triggered by a previous query (go/search-answer-values). For example: U: Movies with Tom Cruise. [Movies(actor=/m/tom_cruise)] G: Tom Cruise’s movies include Top Gun, The Mummy, and 52 others. U: Reviews for the second one. [Reviews(movie=/m/the_mummy)] The “movie” argument in the last query would have a provenance of SEARCH_ANSWER_VALUE. | integer |
| text | The display text of this answer value. It’s taken from the search answer value display text if present, or the canonical name if it’s an entity. | KnowledgeAnswersIntentQueryArgumentProvenanceSearchAnswerValue | The value was carried over from a SearchAnswerValue triggered by a previous query (go/search-answer-values). For example: U: Movies with Tom Cruise. [Movies(actor=/m/tom_cruise)] G: Tom Cruise’s movies include Top Gun, The Mummy, and 52 others. U: Reviews for the second one. [Reviews(movie=/m/the_mummy)] The “movie” argument in the last query would have a provenance of SEARCH_ANSWER_VALUE. | String |
| valueIndex | The index of the SearchAnswerValue where this value was pulled from. | KnowledgeAnswersIntentQueryArgumentProvenanceSearchAnswerValue | The value was carried over from a SearchAnswerValue triggered by a previous query (go/search-answer-values). For example: U: Movies with Tom Cruise. [Movies(actor=/m/tom_cruise)] G: Tom Cruise’s movies include Top Gun, The Mummy, and 52 others. U: Reviews for the second one. [Reviews(movie=/m/the_mummy)] The “movie” argument in the last query would have a provenance of SEARCH_ANSWER_VALUE. | integer |
| gaiaId | The gaia id for the entity (person or plus page). | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | String |
| expressionStatus | Status indicating whether the user has completely expressed the semantics of the argument. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | NlpSemanticParsingExpressionStatus |
| deprecatedSupportingMid | A list of mids that “support” this argument in voting, i.e., results that support these mids will be treated as if they support the argument. This field has been deprecated in favor of related_entity. b/27363861 | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | list(String) |
| onDeviceAnnotationSignals | Additional signals for on-device annotations. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | KnowledgeAnswersIntentQueryOnDeviceAnnotationSignals |
| ungroundedValueType | Type of ungrounded argument. It is exclusively used when simple_value.ungrounded_value is populated. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | KnowledgeAnswersValueType |
| isIntentgenAnnotation | Whether this argument was annotated by Intentgen QUIK model (go/intentgen-quik) | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | boolean |
| locationClassificationScore | Confidence score of this argument being a location. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | float |
| allowedFuzzyMatch | For this argument, backend performed fuzzy match. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | boolean |
| isEvalDataHeuristic | Set when the eval_data was not derived at parsing time, but heuristically determined by matching the ArgumentValue to an annotation/query fragment. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | boolean |
| supportTransferSignals | Support Transfer signals for this entity. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | KnowledgeAnswersIntentQuerySupportTransferSignals |
| deprecatedFreebaseType | If the literal.obj_type of the argument value is ID (Entity), this represents freebase types of the entity in this argument. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | list(String) |
| rawQueryText | A copy of the span of canonical (raw) parser input text corresponding to this annotation. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | String |
| isEnum | Set when the argument has an enum value – a normalized_string_type from the intent catalog. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | boolean |
| supportTransferRules | go/stbr supportthis is an | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | list(LogsSemanticInterpretationIntentQuerySupportTransferRule) |
| qrefInterpretationIndex | The index of the QueryJoin interpretation from which this annotation is taken. We copy over the value given by nlp.semantic_parsing.annotators.QrefAnnotator. The value will be “-1” if the annotation is coming from low confidence Qref annotations. NOTE – this is generated from as QRef’s interetation_number. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | integer |
| relatednessSignals | Relatedness Matrix signals about this argument, e.g., query_popularity. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | KnowledgeAnswersIntentQueryRelatednessSignals |
| locationType | The type category for the location stored in this Argument, if it exists. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | String |
| mergedImpliedEntity | List of QRef implied entities merged into this entity during parsing. Clients should not rely on the order, as it is derivation-dependent. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | list(KnowledgeAnswersIntentQueryImpliedEntity) |
| multipleHorizontalListSelectionMatches | Whether there were multiple equally good matches from horizontal_list_selection. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | boolean |
| midEquivalentToCollection | For collection arguments, it is useful to save what was the original mid that qref annotated. For example, if the collection is /collection/films, we’ll have the mid for /en/film here (/m/02vxn). | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | String |
| saftSignals | Signals derived from SAFT. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | KnowledgeAnswersIntentQuerySaftSignals |
| relatedEntity | List of entities that are semantically related to the argument as well as details of the relationship. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | list(NlpSemanticParsingRelatedEntity) |
| personalEntity | Personal entities are compound entities made up of entities and their attributes, where the entities can be compound too. E.g., “my father’s mother” can have a summary node annotation of “Mother(Father(Myself))” | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | list(KnowledgeAnswersIntentQueryPersonalEntity) |
| resolvedFromPronoun | Whether this argument was resolved from a pronoun mention in the query. Eg: [how old was obama when *he* became president] | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | boolean |
| chainId | One or more ChainIds from a ChainAnnotation whose “organization_mid” matches the MID. As of 2021-01 multiple chain_ids may be specified if the organization for MID controls multiple chains. See go/chains-lckp-robust-triggering for motivation. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | list(LocalsearchChainId) |
| addedByCloseAnswers | Whether this argument was added by CloseAnswers in Postref. This bit is used to mark the corresponding interpretation/intent query as such by setting is_close_interpretation bit. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | boolean |
| location | Entity location information (latitude/longitude) from freebase. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | GeostorePointProto |
| groundingSignals | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | KnowledgeAnswersIntentQueryGroundingSignals | |
| personalQrefReferenceScore | The confidence (in [0, 1]) that the annotation is a reference that implies another entity (e.g., “my hotel” in “navigate to my hotel” is a reference to an explicit hotel from the user’s hotel reservations). | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | number |
| mediaEntitySignals | Signals about the media entity for this argument. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | KnowledgeAnswersIntentQueryMediaEntitySignals |
| collectionMembership | If the literal.obj_type of the argument value is ID (Entity), this represents the collection that the entity in this argument is a member of. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | list(KnowledgeAnswersIntentQueryCollectionMembership) |
| locationMarkersSignals | The usual semantic role associated with the signal from lightweight tokens attached to this argument span. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | KnowledgeAnswersIntentQueryLocationMarkersSignals |
| source | What added this argument. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | String |
| clusterInfo | If the literal.obj_type of the argument value is ID (Entity), this stores cluster scoring information for that entity, if the entity belongs to a cluster. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | QualityViewsExtractionClusterInfo |
| qrefConfidenceScore | The QRef confidence score for an entity argument. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | number |
| isGenieAnnotation | Whether this annotation was propagated as part of a Genie rewrite (go/genie-aqua). | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | boolean |
| resolvedFromContext | Whether this argument was resolved through context from a previous query. Examples: obama -> “he” is resolved from the Obama entity starbucks -> Q2 is resolved from the list of shops | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | boolean |
| valueSource | What added the argument value. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | String |
| webrefListSource | This represents which list entities index refers to. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | String |
| isDefaultValue | If true, the value of the argument is populated with the default value specified by the system if the value can’t be inferred from the input query. In IntentConfig case, the default value is specified by using IntentConfig.slot.default_value. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | boolean |
| parsedDueToExperiment | Experiment ID for experiments that were used to parse this FunctionCall. Empty indicates no experiments used. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | list(String) |
| facet | If this slot was transformed from or could be transformed to a facet on a categorical, that information is stored here. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | KnowledgeAnswersFacetParsing |
| isNimbleAnnotation | Whether this argument was annotated by nimble (go/nimble-annotator) | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | boolean |
| fromSymbolAnnotation | Whether the argument entity comes from a graphic symbol annotation. This is later used as a heuristic for poor web result quality. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | boolean |
| entityNumber | Signals about what other entities this entity implies / is implied by. This is useful for grounding. Example: b/138388207: suppressing song intents if the artist entity doesn’t link to the song title. This value specifies the order of annotations in a QRef annotation chain so they can refer to each other. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | integer |
| copleySourceTypeList | Contains the source and type information related to a personal entity, for example if it is a hotel or a restaurant (type) and if it comes from Gmail, Calendar, etc. (source). | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | CopleySourceTypeList |
| webrefEntitiesIndex | Webref entity index for this argument, necessary for interpreting the relationship structure, and the list to index into. Specifically we need this to understand qref implications since they edges are represented with entity indexes. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | integer |
| entityRelationship | Signals about what other entities this entity implies / is implied by. This is useful for grounding. Example: b/138388207: suppressing song intents if the artist entity doesn’t link to the song title. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | list(NlpSemanticParsingQRefAnnotationEntityRelationship) |
| muninSignals | Signals derived from Munin Function call annotations. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | KnowledgeAnswersIntentQueryMuninSignals |
| shoppingIds | Equivalent shopping ids for the argument. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | KnowledgeAnswersIntentQueryShoppingIds |
| responseMeaningSignals | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | KnowledgeAnswersIntentQueryResponseMeaningSignalsResponseMeaningSignals | |
| contextResolution | How this argument was resolved through context from a previous query. Examples: obama -> “he” is resolved from the Obama entity starbucks -> Q2 is resolved from the list of shops (Attentional Entities) | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | String |
| annotationLayerSignals | Signals to facilitate orchestration of TUIG annotations. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | KnowledgeAnswersIntentQueryAnnotationLayerSignals |
| annotatedRelationship | Relationships between entities | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | list(LogsSemanticInterpretationIntentQueryWebrefEntityRelationship) |
| personalQrefResolutionScore | The confidence (in [0, 1]) that the annotation was created on an implicit mention (e.g., “my hotel”) as opposed to an explicit mention (e.g., “the westin copley square”). | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | number |
| resultSupport | The list of result supports for this Argument. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | list(UniversalsearchNewPackerKnowledgeResultSupport) |
| isAUngroundedTypeOf | If the argument is entity, the ungrounded type the entity is. For example, the entity argument is /m/0p83l (Jasmine), the value of this field should be “Plant” if it is present. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | String |
| oysterId | The oyster feature id. NOTE: As of Mar 2017, the cell ID field of the feature ID might not be set. See http://b/35447230#comment10 | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | GeostoreFeatureIdProto |
| provenance | Information about where the value of this argument came from. For example, it could have been explicitly provided in the query, pulled in from the previous state, or pulled from attentional entities. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | list(KnowledgeAnswersIntentQueryArgumentProvenance) |
| fromManualSymbolAnnotation | Whether the argument entity comes from a manual graphic symbol annotation. This is later used as a heuristic for poor web result quality. | KnowledgeAnswersIntentQueryArgumentSignals | A message representing the signals associated with an argument. NEXT ID TO USE: 66 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, fields under Argument.signals in the serving proto are stored directly under Argument on the logging side. For example, see http://google3/nlp/semantic_parsing/data_management/logs/web_logs/semantic_logging_converters/semantic_logging_request_argument_converter.cc?l=58&rcl=322925428. LINT.IfChange | boolean |
| complexQueriesRewrite | Custom type used by Complex Queries. This is populated based on the output of the RPC to the Complex Queries Boq node. | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | QualityGenieComplexQueriesComplexQueriesOutputRewrite |
| audio | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | NlpSemanticParsingModelsMediaAudio | |
| appAnnotation | Device actions custom types. | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | NlpSemanticParsingAppAnnotation |
| calendarReference | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | QualityQrewriteCalendarReference | |
| scalarValue | A scalar value with optional unit; used ONLY for resolved values after grounding. | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | KnowledgeAnswersIntentQueryScalarValue |
| componentReference | Component reference between WebrefEntity and Mention. This should only ever be set in argument values in WebrefEntities (e.g. in a QueryJoin). The processing expectation is that the value including the component reference is discarded altogether and replaced by reference target. Use QueryJoinToMeaningStructConverter to perform the replacement. An example value parallel to this reference may exist, but it’s meant purely for human consumption and should not be used. | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | RepositoryWebrefComponentReference |
| timer | Productivity custom types. Team: go/productivity-assistance. | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | QualityActionsTimer |
| money | Represents: money expressions (e.g. 25$). Annotated by: number subgrammar. | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | NlpSemanticParsingModelsMoneyMoney |
| dateTime | *** Opaque types that are likely to become fully supported: *** Represents: date and time expressions. Annotated by: datetime subgrammar. | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | NlpSemanticParsingDatetimeDateTime |
| productivityListItem | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | AssistantProductivityListItem | |
| funcall | *** Fully supported types *** An argument can also be a function call. | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | KnowledgeAnswersIntentQueryFunctionCall |
| deviceId | DeviceId custom types. Details in go/reply-broadcast | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | AssistantApiCoreTypesDeviceId |
| recurrence | Represents: intervals of recurrence for repeated tasks. See go/recurrence-subgrammar Annotated by: recurrence subgrammar. | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | NlpSemanticParsingModelsRecurrence |
| shoppingOffer | Shopping custom types. See go/sopa-attentional. | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | NlpSemanticParsingModelsShoppingAssistantOffer |
| sensitiveValue | Sensitive value, see go/sensitive-intents and go/a4w-multi-turn-dialog | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | KnowledgeAnswersIntentQuerySensitiveArgumentValueGuard |
| shoppingMerchant | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | NlpSemanticParsingModelsShoppingAssistantMerchant | |
| deviceUserIdentity | DeviceUserIdentity custom types. Details in go/reply-broadcast | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | AssistantApiCoreTypesDeviceUserIdentity |
| location | Represents: location expressions. Annotated by: location subgrammar. | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | NlpSemanticParsingLocalLocation |
| shoppingProduct | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | NlpSemanticParsingModelsShoppingAssistantProduct | |
| calendarEvent | Calendar custom types. Details in go/cal-ref. | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | AssistantApiCoreTypesCalendarEvent |
| media | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | NlpSemanticParsingModelsMediaMediaAnnotation | |
| homeAutomationDevice | HomeAutomation custom types. Details in go/smarthome_with_monastery. | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | AssistantVerticalsHomeautomationProtoHomeAutomationDevice |
| shoppingProductExpression | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | NlpSemanticParsingModelsShoppingAssistantProductExpression | |
| simpleValue | When literal is a datetime, it’s really just an ISO 8601 datetime string. This case will eventually be replaced with the date_time field, which is more expressive and can also represent recurrences, ranges, etc. Likewise, simple_value will replace the other types of simple values that literal is currently being used to represent. | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | KnowledgeAnswersIntentQuerySimpleValue |
| sensitivity | Argument level query sensitivities. 1) Statically defined Sensitivity is copied from IntentSlot at serving time so it can be propagated along with FunctionCall to places where the Intent Catalog is not available. See go/sensitive-intents for details. 2) For the same reason, contextual sensitivites (eg., from AttentionalEntity mentions) are populated here too. See go/tagging-sensitive-ae for details. | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | list(KnowledgeAnswersSensitivitySensitivity) |
| duration | Represents: duration expressions (e.g. 5 minutes). Annotated by: datetime subgrammar. | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | NlpSemanticParsingDatetimeDuration |
| onDevice | OnDevice custom types. Device on which an intent should be fulfilled. Differs semantically from device fields used by Media and HomeAutomation: this is annotated by the on_device subgrammar, and will not output any metadata beyond what the subgrammar outputs. See go/on_device_induction_quality. | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | NlpSemanticParsingModelsOnDevice |
| messageNotification | Custom type used by tap-to-read for embedding a MessageNotification message in a GetMessageContent intent. | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | AssistantApiCoreTypesMessageNotification |
| coreference | A value that is a coreference or variable binding to some other part of the tree. See go/mrf-variables. | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | KnowledgeAnswersIntentQueryCoreference |
| narrativeNewsProvider | Custom type used by NarrativeNews. This is populated by the narrative news provider annotator, and it differs semantically from a mid for a news brand in that it doesn’t refer to the field of widely known news brands but rather but to the specific audio news RSS feeds that the narrative news feature serves. (There is of course substantial overlap between those two concepts) | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | NlpSemanticParsingModelsNarrativeNewsNewsProvider |
| reminder | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | QualityActionsReminder | |
| device | Media custom types. For example use, see go/valyrian-media-dd. | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | NlpSemanticParsingModelsMediaCastDeviceAnnotation |
| calendarEventWrapper | Details in go/multi-account-event-representation. | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | AssistantApiCoreTypesCalendarEventWrapper |
| number | Represents: number expressions. Annotated by: number subgrammar. | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | NlpSemanticParsingNumberNumber |
| shoppingStore | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | NlpSemanticParsingModelsShoppingAssistantStore | |
| aogSlot | Custom type used by actions-on-google in-dialog queries. See go/3p-custom-intents-wrt-meaning-catalog | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | NlpSemanticParsingProtoActionsOnGoogleAogSlot |
| personalIntelligenceEntity | Entity parsed from manual grammar interpretation in the Personal Intelligence domain. | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | NlpSemanticParsingPersonalIntelligenceEntity |
| person | Represents: structured person names, including common names and personal contacts. Annotated by: go/person-subgrammar. | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | NlpSemanticParsingModelsPersonPerson |
| timezone | Represents: timezone expressions (e.g. Eastern Daylight Time). Annotated by: datetime subgrammar. | KnowledgeAnswersIntentQueryArgumentValue | A message representing the value of an argument. All types in the “value” oneof should have a corresponding field in the ValueType or OpaqueType protos defined in knowledge/answers/config/value.proto. This is specified by annotating each ArgumentValue type with options of the form (value_type_name) = A unit test ensure that this field is set and is valid for all types in ArgumentValue. A small number of special cases (such as funcall and simple_value) are allowed to omit the annotation. See intent_query_proto_test.cc for details. Note: If you are trying to add a new OpaqueType, stop; OpaqueType is deprecated, refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. Next Id: 42 | NlpSemanticParsingDatetimeTimeZone |
| attributeId | KnowledgeAnswersIntentQueryAttributeSignal | Contains an attribute id and it’s completion score. | String | |
| score | KnowledgeAnswersIntentQueryAttributeSignal | Contains an attribute id and it’s completion score. | number | |
| collectionId | Human readable id of the collection. | KnowledgeAnswersIntentQueryCollectionMembership | A message representing the collection membership of an entity. | String |
| collectionMid | Identifier of the collection, usually a MID (/m/xyz or /g/zyw). | KnowledgeAnswersIntentQueryCollectionMembership | A message representing the collection membership of an entity. | String |
| collectionScore | The collection score for a entity. | KnowledgeAnswersIntentQueryCollectionMembership | A message representing the collection membership of an entity. | number |
| score | Different types of scores for the collection. Each score type has at most one score. | KnowledgeAnswersIntentQueryCollectionMembership | A message representing the collection membership of an entity. | list(KnowledgeAnswersIntentQueryCollectionScore) |
| scoreType | KnowledgeAnswersIntentQueryCollectionScore | String | ||
| scoreValue | KnowledgeAnswersIntentQueryCollectionScore | number | ||
| id | KnowledgeAnswersIntentQueryConceptInfo | Concept provides meaning semantics captured in a continuous space, as opposed to MRF. go/concepts-roofshot. | ConceptsConceptId | |
| dataEpochId | Concepts data epoch used to annotate the queries. | KnowledgeAnswersIntentQueryConceptSignals | Signal data for associated Concepts (go/concept-roofshot). | integer |
| argPath | A coreference is represented by an argument path starting from the root of the whole tree to the referenced value. | KnowledgeAnswersIntentQueryCoreference | A message representing a coreferenced value defined elsewhere in the meaning struct. | KnowledgeAnswersIntentQueryArgPath |
| additionalAnnotationData | Stores any additional data which is required only at the intent fulfilment phase. | KnowledgeAnswersIntentQueryCustomVehicleActionArgumentAnnotatorSignals | Signals associated with CustomVehicleActionArgumentAnnotator annotations. | map |
| argument | A list of arguments of this function call. | KnowledgeAnswersIntentQueryFunctionCall | A message representing the function call of an answers intent query. Next ID: 21 Important: If you add new fields that do not reflect signals data, but actual semantics of the FunctionCall, please also update CreateFuncallCopyWithoutSignals and CreateFuncallCopyWithArgumentSignals in function_call_utils. LINT.IfChange | list(KnowledgeAnswersIntentQueryArgument) |
| catalogVersion | The corresponding meaning catalog version that was used to generate this FunctionCall. | KnowledgeAnswersIntentQueryFunctionCall | A message representing the function call of an answers intent query. Next ID: 21 Important: If you add new fields that do not reflect signals data, but actual semantics of the FunctionCall, please also update CreateFuncallCopyWithoutSignals and CreateFuncallCopyWithArgumentSignals in function_call_utils. LINT.IfChange | String |
| conceptInfo | Information about the corresponding Concept for this MRF Expression. For more details see go/concepts-roofshot. | KnowledgeAnswersIntentQueryFunctionCall | A message representing the function call of an answers intent query. Next ID: 21 Important: If you add new fields that do not reflect signals data, but actual semantics of the FunctionCall, please also update CreateFuncallCopyWithoutSignals and CreateFuncallCopyWithArgumentSignals in function_call_utils. LINT.IfChange | KnowledgeAnswersIntentQueryConceptInfo |
| contextualSensitivity | Contextual Sensitivity (go/contextual-sensitivity) metadata indicating that a policy- or privacy- sensitive conversation context (previous queries, rewritten user queries, and previous system responses, like attentional entities) is used to generate this FunctionCall. This needs propagation (1) from Interp to DialogIntentState (DIS) (see b/148479837) and (2) from QRewrite/QUS down to Assistant Server’s memory finalizer. One can use knowledge/answers/sensitivity/sensitivity_reader.h to parse this proto. NOTE(b/149091449): This is part of the migration of contextual sensitivity protos from Interp sensitivity extension. (nlp::semantic_parsing::sensitivity) to this proto field. See the bug to track the migration progress and for more details. | KnowledgeAnswersIntentQueryFunctionCall | A message representing the function call of an answers intent query. Next ID: 21 Important: If you add new fields that do not reflect signals data, but actual semantics of the FunctionCall, please also update CreateFuncallCopyWithoutSignals and CreateFuncallCopyWithArgumentSignals in function_call_utils. LINT.IfChange | list(KnowledgeAnswersSensitivitySensitivity) |
| enabledRemodelings | Contains data about which remodelings are being used for this funcall. For more information see go/meaning-remodeling-framework. | KnowledgeAnswersIntentQueryFunctionCall | A message representing the function call of an answers intent query. Next ID: 21 Important: If you add new fields that do not reflect signals data, but actual semantics of the FunctionCall, please also update CreateFuncallCopyWithoutSignals and CreateFuncallCopyWithArgumentSignals in function_call_utils. LINT.IfChange | NlpMeaningMeaningRemodelingControl |
| ignoredTokens | A list of token lists that were ignored during parsing because they are known context phrases for this interpretation. For example, for query [tell me how tall height of Obama really], assuming “tell me”, “tall”, “of”, “really” are explained and thus ignored, with corresponding prior 0.9, 0.8, 0.7, 0.6, following ignored tokens will be populated: { ignored_tokens { token { ngram: “tell me”, prior: 0.9} score: 0.9 } ignored_tokens { token { ngram: “tall”, prior: 0.8} token { ngram: “of”, prior: 0.7} score: 0.56 // currently score = prior1 * prior2 * … * prior N } ignored_tokens { token { ngram: “really”, prior: 0.6} score: 0.6 } } These tokens can serve two purpose: 1) debug info to show why an interpretation is generated; 2) carry the signals for downstream usage. Note: This field is under active development, and significant changes could happen. Please contact porky-pig@ if you want to use it. | KnowledgeAnswersIntentQueryFunctionCall | A message representing the function call of an answers intent query. Next ID: 21 Important: If you add new fields that do not reflect signals data, but actual semantics of the FunctionCall, please also update CreateFuncallCopyWithoutSignals and CreateFuncallCopyWithArgumentSignals in function_call_utils. LINT.IfChange | list(KnowledgeAnswersIntentQueryTokens) |
| key | The primary key for this FunctionCall. Note: This is still under development and not available for general use. Contact meaning-platform-eng@ for questions. | KnowledgeAnswersIntentQueryFunctionCall | A message representing the function call of an answers intent query. Next ID: 21 Important: If you add new fields that do not reflect signals data, but actual semantics of the FunctionCall, please also update CreateFuncallCopyWithoutSignals and CreateFuncallCopyWithArgumentSignals in function_call_utils. LINT.IfChange | KnowledgeAnswersMeaningSchemaKey |
| marker | The marker specifies the purpose of this meaning struct / function call: Is it asking a question, and if yes, for which slot(s)? Is it a command, statement, etc? This corresponds to a (very coarse) notion of dialog acts. In the absence of this field, it will be inferred using the following algorithm (subject to marker applicability rules specified in marker.proto, see also go/requested-slots): 1) Use the underlying Meaning Schema’s default marker, if applicable. 2) Assume that the Meaning Struct is polar or a statement. The presence of a marker will affect the value type of this function call. | KnowledgeAnswersIntentQueryFunctionCall | A message representing the function call of an answers intent query. Next ID: 21 Important: If you add new fields that do not reflect signals data, but actual semantics of the FunctionCall, please also update CreateFuncallCopyWithoutSignals and CreateFuncallCopyWithArgumentSignals in function_call_utils. LINT.IfChange | KnowledgeAnswersMarker |
| modifiers | A flattened representation of all intent modifiers that apply to this function call. | KnowledgeAnswersIntentQueryFunctionCall | A message representing the function call of an answers intent query. Next ID: 21 Important: If you add new fields that do not reflect signals data, but actual semantics of the FunctionCall, please also update CreateFuncallCopyWithoutSignals and CreateFuncallCopyWithArgumentSignals in function_call_utils. LINT.IfChange | KnowledgeAnswersIntentModifiers |
| name | Name of this function call. The name must be present. If it is omitted, the FunctionCall is not well-formed. | KnowledgeAnswersIntentQueryFunctionCall | A message representing the function call of an answers intent query. Next ID: 21 Important: If you add new fields that do not reflect signals data, but actual semantics of the FunctionCall, please also update CreateFuncallCopyWithoutSignals and CreateFuncallCopyWithArgumentSignals in function_call_utils. LINT.IfChange | String |
| sensitivity | Intent level query sensitivity (go/sensitive-intents). This metadata comes directly from Intent Catalog, indicating a single-shot query sensitivity without putting context into considerations. Therefore, this requires a one-to-one match with each intent registered in Intent Catalog. | KnowledgeAnswersIntentQueryFunctionCall | A message representing the function call of an answers intent query. Next ID: 21 Important: If you add new fields that do not reflect signals data, but actual semantics of the FunctionCall, please also update CreateFuncallCopyWithoutSignals and CreateFuncallCopyWithArgumentSignals in function_call_utils. LINT.IfChange | KnowledgeAnswersSensitivitySensitivity |
| signals | Signals at the function call level | KnowledgeAnswersIntentQueryFunctionCall | A message representing the function call of an answers intent query. Next ID: 21 Important: If you add new fields that do not reflect signals data, but actual semantics of the FunctionCall, please also update CreateFuncallCopyWithoutSignals and CreateFuncallCopyWithArgumentSignals in function_call_utils. LINT.IfChange | KnowledgeAnswersIntentQueryFunctionCallSignals |
| unexplainedTokens | A list of tokens that were ignored during parsing that cannot be explained by context phrases. | KnowledgeAnswersIntentQueryFunctionCall | A message representing the function call of an answers intent query. Next ID: 21 Important: If you add new fields that do not reflect signals data, but actual semantics of the FunctionCall, please also update CreateFuncallCopyWithoutSignals and CreateFuncallCopyWithArgumentSignals in function_call_utils. LINT.IfChange | list(KnowledgeAnswersIntentQueryTokens) |
| intentAnnotationSources | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | list(String) | |
| expressionStatus | Status indicating whether the user has completely expressed their intended semantics. (See go/streaming-nlu-fulfilment-protocol-v1 for more info. ) | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | NlpSemanticParsingExpressionStatus |
| attributeSignals | The attributes from which this intent was generated during execution of AttributeSignalsProvider. |attribute_signals| is only populated for single entity funcalls. | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | list(KnowledgeAnswersIntentQueryAttributeSignal) |
| isRefinedMeaning | Whether the FunctionCall is created as a refined_meaning in resolution. Downstream code will look at this field to see if it needs to create a new refined QueryInterpretation. | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | boolean |
| argumentComposingMid | The argument mid that was used to compose the entity for a concept interpretation, along with the intent_composing_mid (one of the intent’s equivalent MIDs). | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | String |
| role | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | String | |
| isCloseInterpretation | Whether the interpretation was generated using similar queries in POSTREF. In case POSTREF_AQUA generated the same entity-attribute interpretation, this is still set to true. | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | boolean |
| prefulfillmentSignals | All the input signals to the Prefulfillment Ranker. | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | AssistantPrefulfillmentRankerPrefulfillmentSignals |
| dedupedFuncalls | FunctionCall-s that this funcall was deduped against. | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | list(KnowledgeAnswersIntentQueryFunctionCall) |
| localSignals | Information about Local results to be used in the Packer for Local Categorical derived intent deduplication and conformance. | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | KnowledgeAnswersIntentQueryLocalSignals |
| isDisambiguationIntent | Denotes whether this is a sub-intent of an ambiguous SystemUncertain intent go/intent-disambiguation. | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | boolean |
| intentProvenance | Information about where the value of this intent came from. For example, it could have been explicitly provided in the query, pulled in from the previous dialog state, or pulled from previous queries. | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | list(KnowledgeAnswersIntentQueryArgumentProvenance) |
| highConfidence | Used to indicate that an interpretation is high confidence and triggers different voting behavior. This bit should only be set for verticals. DEPRECATED. Use confidence_level instead. | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | boolean |
| conceptEntityMid | An entity that represents the concept of an entity-attribute intent by being composed of an intent equivalent MID and the argument MID. | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | String |
| selectedByPrefulfillmentRanking | Identifies whether the Prefulfillment Ranker selected this intent for emission. This is needed temporarily while migrating intent emitters from ACE to QUS/PFR. See go/pfr-intent-emitter for more info | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | boolean |
| freefolksTrigger | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | String | |
| conceptSignals | Information about the corresponding Concept attached to the FunctionCall. go/concept-roofshot. | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | KnowledgeAnswersIntentQueryConceptSignals |
| groundingSignals | Grounding signals for ranking/filtering, as well as whether to use Grounding Box and PGRP in AnswersRewriter. See comment on GroundingSignals for details. | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | KnowledgeAnswersIntentQueryGroundingSignals |
| refxSummaryNodeId | The id of the summary node if this funcall represents an mdvc interpretation | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | String |
| signalsFallbackIntents | Additional intents to be used for intent scoring. This field must only be populated when we cannot find a single unified intent. For example, when we compute signals for a LocalEntities function call, this means we could not find a unified intent to capture all the local results. In this case, we add a fallback intent for each local result (e.g. GeoSchool, GeoRestaurant, and GeoBank if those are the results we show). | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | list(KnowledgeAnswersIntentQuerySignalComputationFallbackIntent) |
| isDisambiguationCardIntent | Denotes whether this is an intent being fulfilled from user tapping a disambiguation card. More info in go/cardea-deck. | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | boolean |
| prefulfillmentRankingScore | Identifies a score, determined before fulfillment but after grounding. Written by the Prefulfillment Ranker, and used as a signal for ACE Ranking. | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | number |
| isNeuralCategoricalInterpretation | Whether the interpretation was generated from the neural categorical parser. | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | boolean |
| parsedDueToExperiment | Experiments that caused this FunctionCall to parse, without which this would not have parsed. | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | list(String) |
| referentialResolution | Describes how this intent was resolved via external data (either elsewhere in the query, or in a previous query). | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | KnowledgeAnswersDialogReferentialResolution |
| intentComposingMid | An intent_relevant_mid that was used to compose the entity for a concept interpretation, along with argument_composing_mid (the question’s argument MID). | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | String |
| shoppingIds | Equivalent shopping ids for the function call. | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | KnowledgeAnswersIntentQueryShoppingIds |
| responseMeaningSignals | Signal data from SRM generation. Solely used internally. See: go/srm-design. | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | KnowledgeAnswersIntentQueryResponseMeaningSignalsResponseMeaningSignals |
| osrpJourneyTag | A tag to annotate user’s journey (e.g., JourneyFollowCampusUpdates). This will be used for Journey OSRP demo (go/josrp-sprint). !!NOTE!! This field is reserved for Journey OSRP demo, and will be deprecated shortly after its completion. DO NOT USE. | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | String |
| parsingSignals | Parsing signals for ranking/filtering. | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | KnowledgeAnswersIntentQueryParsingSignals |
| resultSupport | The list of result supports for this FunctionCall. | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | list(UniversalsearchNewPackerKnowledgeResultSupport) |
| intentRelevantMid | KG mids of entities that represent this intent. These entities are seen as equivalent to the Intent definition, and are specified in the Intent Catalog as relevant_mid. | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | list(String) |
| usesPrefulfillmentRanker | Identifies whether this intent intends to be scored and pruned by the prefulfillment ranker after intent-generation. | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | boolean |
| isUiCompositionIntent | Denotes this is a sub-intent used for composing an Assistant UI response. The assistant dialog should output ui_composition_shelf in the SystemResponse if it can fulfill the intent. More info in go/davinci-design and go/davinci-di-fulfillment | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | boolean |
| confidenceLevel | KnowledgeAnswersIntentQueryFunctionCallSignals | Next ID: 39 | String | |
| addedByGrounding | KnowledgeAnswersIntentQueryGroundingSignals | Grounding-related signals to be propagated down stream. Next ID: 14 | boolean | |
| groundabilityScore | Score indicating how grounded the intent is, populated by the Grounding Box, used by the pre-fulfillment ranker, see http://go/prefulfillment-ranker. | KnowledgeAnswersIntentQueryGroundingSignals | Grounding-related signals to be propagated down stream. Next ID: 14 | float |
| numConstraints | Sum of the number of constraints used by the Grounding Box to ground each variable. | KnowledgeAnswersIntentQueryGroundingSignals | Grounding-related signals to be propagated down stream. Next ID: 14 | float |
| numConstraintsSatisfied | 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]. | KnowledgeAnswersIntentQueryGroundingSignals | Grounding-related signals to be propagated down stream. Next ID: 14 | float |
| numGroundableArgs | Number of groundable arguments in the parsed intent. | KnowledgeAnswersIntentQueryGroundingSignals | Grounding-related signals to be propagated down stream. Next ID: 14 | float |
| numGroundedArgs | Number of arguments that got actually grounded. | KnowledgeAnswersIntentQueryGroundingSignals | Grounding-related signals to be propagated down stream. Next ID: 14 | float |
| numVariables | Number of arguments, possibly nested, that the Grounding Box tried to ground. | KnowledgeAnswersIntentQueryGroundingSignals | Grounding-related signals to be propagated down stream. Next ID: 14 | float |
| numVariablesGrounded | Number of arguments, possibly nested, that the Grounding Box was able to ground. This includes ambiguously grounded arguments. | KnowledgeAnswersIntentQueryGroundingSignals | Grounding-related signals to be propagated down stream. Next ID: 14 | float |
| pgrpOutputFormat | PGRP outputs PROD_INTENT_FACTORY intent format by default. See go/intent-conversion-locations-in-sage. Experimental flags can change or make PGRP output additional intents formatted for PORTMON_FULFILLMENT (e.g. with RDs). This is used by the PortMon/ARM dark launch (go/arm-dark-launch-infra). Longer term, this will be replaced by DGS system-internal transformations (go/if-dgs). | KnowledgeAnswersIntentQueryGroundingSignals | Grounding-related signals to be propagated down stream. Next ID: 14 | String |
| provenance | KnowledgeAnswersIntentQueryGroundingSignals | Grounding-related signals to be propagated down stream. Next ID: 14 | String | |
| sentiment | KnowledgeAnswersIntentQueryGroundingSignals | Grounding-related signals to be propagated down stream. Next ID: 14 | String | |
| usesGroundingBox | If true, then GroundingBox and PGRP are used in AnswersRewriter to process the intent. Other post-processing steps, including IGDP, are adjusted accordingly. Note this will be removed once GroundingBox is fully launched and all prod traffic goes through it. Before that happens, each IG that needs to go through GB and PGRP (post GB ranking pruning) will need to explicitly set this field to true. See http://go/gb-impl and http://go/gb-post-ranker-pruner for details. | KnowledgeAnswersIntentQueryGroundingSignals | Grounding-related signals to be propagated down stream. Next ID: 14 | boolean |
| id | KnowledgeAnswersIntentQueryIdentifier | Identifiers are references to a specific entity of a specified type, such as a TIMER_ID XXX. For more backround and uses see go/grounding-common-ids. | String | |
| idType | KnowledgeAnswersIntentQueryIdentifier | Identifiers are references to a specific entity of a specified type, such as a TIMER_ID XXX. For more backround and uses see go/grounding-common-ids. | String | |
| annotatedSpan | A copy of the span of canonical (raw) parser input text corresponding to this annotation. Copied from QRefAnnotation.annotated_span. | KnowledgeAnswersIntentQueryImpliedEntity | Signals for $QRefImpliedEntities that are merged into entity arguments during parsing. | String |
| evalData | This field is used inside Aqua for evaluation purposes. | KnowledgeAnswersIntentQueryImpliedEntity | Signals for $QRefImpliedEntities that are merged into entity arguments during parsing. | NlpSemanticParsingAnnotationEvalData |
| isUngroundedValue | TODO (b/143536264): Create a new ImpliedTokens message and remove this. Whether the implied entity is ungrounded value, set to true when the entity doesn’t have a KG mid. | KnowledgeAnswersIntentQueryImpliedEntity | Signals for $QRefImpliedEntities that are merged into entity arguments during parsing. | boolean |
| mid | The KG mid of the implied entity. | KnowledgeAnswersIntentQueryImpliedEntity | Signals for $QRefImpliedEntities that are merged into entity arguments during parsing. | String |
| qrefConfidenceScore | The QRef confidence (in [0, 1]) of the entity being correctly annotated. | KnowledgeAnswersIntentQueryImpliedEntity | Signals for $QRefImpliedEntities that are merged into entity arguments during parsing. | number |
| shoppingIds | All ShoppingIds for this implied entity that need to be copied to IntentQuery (FunctionCall) if this implied entity is used in intent generation. See go/iql-shopping-ids for details. | KnowledgeAnswersIntentQueryImpliedEntity | Signals for $QRefImpliedEntities that are merged into entity arguments during parsing. | KnowledgeAnswersIntentQueryShoppingIds |
| iqlEncodingVersion | The version of encoder for the IQL FunctionCalls. We bump up the version when, but not limited to, we change how an IQL is converted to a byte array, or the change of byte compression algorithm. | KnowledgeAnswersIntentQueryIndexingIQLAttachment | Mustang/Kgraph attachment to encode IQL expressions annotated by Webref, Pianno, and other applications. This is currently a prototype implementation. The attachment is not yet output in production. Please contact simonz@ for more info. The planned use-cases include: – Pianno page-level intents (go/pianno-design). – Compound entity representations (go/compounds-in-refx). See go/iql-in-wma for more details about IQL attachment and its encoding design. Next available tag: 5 | integer |
| iqlFuncalls | A compressed byte array that represents IQL FunctionCalls. A list of IQL FunctionCalls are first encoded as a byte array. The byte array is then compressed. For more details on the encoding, see go/iql-in-wma. | KnowledgeAnswersIntentQueryIndexingIQLAttachment | Mustang/Kgraph attachment to encode IQL expressions annotated by Webref, Pianno, and other applications. This is currently a prototype implementation. The attachment is not yet output in production. Please contact simonz@ for more info. The planned use-cases include: – Pianno page-level intents (go/pianno-design). – Compound entity representations (go/compounds-in-refx). See go/iql-in-wma for more details about IQL attachment and its encoding design. Next available tag: 5 | String |
| piannoConfidenceScoreE2 | The Pianno confidence scores of all intents of the IQL FunctionCalls. For space reasons this is stored as a [0, 100] integer that represents the confidence up to two decimal points (fixed point). Convert it to confidence_score using the following formula: float pianno_confidence_score = pianno_confidence_score_e2 / 100.0f It should have the same number of elements as the IQL expressions after decoding. For non-Pianno top level intents, this score is 0. | KnowledgeAnswersIntentQueryIndexingIQLAttachment | Mustang/Kgraph attachment to encode IQL expressions annotated by Webref, Pianno, and other applications. This is currently a prototype implementation. The attachment is not yet output in production. Please contact simonz@ for more info. The planned use-cases include: – Pianno page-level intents (go/pianno-design). – Compound entity representations (go/compounds-in-refx). See go/iql-in-wma for more details about IQL attachment and its encoding design. Next available tag: 5 | list(integer) |
| piannoIqlBitmap | A bit map indicating if the intents in the IQL FunctionCalls are top level intents for Pianno (go/pianno). This is a repeated field. In the event of more than 32 intents, the first uint32/ represents the 1st to the 32nd intents, and the second uint32 represents/ the 33rd to the 64th intents, and so on. Within each uint32, the bits are in reversed order, i.e. the right-most bit of the first uint32 indicating if the first intent in IQL expressions is a top level intent for Pianno. The prevailing (unused) bits of the last uint32 are filled with 0s. | KnowledgeAnswersIntentQueryIndexingIQLAttachment | Mustang/Kgraph attachment to encode IQL expressions annotated by Webref, Pianno, and other applications. This is currently a prototype implementation. The attachment is not yet output in production. Please contact simonz@ for more info. The planned use-cases include: – Pianno page-level intents (go/pianno-design). – Compound entity representations (go/compounds-in-refx). See go/iql-in-wma for more details about IQL attachment and its encoding design. Next available tag: 5 | list(integer) |
| gcidIntent | Geo intents corresponding to the gcids obtained from the Local result. | KnowledgeAnswersIntentQueryLocalResultSignals | A message that stores signals relating to a Local result. | list(String) |
| salientTermSet | Salient terms associated with this Local result based on the result gcids. | KnowledgeAnswersIntentQueryLocalResultSignals | A message that stores signals relating to a Local result. | QualitySalientTermsSalientTermSet |
| localResultSignals | Signals relating to each Local result. | KnowledgeAnswersIntentQueryLocalSignals | A message that stores information about Local results to be used in the Packer for Local Categorical derived intent deduplication and conformance. | list(KnowledgeAnswersIntentQueryLocalResultSignals) |
| minSalientTermSimilarity | Minimum salient term similarity between Local results. | KnowledgeAnswersIntentQueryLocalSignals | A message that stores information about Local results to be used in the Packer for Local Categorical derived intent deduplication and conformance. | number |
| type | The type of the lightweight token match. | KnowledgeAnswersIntentQueryLocationMarkersSignals | Signals from LightweightToken. The span for an argument may have been extended to include lightweight token markers such as FROM or TO. This signal provides the semantics for the range extension. | String |
| artistTitle | For songs, this is the name of the primary artist, i.e. “Shallow” would “Lady Gaga” set. | KnowledgeAnswersIntentQueryMediaEntitySignals | Signals about the media entity. | String |
| name | Name of the media entity, i.e. “Lady Gaga”. | KnowledgeAnswersIntentQueryMediaEntitySignals | Signals about the media entity. | String |
| isIsolated | If the modifier is only a good soft modifier by itself, then we would trigger only if it’s the only modifier | KnowledgeAnswersIntentQueryMuninSignals | Signals derived from Munin Function call annotations. | boolean |
| softModifierCollection | Signals for $ListQueryRuleWithSoftModifier. Collections allowed by the soft modifier. | KnowledgeAnswersIntentQueryMuninSignals | Signals derived from Munin Function call annotations. | list(String) |
| textIsGenerated | If true, the text for this argument did not come from the query, but was generated somehow else. | KnowledgeAnswersIntentQueryMuninSignals | Signals derived from Munin Function call annotations. | boolean |
| annotationSource | Where the annotation has been read from. | KnowledgeAnswersIntentQueryNimbleAnnotationSignals | Signals associated with NimbleAnnotator annotations. | String |
| type | A client-controlled identifier that the client can use to distinguish between different sets of annotations. | KnowledgeAnswersIntentQueryNimbleAnnotationSignals | Signals associated with NimbleAnnotator annotations. | String |
| version | Version identifier used to isolate different clients from each other. A client should intersect this list of versions with the ones the client is interested in, and use the annotation if the intersection is non-empty. | KnowledgeAnswersIntentQueryNimbleAnnotationSignals | Signals associated with NimbleAnnotator annotations. | list(String) |
| provenance | Provenance of the annotator. Equivalent to the `provenance` field in OnDeviceParserInput::AnnotationInfo. This is used to map from AnnotationInfo to nlp_sage.ScoredAnnotation, since nlp_sage.ScoredAnnotation doesn’t have a native `provenance` field. Note in the (very) long term, we’d like to replace ScoredAnnotation with Argument altogether. | KnowledgeAnswersIntentQueryOnDeviceAnnotationSignals | Signals coming from on-device annotators. | String |
| calibratedParsingScore | A parsing score that is independently calibrated by each parser/IG, used by pre-fulfillment ranker, see http://go/prefulfillment-ranker. | KnowledgeAnswersIntentQueryParsingSignals | Parsing-related signals. Only horizontal signals should appear directly as fields on this message. Each domain should create their own extension for anything that they need to propagate down stream from AQUA. Note that this proto is not the same as the Superroot proto ParsingSignals (http://google3/knowledge/proto/scoring-signals.proto), which is a Superroot-specific signal used in Scoring. Next ID: 7 | float |
| effectiveArgSpanLength | 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). | KnowledgeAnswersIntentQueryParsingSignals | Parsing-related signals. Only horizontal signals should appear directly as fields on this message. Each domain should create their own extension for anything that they need to propagate down stream from AQUA. Note that this proto is not the same as the Superroot proto ParsingSignals (http://google3/knowledge/proto/scoring-signals.proto), which is a Superroot-specific signal used in Scoring. Next ID: 7 | number |
| inQueryMaxEffectiveArgSpanLength | 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). | KnowledgeAnswersIntentQueryParsingSignals | Parsing-related signals. Only horizontal signals should appear directly as fields on this message. Each domain should create their own extension for anything that they need to propagate down stream from AQUA. Note that this proto is not the same as the Superroot proto ParsingSignals (http://google3/knowledge/proto/scoring-signals.proto), which is a Superroot-specific signal used in Scoring. Next ID: 7 | number |
| qrewriteCallPathInfoFingerprint | This proto holds the fingerprint of the call path info of QRewrite client (e.g. the QUS’s phase like “RBT”,”QBT”; the QUS’s candidate type like “Identity”; and the ACE’s candidate type like “FuzzyMatcher”). | KnowledgeAnswersIntentQueryParsingSignals | Parsing-related signals. Only horizontal signals should appear directly as fields on this message. Each domain should create their own extension for anything that they need to propagate down stream from AQUA. Note that this proto is not the same as the Superroot proto ParsingSignals (http://google3/knowledge/proto/scoring-signals.proto), which is a Superroot-specific signal used in Scoring. Next ID: 7 | String |
| source | The parser that calibrated the parsing score below. | KnowledgeAnswersIntentQueryParsingSignals | Parsing-related signals. Only horizontal signals should appear directly as fields on this message. Each domain should create their own extension for anything that they need to propagate down stream from AQUA. Note that this proto is not the same as the Superroot proto ParsingSignals (http://google3/knowledge/proto/scoring-signals.proto), which is a Superroot-specific signal used in Scoring. Next ID: 7 | String |
| attributeId | Attribute ID of a personal_summary_node_child. | KnowledgeAnswersIntentQueryPersonalEntity | A message encapsulating all “/collection/personal_memory” annotations from QRef annotator. These annotations are present in personal_summary_node_child proto field of input QRefAnnotation proto. NEXT ID TO USE: 5 | String |
| entityRelationship | KnowledgeAnswersIntentQueryPersonalEntity | A message encapsulating all “/collection/personal_memory” annotations from QRef annotator. These annotations are present in personal_summary_node_child proto field of input QRefAnnotation proto. NEXT ID TO USE: 5 | list(KnowledgeAnswersIntentQueryPersonalEntityEntityRelationship) | |
| freebaseMid | The mid of the entity in freebase associated with this span. | KnowledgeAnswersIntentQueryPersonalEntity | A message encapsulating all “/collection/personal_memory” annotations from QRef annotator. These annotations are present in personal_summary_node_child proto field of input QRefAnnotation proto. NEXT ID TO USE: 5 | String |
| personalEntityChild | Every PersonalEntity might itself rescursively contain related Personal Entities, e.g. for, “my father’s mother” a parent Personal Entity for ‘Mother()’ contains a child Personal Entity of the form ‘Mother(Myself)’. | KnowledgeAnswersIntentQueryPersonalEntity | A message encapsulating all “/collection/personal_memory” annotations from QRef annotator. These annotations are present in personal_summary_node_child proto field of input QRefAnnotation proto. NEXT ID TO USE: 5 | list(KnowledgeAnswersIntentQueryPersonalEntity) |
| entityIndex | The index of the other entity in the relationship. | KnowledgeAnswersIntentQueryPersonalEntityEntityRelationship | The relationship information from QRef. Only included if the QRefAnnotator is initialised with include_annotated_relationships. | integer |
| linkPropertyName | Names of the relationship links. | KnowledgeAnswersIntentQueryPersonalEntityEntityRelationship | The relationship information from QRef. Only included if the QRefAnnotator is initialised with include_annotated_relationships. | list(String) |
| score | Numeric value associated with each annotation within the Qref servlet output. | KnowledgeAnswersIntentQueryQrefAnnotationSignals | Signals associated with Qref annotations. | float |
| trustedNameConfidence | Trusted name confidence signal https://g3doc.corp.google.com/repository/webref/preprocessing/names/tnc_classifier/README.md | KnowledgeAnswersIntentQueryQrefAnnotationSignals | Signals associated with Qref annotations. | float |
| queryPopularity | KnowledgeAnswersIntentQueryRelatednessSignals | Relatedness Matrix signals for FunctionCall Arguments. | number | |
| youtubeViews | KnowledgeAnswersIntentQueryRelatednessSignals | Relatedness Matrix signals for FunctionCall Arguments. | String | |
| answersValueGender | KnowledgeAnswersIntentQueryResponseMeaningSignalsAnswersHeaderSignals | String | ||
| numAnswers | KnowledgeAnswersIntentQueryResponseMeaningSignalsAnswersHeaderSignals | String | ||
| answersHeaderSignals | Signals that are used to generate answers header. | KnowledgeAnswersIntentQueryResponseMeaningSignalsResponseMeaningSignals | SRM signal data. Properties here should be nonsemantic. Semantic properties should be modeled directly in the SRM. | KnowledgeAnswersIntentQueryResponseMeaningSignalsAnswersHeaderSignals |
| propertyValue | KnowledgeAnswersIntentQueryResponseMeaningSignalsResponseMeaningSignals | SRM signal data. Properties here should be nonsemantic. Semantic properties should be modeled directly in the SRM. | list(FreebasePropertyValue) | |
| responseMeaningApplication | The intended application this response meaning is used for. It is intended for downstream dispatching. | KnowledgeAnswersIntentQueryResponseMeaningSignalsResponseMeaningSignals | SRM signal data. Properties here should be nonsemantic. Semantic properties should be modeled directly in the SRM. | String |
| entityType | KnowledgeAnswersIntentQuerySaftSignals | Signals derived from overlapping saft annotations. | String | |
| isHeadOfIntent | KnowledgeAnswersIntentQuerySaftSignals | Signals derived from overlapping saft annotations. | boolean | |
| isVerb | Saft often marks verbs as head of intent and we may want to ignore those. | KnowledgeAnswersIntentQuerySaftSignals | Signals derived from overlapping saft annotations. | boolean |
| number | KnowledgeAnswersIntentQuerySaftSignals | Signals derived from overlapping saft annotations. | String | |
| doubleValue | KnowledgeAnswersIntentQueryScalarValue | A message representing a scalar numeric value with optional units | float | |
| unitType | KnowledgeAnswersIntentQueryScalarValue | A message representing a scalar numeric value with optional units | String | |
| category | Name of the subgrammar category this annotation is associated with. | KnowledgeAnswersIntentQuerySemanticAnnotationSignals | Signals associated with nlp_ig::v1::SemanticAnnotator. | String |
| domain | Name of the subgrammar domain. | KnowledgeAnswersIntentQuerySemanticAnnotationSignals | Signals associated with nlp_ig::v1::SemanticAnnotator. | String |
| features | KnowledgeAnswersIntentQuerySemanticAnnotationSignals | Signals associated with nlp_ig::v1::SemanticAnnotator. | list(KnowledgeAnswersIntentQuerySemanticAnnotationSignalsFeature) | |
| score | Numeric value associated with each subgrammar annotation. Used for in-domain ranking inside the Aqua Analyzer. This field is not guaranteed to be in any range. Furthermore, this field should never be compared for annotations with differing ‘domain’ value. The field is included here for making the Aqua Analyzer work with subgrammar annotations that have been generated in a different Aqua Analyzer (typically by TUIG SemanticAnnotationServlet). TL;DR: Consumers of this message are STRONGLY DISCOURAGED from using this field. | KnowledgeAnswersIntentQuerySemanticAnnotationSignals | Signals associated with nlp_ig::v1::SemanticAnnotator. | float |
| name | KnowledgeAnswersIntentQuerySemanticAnnotationSignalsFeature | Aqua features exported from a subgrammar. Primarily added here for External Subgrammar Annotations to work. See go/esa-exported-features for details. NOTE: Feature names can change and the existence of any feature is not guaranteed. Get in touch with ig-eng@ before using these features. | String | |
| value | KnowledgeAnswersIntentQuerySemanticAnnotationSignalsFeature | Aqua features exported from a subgrammar. Primarily added here for External Subgrammar Annotations to work. See go/esa-exported-features for details. NOTE: Feature names can change and the existence of any feature is not guaranteed. Get in touch with ig-eng@ before using these features. | float | |
| doNotUseDebugOnlyDecryptedValue | Decrypted and deserialized contents of |encrypted_value|. This field should never be populated in prod. This is only provided for easier human inspection when using dev builds (dev keys are public). | KnowledgeAnswersIntentQuerySensitiveArgumentValueGuard | KnowledgeAnswersIntentQueryArgumentValue | |
| encryptedValue | Encrypted protobuffer of type ArgumentValue. | KnowledgeAnswersIntentQuerySensitiveArgumentValueGuard | String | |
| aspectClusterIds | A shopping aspect cluster id. These are attributes mined from mentions in web articles. | KnowledgeAnswersIntentQueryShoppingIds | Additional shopping identifiers related to an entity or IQL function call. This must be passed along to the shopping backend (go/o4) to aid in fulfillment. Because the shopping data models do not always line up 1-1 with KG entities and are not always reconciled with each other, the message may contain multiple ids. Next id: 8 LINT.IfChange | list(String) |
| brandEntityId | Brand entity id. Brands are fully reconciled with KG entities so there should never be ambiguity as to which brand applies (those would be separate MIDs). | KnowledgeAnswersIntentQueryShoppingIds | Additional shopping identifiers related to an entity or IQL function call. This must be passed along to the shopping backend (go/o4) to aid in fulfillment. Because the shopping data models do not always line up 1-1 with KG entities and are not always reconciled with each other, the message may contain multiple ids. Next id: 8 LINT.IfChange | String |
| bxCategoryIds | A category in the shopping browseonomy, a taxonomy of product types that can be found at go/bx. This field is expected to contain the deepest node in the browseonomy that the intent or argument pertains to, which may be an internal node. It does not contain the entire path of categories. | KnowledgeAnswersIntentQueryShoppingIds | Additional shopping identifiers related to an entity or IQL function call. This must be passed along to the shopping backend (go/o4) to aid in fulfillment. Because the shopping data models do not always line up 1-1 with KG entities and are not always reconciled with each other, the message may contain multiple ids. Next id: 8 LINT.IfChange | list(integer) |
| measures | KnowledgeAnswersIntentQueryShoppingIds | Additional shopping identifiers related to an entity or IQL function call. This must be passed along to the shopping backend (go/o4) to aid in fulfillment. Because the shopping data models do not always line up 1-1 with KG entities and are not always reconciled with each other, the message may contain multiple ids. Next id: 8 LINT.IfChange | list(KnowledgeAnswersIntentQueryShoppingIdsMeasureValue) | |
| merchantIds | List of merchant customer account IDs associated with a merchant entity in KG. NOTE: Soon to be deprecated, see go/merchant_mids_in_indexer design | KnowledgeAnswersIntentQueryShoppingIds | Additional shopping identifiers related to an entity or IQL function call. This must be passed along to the shopping backend (go/o4) to aid in fulfillment. Because the shopping data models do not always line up 1-1 with KG entities and are not always reconciled with each other, the message may contain multiple ids. Next id: 8 LINT.IfChange | list(String) |
| merchantSourceIds | A shopping merchant source id, i.e. the key used to identify Shopping Merchants as they are imported into KG. For reference, these IDs are populated in: * CommerceDB under BusinessIdentification.knowledge_graph.source_id * KG using the /shopping/merchant/id predicate | KnowledgeAnswersIntentQueryShoppingIds | Additional shopping identifiers related to an entity or IQL function call. This must be passed along to the shopping backend (go/o4) to aid in fulfillment. Because the shopping data models do not always line up 1-1 with KG entities and are not always reconciled with each other, the message may contain multiple ids. Next id: 8 LINT.IfChange | list(String) |
| tagIds | Moka attributes of a product. This includes color tags but currently not brand. We allow the possibility for multiple tag ids, as multiple Moka tag ids may map to the same mid, and we may not be able to find a single matching Moka tag. Also, cross-category Moka colors intentionally map a single color mentioned in the query to an expansion of many tags representing points in LAB color space (although this representation is expected to change). | KnowledgeAnswersIntentQueryShoppingIds | Additional shopping identifiers related to an entity or IQL function call. This must be passed along to the shopping backend (go/o4) to aid in fulfillment. Because the shopping data models do not always line up 1-1 with KG entities and are not always reconciled with each other, the message may contain multiple ids. Next id: 8 LINT.IfChange | list(String) |
| facetId | KnowledgeAnswersIntentQueryShoppingIdsMeasureValue | A measured value of a product (e.g. Hard drive size = 1 TB). The value is measured in the facet’s base unit. This does not necessarily match the unit expressed by the user in the query. The exact unit is known to the O4 server and is used in fulfillment. | String | |
| value | KnowledgeAnswersIntentQueryShoppingIdsMeasureValue | A measured value of a product (e.g. Hard drive size = 1 TB). The value is measured in the facet’s base unit. This does not necessarily match the unit expressed by the user in the query. The exact unit is known to the O4 server and is used in fulfillment. | float | |
| intent | The intent name of the fallback intent. | KnowledgeAnswersIntentQuerySignalComputationFallbackIntent | A message representing an intent to use for intent scoring if the root intent is invalid. | String |
| boolValue | KnowledgeAnswersIntentQuerySimpleValue | A message representing a simple literal value. | boolean | |
| doubleValue | KnowledgeAnswersIntentQuerySimpleValue | A message representing a simple literal value. | float | |
| identifier | KnowledgeAnswersIntentQuerySimpleValue | A message representing a simple literal value. | KnowledgeAnswersIntentQueryIdentifier | |
| intValue | KnowledgeAnswersIntentQuerySimpleValue | A message representing a simple literal value. | String | |
| stringValue | KnowledgeAnswersIntentQuerySimpleValue | A message representing a simple literal value. | String | |
| ungroundedValue | Ungrounded value contains the part of the query (or web snippet, etc.) that was not understood. For more information on this field, see the “Ungrounded value” item in the table of contents of go/iql-v1 | KnowledgeAnswersIntentQuerySimpleValue | A message representing a simple literal value. | String |
| supportTransferSource | Entities that transferred support to this entity (mids). | KnowledgeAnswersIntentQuerySupportTransferSignals | Signals indicating whether this entity received or transferred support (and from which entities). | list(String) |
| supportTransferTarget | Entities that received support from this entity (mids). | KnowledgeAnswersIntentQuerySupportTransferSignals | Signals indicating whether this entity received or transferred support (and from which entities). | list(String) |
| evalData | This field is used inside Aqua and outside Aqua for identifying the token indices and/or byte offsets of this Token. | KnowledgeAnswersIntentQueryToken | A token represents an ngram with relevant information about it. If the token is a context phrase, it will have a prior score associated with it. The prior is computed via knowledge/answers/query_generalization/ word_prior/word_prior_from_examples_lib.cc, and ranges between 0 and 1. Stopwords and intent tokens (primary and component) have a score of 1.0. | NlpSemanticParsingAnnotationEvalData |
| ngram | |ngram| should be populated with a string from the raw query, not the normalized tokens. E.g. The ngram in the ignored token for the Height intent on the query [Height of barack obama], will be “Height”. The ngram in the ignored token for the Videos intent on the query [vidéos] will be “vidéos”. | KnowledgeAnswersIntentQueryToken | A token represents an ngram with relevant information about it. If the token is a context phrase, it will have a prior score associated with it. The prior is computed via knowledge/answers/query_generalization/ word_prior/word_prior_from_examples_lib.cc, and ranges between 0 and 1. Stopwords and intent tokens (primary and component) have a score of 1.0. | String |
| parsedDueToExperiment | Experiments that caused this Token to parse, without which this would not have parsed. | KnowledgeAnswersIntentQueryToken | A token represents an ngram with relevant information about it. If the token is a context phrase, it will have a prior score associated with it. The prior is computed via knowledge/answers/query_generalization/ word_prior/word_prior_from_examples_lib.cc, and ranges between 0 and 1. Stopwords and intent tokens (primary and component) have a score of 1.0. | list(String) |
| prior | KnowledgeAnswersIntentQueryToken | A token represents an ngram with relevant information about it. If the token is a context phrase, it will have a prior score associated with it. The prior is computed via knowledge/answers/query_generalization/ word_prior/word_prior_from_examples_lib.cc, and ranges between 0 and 1. Stopwords and intent tokens (primary and component) have a score of 1.0. | number | |
| provenance | KnowledgeAnswersIntentQueryToken | A token represents an ngram with relevant information about it. If the token is a context phrase, it will have a prior score associated with it. The prior is computed via knowledge/answers/query_generalization/ word_prior/word_prior_from_examples_lib.cc, and ranges between 0 and 1. Stopwords and intent tokens (primary and component) have a score of 1.0. | String | |
| provenanceId | Unique identifiers for the provenance of this token, for example, NLP Repository Example IDs. | KnowledgeAnswersIntentQueryToken | A token represents an ngram with relevant information about it. If the token is a context phrase, it will have a prior score associated with it. The prior is computed via knowledge/answers/query_generalization/ word_prior/word_prior_from_examples_lib.cc, and ranges between 0 and 1. Stopwords and intent tokens (primary and component) have a score of 1.0. | list(String) |
| provenanceLanguage | KnowledgeAnswersIntentQueryToken | A token represents an ngram with relevant information about it. If the token is a context phrase, it will have a prior score associated with it. The prior is computed via knowledge/answers/query_generalization/ word_prior/word_prior_from_examples_lib.cc, and ranges between 0 and 1. Stopwords and intent tokens (primary and component) have a score of 1.0. | String | |
| synonyms | KnowledgeAnswersIntentQueryToken | A token represents an ngram with relevant information about it. If the token is a context phrase, it will have a prior score associated with it. The prior is computed via knowledge/answers/query_generalization/ word_prior/word_prior_from_examples_lib.cc, and ranges between 0 and 1. Stopwords and intent tokens (primary and component) have a score of 1.0. | list(KnowledgeAnswersIntentQueryTokenSynonym) | |
| score | Score for this group of tokens is currently product of priors. | KnowledgeAnswersIntentQueryTokens | Tokens includes a list of tokens, with an aggregated score of the priors of the tokens, if any. | number |
| token | KnowledgeAnswersIntentQueryTokens | Tokens includes a list of tokens, with an aggregated score of the priors of the tokens, if any. | list(KnowledgeAnswersIntentQueryToken) | |
| source | KnowledgeAnswersIntentQueryTokenSynonym | A TokenSynonym contains information about synonyms of a Token’s ngram. The synonyms were the ones used during parsing for token explanation in place of the original ngrams. Example 1: [present population of nyc] We can generate interpretation kc:/location/statistical_region:population by converting “present” to its synonym “current”, which is a context phrase for the intent. The ngram for this token would be “present” and the string “current” would be stored in synonym_ngram. Example 2: [nys important cities] We can generate interpretation kc:/location/us_state:cities by converting “important” to its synonym “major” or its synonym “biggest”, because both “major cities” and “biggest cities” are attribute phrases for the intent. In this case, the ngram in this Token is “important cities”, and the token_synonyms (specifically, the synonym_ngram field) would store “major cities” and “biggest cities”, since those are the actual synonym ngrams that match the attribute phrases. For context phrases, we generally should have only one matched_squery_synonyms, since we try to find the best synonyms to use using the context phrase score. However, for attribute phrase we don’t really have enough info to determine which synonym is better if they both trigger the same intent, and hence we will propagate both synonyms. | String | |
| synonymNgram | KnowledgeAnswersIntentQueryTokenSynonym | A TokenSynonym contains information about synonyms of a Token’s ngram. The synonyms were the ones used during parsing for token explanation in place of the original ngrams. Example 1: [present population of nyc] We can generate interpretation kc:/location/statistical_region:population by converting “present” to its synonym “current”, which is a context phrase for the intent. The ngram for this token would be “present” and the string “current” would be stored in synonym_ngram. Example 2: [nys important cities] We can generate interpretation kc:/location/us_state:cities by converting “important” to its synonym “major” or its synonym “biggest”, because both “major cities” and “biggest cities” are attribute phrases for the intent. In this case, the ngram in this Token is “important cities”, and the token_synonyms (specifically, the synonym_ngram field) would store “major cities” and “biggest cities”, since those are the actual synonym ngrams that match the attribute phrases. For context phrases, we generally should have only one matched_squery_synonyms, since we try to find the best synonyms to use using the context phrase score. However, for attribute phrase we don’t really have enough info to determine which synonym is better if they both trigger the same intent, and hence we will propagate both synonyms. | String | |
| slotNames | KnowledgeAnswersIntersectType | list(String) | ||
| command | KnowledgeAnswersMarker | A Marker specifies a Meaning Expression’s (i.e. intent FunctionCall) purpose. NOTE: Markers always impact go/intent-resolution semantics. | KnowledgeAnswersMarkerCommand | |
| openQuestion | KnowledgeAnswersMarker | A Marker specifies a Meaning Expression’s (i.e. intent FunctionCall) purpose. NOTE: Markers always impact go/intent-resolution semantics. | KnowledgeAnswersMarkerOpenQuestion | |
| polarQuestion | KnowledgeAnswersMarker | A Marker specifies a Meaning Expression’s (i.e. intent FunctionCall) purpose. NOTE: Markers always impact go/intent-resolution semantics. | KnowledgeAnswersMarkerPolarQuestion | |
| stateOfAffairs | KnowledgeAnswersMarker | A Marker specifies a Meaning Expression’s (i.e. intent FunctionCall) purpose. NOTE: Markers always impact go/intent-resolution semantics. | KnowledgeAnswersMarkerStateOfAffairs | |
| slotKey | Note: This is still under development and not available for general use. Contact meaning-platform-eng@ for questions. | KnowledgeAnswersMarkerOpenQuestion | Indicates a question, requesting the value of a specified slot. Not applicable if the requested slot simultaneously appears as an argument. See go/requested-slots for details. Next ID: 3 | KnowledgeAnswersMeaningSchemaSlotKey |
| slotName | One or multiple slots may be requested by the marker. See go/mrf-multiple-output-slots for details on requesting multiple output slots. | KnowledgeAnswersMarkerOpenQuestion | Indicates a question, requesting the value of a specified slot. Not applicable if the requested slot simultaneously appears as an argument. See go/requested-slots for details. Next ID: 3 | list(String) |
| deprecatedVersion | The version has been changed to be defined as a horizontal version on the entire meaning catalog instead of per-schema. | KnowledgeAnswersMeaningSchemaKey | The primary key for an intent. Next ID: 3 | String |
| mid | The minted MID for an intent. | KnowledgeAnswersMeaningSchemaKey | The primary key for an intent. Next ID: 3 | String |
| mid | The minted MID for the slot. This ID uniquely identifies the slot globally. | KnowledgeAnswersMeaningSchemaSlotKey | The primary key for a MeaningSchema slot. Next ID: 3 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, please update Argument.SlotKey. LINT.IfChange | String |
| uniqueId | A stable unique ID for this intent minted from go/uniqueid. NOTE: This is considered a private field used only for internal Intent Catalog purposes (i.e. as a source ID for generating this intent’s associated MID). Additionally, this field is only populated on the schema. TODO (b/168907943): Move “unique_id” out of MeaningSchemaSlotKey proto message. Note: Please do not use this field. It is going to be moved out of this proto message. | KnowledgeAnswersMeaningSchemaSlotKey | The primary key for a MeaningSchema slot. Next ID: 3 For //depot/google3/logs/proto/knowledge/interpretation/intent_query.proto in the “ThenChange”, please update Argument.SlotKey. LINT.IfChange | String |
| componentSpecificContracts | Contains data about the contracts that this ValueType level is available for. For more information see go/contract-based-conformance. | KnowledgeAnswersMeasurementType | A MeasurementType configures a value that consists of a measurement. The expected value should have a number and a mid representing the unit. Note: this is currently only used for attribute answer value types. Configuration intent slot as measurement is yet to be supported (or instead we should universally use SemanticType). | NlpMeaningComponentSpecificContracts |
| remodelings | Contains data about current schema remodelings at this ValueType level. For more information see go/meaning-remodeling-framework. | KnowledgeAnswersMeasurementType | A MeasurementType configures a value that consists of a measurement. The expected value should have a number and a mid representing the unit. Note: this is currently only used for attribute answer value types. Configuration intent slot as measurement is yet to be supported (or instead we should universally use SemanticType). | NlpMeaningMeaningRemodelings |
| componentSpecificContracts | Contains data about the contracts that this ValueType level is available for. For more information see go/contract-based-conformance. | KnowledgeAnswersNormalizedStringType | A NormalizedStringType configures a value that is one of the listed normalized_values. An arbitrary mapping from input strings to normalized_values can be specified in the local intent config. Only alphabetical strings can be used as normalized_values. This type should NOT be used for: – Mids, ids, dates, or other structured data. Use an annotator instead, and address any quality issues at the annotator level. – Simplifying grammar rules. If you are not using the normalized_values in your question semantics, you should remove the slot. Use additional query_examples instead. | NlpMeaningComponentSpecificContracts |
| normalizedValue | KnowledgeAnswersNormalizedStringType | A NormalizedStringType configures a value that is one of the listed normalized_values. An arbitrary mapping from input strings to normalized_values can be specified in the local intent config. Only alphabetical strings can be used as normalized_values. This type should NOT be used for: – Mids, ids, dates, or other structured data. Use an annotator instead, and address any quality issues at the annotator level. – Simplifying grammar rules. If you are not using the normalized_values in your question semantics, you should remove the slot. Use additional query_examples instead. | list(String) | |
| remodelings | Contains data about current schema remodelings at this ValueType level. For more information see go/meaning-remodeling-framework. | KnowledgeAnswersNormalizedStringType | A NormalizedStringType configures a value that is one of the listed normalized_values. An arbitrary mapping from input strings to normalized_values can be specified in the local intent config. Only alphabetical strings can be used as normalized_values. This type should NOT be used for: – Mids, ids, dates, or other structured data. Use an annotator instead, and address any quality issues at the annotator level. – Simplifying grammar rules. If you are not using the normalized_values in your question semantics, you should remove the slot. Use additional query_examples instead. | NlpMeaningMeaningRemodelings |
| componentSpecificContracts | Contains data about the contracts that this ValueType level is available for. For more information see go/contract-based-conformance. | KnowledgeAnswersNumberType | A NumberType configures a value whose type is intended to be numeric. | NlpMeaningComponentSpecificContracts |
| keepAsString | If true, the semantics of the NumberType argument are retained as a string, rather than being converted to a float-type object. This option is particularly useful in cases where leading 0s in the user input are meaningful, e.g. for zip codes or sports jersey numbers. For the user- specified value “01”, for instance, the PathQuery semantics will be: def $Slot “01” | KnowledgeAnswersNumberType | A NumberType configures a value whose type is intended to be numeric. | boolean |
| rangeConstraint | Range constraint limits the set of numbers accepted by this type. The constraint applies to all subtypes. Currently, this constraint is only enforced in Loose Parser. | KnowledgeAnswersNumberType | A NumberType configures a value whose type is intended to be numeric. | KnowledgeAnswersRangeConstraint |
| remodelings | Contains data about current schema remodelings at this ValueType level. For more information see go/meaning-remodeling-framework. | KnowledgeAnswersNumberType | A NumberType configures a value whose type is intended to be numeric. | NlpMeaningMeaningRemodelings |
| subType | sub_type is a list of the NumberSubTypes which are accepted. If the list is empty, that means all numeric or ordinal values are accepted. If multiple values are specified, then this value accepts any of the sub_types in the list. | KnowledgeAnswersNumberType | A NumberType configures a value whose type is intended to be numeric. | list(String) |
| aogType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueAogType | |
| appAnnotationType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueAppAnnotationType | |
| audioType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueAudioType | |
| calendarEventType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueCalendarEventType | |
| calendarEventWrapperType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueCalendarEventWrapperType | |
| calendarReferenceType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueCalendarReferenceType | |
| complexQueriesRewriteType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueComplexQueriesRewriteType | |
| componentReferenceType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueComponentReferenceIndexType | |
| componentSpecificContracts | Contains data about the contracts that this ValueType level is available for. For more information see go/contract-based-conformance. | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | NlpMeaningComponentSpecificContracts |
| deviceIdType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueDeviceIdType | |
| deviceType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueDeviceType | |
| deviceUserIdentityType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueDeviceUserIdentityType | |
| homeAutomationDeviceType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueHomeAutomationDeviceType | |
| locationType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueLocationType | |
| mediaType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueMediaType | |
| messageNotificationType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueMessageNotificationType | |
| moneyType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueMoneyType | |
| narrativeNewsProviderType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueNewsProviderType | |
| onDeviceType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueOnDeviceType | |
| personType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaquePersonType | |
| personalIntelligenceEntityType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaquePersonalIntelligenceEntityType | |
| productivityListItemType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueProductivityListItemType | |
| recurrenceType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueRecurrenceType | |
| reminderType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueReminderType | |
| remodelings | Contains data about current schema remodelings at this ValueType level. For more information see go/meaning-remodeling-framework. | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | NlpMeaningMeaningRemodelings |
| shoppingMerchantType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueShoppingMerchantType | |
| shoppingOfferType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueShoppingOfferType | |
| shoppingProductExpressionType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueShoppingProductExpressionType | |
| shoppingProductType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueShoppingProductType | |
| shoppingStoreType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueShoppingStoreType | |
| timerType | KnowledgeAnswersOpaqueType | Note: OpaqueType is deprecated and addition of new fields is not allowed. Refer to go/opaque_type for details. If you think this is the only way to implement your feature, attend an office hours (go/meaning-help) and discuss with the MRF team. An OpaqueType configures a value whose type is only interpretable by _specific_ clients of the intent catalog. This means horizontal ‘features’ like pretty printing, correct logging, intent blacklisting and signal aggregation will not work for opaque value types. It has a field for each type in IntentQuery that is not covered by a non-opaque type (specifically: protocol messages). The fields are themselves messages declared in this file. The specific opaque value types must be empty messages. If you find a need to add any fields to these messages, make them non-opaque and implement all of the code to treat them as first class types. It is allowable for a value to have more than one of the opaque types. See http://go/opaque-type-for-value-type. LINT.IfChange Next Id: 32 | KnowledgeAnswersOpaqueTimerType | |
| componentSpecificContracts | Contains data about the contracts that this ValueType level is available for. For more information see go/contract-based-conformance. | KnowledgeAnswersPlexityRequirement | Plexity is a conceptual distinction between viewing something (a slot filler, for example) as a single individual, or as a complex concept consisting of multiple individuals or subparts. Note that plexity is not the same as (or correlated with) either grammatical number or with distributive and collective interpretations of the slot. The PlexityRequirement proto and Plexity enum are defined outside ValueType as we may move the plexity specification to a different place in the intent protos in future. | NlpMeaningComponentSpecificContracts |
| remodelings | Contains data about current schema remodelings at this ValueType level. For more information see go/meaning-remodeling-framework. | KnowledgeAnswersPlexityRequirement | Plexity is a conceptual distinction between viewing something (a slot filler, for example) as a single individual, or as a complex concept consisting of multiple individuals or subparts. Note that plexity is not the same as (or correlated with) either grammatical number or with distributive and collective interpretations of the slot. The PlexityRequirement proto and Plexity enum are defined outside ValueType as we may move the plexity specification to a different place in the intent protos in future. | NlpMeaningMeaningRemodelings |
| simplePlexity | Simple plexity: the slot’s filler must allow the specified plexity value, for example it must contain multiple individuals if the plexity is MULTIPLEX. | KnowledgeAnswersPlexityRequirement | Plexity is a conceptual distinction between viewing something (a slot filler, for example) as a single individual, or as a complex concept consisting of multiple individuals or subparts. Note that plexity is not the same as (or correlated with) either grammatical number or with distributive and collective interpretations of the slot. The PlexityRequirement proto and Plexity enum are defined outside ValueType as we may move the plexity specification to a different place in the intent protos in future. | String |
| componentSpecificContracts | Contains data about the contracts that this ValueType level is available for. For more information see go/contract-based-conformance. | KnowledgeAnswersPolarQuestionType | A special type representing a polar question. | NlpMeaningComponentSpecificContracts |
| remodelings | Contains data about current schema remodelings at this ValueType level. For more information see go/meaning-remodeling-framework. | KnowledgeAnswersPolarQuestionType | A special type representing a polar question. | NlpMeaningMeaningRemodelings |
| max | KnowledgeAnswersRangeConstraint | KnowledgeAnswersRangeConstraintRangeEndpoint | ||
| min | KnowledgeAnswersRangeConstraint | KnowledgeAnswersRangeConstraintRangeEndpoint | ||
| isExclusive | If true, then this endpoint’s value is not included in the range. | KnowledgeAnswersRangeConstraintRangeEndpoint | boolean | |
| value | The value of this endpoint | KnowledgeAnswersRangeConstraintRangeEndpoint | float | |
| slotName | KnowledgeAnswersSameType | String | ||
| allowAll | If true, is compatible with a schema whose answer_type is any semantic_type including empty (since by default schemas return themselves as semantic_types (b/211438997). This is used primarily for slot composition. Example: for the slot name: Operand type { semantic_type { allow_all: true } entity_type {} } * An entity_type or a schema with answer_type ‘entity_type’ can fill Operand. * A schema with either (a) no answer_type or (b) answer_type with !semantic_type.names().empty() can fill Operand * A schema with answer_type ‘date’ CAN NOT fill Operand. Note that when there is an explicit answer_type, the ‘self’ semantic_type is not considered. | KnowledgeAnswersSemanticType | A SemanticType configures a value determined by another source, in particular another intent or a semantic frame. See go/unifying-intents and go/framery. | boolean |
| componentSpecificContracts | Contains data about the contracts that this ValueType level is available for. For more information see go/contract-based-conformance. | KnowledgeAnswersSemanticType | A SemanticType configures a value determined by another source, in particular another intent or a semantic frame. See go/unifying-intents and go/framery. | NlpMeaningComponentSpecificContracts |
| includesContainingIntent | Determines whether or not the meaning schema that contains this semantic_type conforms to a function call with the name and arguments taken from the meaning schema. As it refers to the “containing_intent”, this field should only be set in a semantic_type declared in an intent’s type_members field. The behavior of this field is undefined in other cases, for example, declaring the type of an intent slot. On Assistant, we use meaning schemas for argument types to represent both function call values as well as a reusable tool to host other argument values (opaque types, normalized strings, subsets of entities) across intents. Teams need this information to run conformance checks and annotate new data. Example: If the intents below are in the intent catalog, then: – Intent(slot=”some string”) is conformant, because Type has string_type{} in its type_members. – Intent(slot=Type()) is not conformant, because Type has set semantic_type.includes_containing_intent to false. – Intent(slot=SubType()) is conformant, because type_members is not inherited. { id: “Intent” slot: { name: “slot” type: { semantic_type { name: “Type” }} } } { id: “Type” type_members { string_type{} semantic_type { includes_containing_intent: false } } } { id: “SubType” parent { id: “Type” relationship_type: SUBTYPE } } | KnowledgeAnswersSemanticType | A SemanticType configures a value determined by another source, in particular another intent or a semantic frame. See go/unifying-intents and go/framery. | boolean |
| name | Names of valid sources of the semantics (for example: a frame or an intent). | KnowledgeAnswersSemanticType | A SemanticType configures a value determined by another source, in particular another intent or a semantic frame. See go/unifying-intents and go/framery. | list(String) |
| nameContracts | Like `name_remodelings`, but for ComponentSpecificContracts instead of remodelings. | KnowledgeAnswersSemanticType | A SemanticType configures a value determined by another source, in particular another intent or a semantic frame. See go/unifying-intents and go/framery. | list(NlpMeaningSemanticTypeNameComponentSpecificContracts) |
| nameRemodelings | Contains data about current schema remodelings at the SemanticType name level. The “name” field contains all possible semantic type names and “semantic_type_name_remodelings” acts as an overlay to determine which ones to surface based on which schema remodeling IDs are requested. For more information see go/meaning-remodeling-framework. | KnowledgeAnswersSemanticType | A SemanticType configures a value determined by another source, in particular another intent or a semantic frame. See go/unifying-intents and go/framery. | list(NlpMeaningSemanticTypeNameMeaningRemodelings) |
| remodelings | Contains data about current schema remodelings at this ValueType lev©el. For more information see go/meaning-remodeling-framework. | KnowledgeAnswersSemanticType | A SemanticType configures a value determined by another source, in particular another intent or a semantic frame. See go/unifying-intents and go/framery. | NlpMeaningMeaningRemodelings |
| policyName | Optional cannery policy name. If it presents then Intent Scrubber will use the corresponding Cannery rule for argument scrubbing and redaction instead. It should only be used for existing complex argment value types such as HomeAutomationDevice. | KnowledgeAnswersSensitivityArgumentEvalPolicy | Policy controlling argument level eval. | String |
| redactQuerySpan | Redact corresponding span of the string query. | KnowledgeAnswersSensitivityArgumentEvalPolicy | Policy controlling argument level eval. | boolean |
| replacement | Customized replacement phrase, if missing ${ArgumentName}_REDACTED is used as default. | KnowledgeAnswersSensitivityArgumentEvalPolicy | Policy controlling argument level eval. | String |
| scrubArgumentValue | Scrub argument value and signals before saving to eval storage. If not set, 1) inherit the policy from the outer argument if there is one (for nested intents); 2) finally default to type based scrubbing: see go/argument-type-scrubbing. | KnowledgeAnswersSensitivityArgumentEvalPolicy | Policy controlling argument level eval. | boolean |
| argument | KnowledgeAnswersSensitivityInstruction | Instructions (eg., logging, disambiguation, ads serving) of handling a sensitive intent and its data. LINT.IfChange NextId: 8 | KnowledgeAnswersSensitivityInstructionArgument | |
| intent | KnowledgeAnswersSensitivityInstruction | Instructions (eg., logging, disambiguation, ads serving) of handling a sensitive intent and its data. LINT.IfChange NextId: 8 | KnowledgeAnswersSensitivityInstructionIntent | |
| legacyAssistantSensitivity | This field is for backward compatibility. | KnowledgeAnswersSensitivityInstruction | Instructions (eg., logging, disambiguation, ads serving) of handling a sensitive intent and its data. LINT.IfChange NextId: 8 | SearchPolicyRankableSensitivity |
| multiAccountAllowed | Controls whether a top-level intent is multi-account approved. NLU will do go/cross-account-understanding only for intents with this bit on. Also, this bit should be propagated to user turn Attentionl Entities to extend protection of cross-account data to next turns. In principle fulfillment services (e.g., Monastery) should only dispatch such intents to multi-account approved fulfillers (schemas), at least when the user has a linked dasher account. The Assistant runtime policy engine should treat a query as dasher data if 1) this bit is true in the string redaction, and 2) the user has a linked dasher account, and apply a more restrictive rule for whitelisting, regardless of the actual account provenance in Sensitivity. Example: [User logged in to their personal gmail account.] Q1: “Schedule a meeting tiltled okr review at 3pm”. Assistant: “Should I scheduled it on your [email protected] account?” Q2: “No, add it to my [email protected] account.” We don’t know Q1 is dasher data until Q2. To prevent leaking of Q1 to non-dasher approved binaries, this bit should be used as a proactive measure. It might introduce some over-triggering (e.g., user says “Yes” in Q2), but is much better than blindly treating every query as dasher, not considering whether it actually triggers any multi-account capable intents or not (see b/164420114 for example). | KnowledgeAnswersSensitivityInstruction | Instructions (eg., logging, disambiguation, ads serving) of handling a sensitive intent and its data. LINT.IfChange NextId: 8 | boolean |
| previousQuery | KnowledgeAnswersSensitivityInstruction | Instructions (eg., logging, disambiguation, ads serving) of handling a sensitive intent and its data. LINT.IfChange NextId: 8 | KnowledgeAnswersSensitivityInstructionPreviousQuery | |
| eval | KnowledgeAnswersSensitivityInstructionArgument | Slot/Argument level instructions. | KnowledgeAnswersSensitivityArgumentEvalPolicy | |
| logging | KnowledgeAnswersSensitivityInstructionArgument | Slot/Argument level instructions. | KnowledgeAnswersSensitivityLoggingPolicy | |
| serving | KnowledgeAnswersSensitivityInstructionArgument | Slot/Argument level instructions. | KnowledgeAnswersSensitivityServingPolicy | |
| storage | KnowledgeAnswersSensitivityInstructionArgument | Slot/Argument level instructions. | KnowledgeAnswersSensitivityStoragePolicy | |
| eval | KnowledgeAnswersSensitivityInstructionIntent | Intent level instructions apply to the entire intent and all its argument values. | KnowledgeAnswersSensitivityIntentEvalPolicy | |
| footprints | KnowledgeAnswersSensitivityInstructionIntent | Intent level instructions apply to the entire intent and all its argument values. | KnowledgeAnswersSensitivityMyActivityPolicy | |
| logging | KnowledgeAnswersSensitivityInstructionIntent | Intent level instructions apply to the entire intent and all its argument values. | KnowledgeAnswersSensitivityLoggingPolicy | |
| serving | KnowledgeAnswersSensitivityInstructionIntent | Intent level instructions apply to the entire intent and all its argument values. | KnowledgeAnswersSensitivityServingPolicy | |
| storage | KnowledgeAnswersSensitivityInstructionIntent | Intent level instructions apply to the entire intent and all its argument values. | KnowledgeAnswersSensitivityStoragePolicy | |
| logging | KnowledgeAnswersSensitivityInstructionPreviousQuery | Instructions for knowledge_context.PreviousQuery. See go/apps-userdata-guidelines. | KnowledgeAnswersSensitivityLoggingPolicy | |
| serving | KnowledgeAnswersSensitivityInstructionPreviousQuery | Instructions for knowledge_context.PreviousQuery. See go/apps-userdata-guidelines. | KnowledgeAnswersSensitivityServingPolicy | |
| storage | KnowledgeAnswersSensitivityInstructionPreviousQuery | Instructions for knowledge_context.PreviousQuery. See go/apps-userdata-guidelines. | KnowledgeAnswersSensitivityStoragePolicy | |
| allArguments | Policy for all arguments, so no need to repeat on every argument. | KnowledgeAnswersSensitivityIntentEvalPolicy | Policy controlling intent level eval. | KnowledgeAnswersSensitivityArgumentEvalPolicy |
| enabled | Controls whether to enabled limited logging (rpc whitelisting + GWS log query redaction) if the intent wins post-fulfillment ranking. | KnowledgeAnswersSensitivityIntentEvalPolicy | Policy controlling intent level eval. | boolean |
| nestedIntentOnly | The eval policy won’t apply if the annotated intent is a root. This check is majorly to prevent calling IntentScrubber halfway from InterpretationScrubber via nested intents. | KnowledgeAnswersSensitivityIntentEvalPolicy | Policy controlling intent level eval. | boolean |
| scrubEntireIntent | Scrub entire intent before saving to eval storage, leaving only intent name and sensitivity info. | KnowledgeAnswersSensitivityIntentEvalPolicy | Policy controlling intent level eval. | boolean |
| scrubArgumentValue | The contents of the argument value should be scrubbed before being written to logs. | KnowledgeAnswersSensitivityLoggingPolicy | Policies controlling the logging. | boolean |
| scrubContext | If this is set to true, this Sensitivity’s presence will result in QRewrite to enable AS logging to scrub any discourse context. | KnowledgeAnswersSensitivityLoggingPolicy | Policies controlling the logging. | boolean |
| myActivityRedactedAction | KnowledgeAnswersSensitivityMyActivityPolicy | Policy controlling MyActivity. | String | |
| myActivityRedactionKey | This field will be translated by footprints and is used to describe the content that was redacted that will be displayed to the user in MyActivity. | KnowledgeAnswersSensitivityMyActivityPolicy | Policy controlling MyActivity. | String |
| accountProvenance | Used to annotate the provenace of cross-account personal data. See go/cross-account-understanding. Sensitivity could be annotated at query, intent, and argument levels. Query and intent could have data from multiple accounts, so this field is repeated. A sensitive knowledge_context.PreviousQuery might be dropped to prevent leaking cross-account data via Genie rewrite. For arguments, the best practice is to not blend multi-account data, and this field should be treated as singular to make ownership clear. When publishing attentional entities, contextual NLU might drop an argument that contains data from a different account for data protection. Mixing multi-account data in one argument will cause data from the primary account to be dropped altogether, which is an unnecessary quality loss. | KnowledgeAnswersSensitivitySensitivity | Canonical representation of query sensitivites. See go/sensitive-intents for more details. | list(QualityQrewriteAccountProvenance) |
| instruction | Instruction of handling sensitive intent/argument data. Can be specified in Intent Catalog. | KnowledgeAnswersSensitivitySensitivity | Canonical representation of query sensitivites. See go/sensitive-intents for more details. | KnowledgeAnswersSensitivityInstruction |
| source | This should be systematically added without requiring the feature developers to add a source. This is for debug purpose as to whether the Sensitivity’s trace/path included any of landmark code path helpful for tracing back the sensitivity sources. One should add a new source when one sees fits. It’s chronological order as to which source is added first. One should not manually add a source. The same source can be repeated if the Sensitivity object went through the same code path twice. | KnowledgeAnswersSensitivitySensitivity | Canonical representation of query sensitivites. See go/sensitive-intents for more details. | list(String) |
| type | Sensitivity type. See the enum definition below. | KnowledgeAnswersSensitivitySensitivity | Canonical representation of query sensitivites. See go/sensitive-intents for more details. | String |
| enableRpcWhitelist | If this is set to true, QRewrite will enable RPC Whitelist to be applied in Assistant Server and Genie Rewriter. | KnowledgeAnswersSensitivityServingPolicy | Policies controlling RPC Whitelist at serving time. | boolean |
| encryptArgumentValue | The contents of the argument value should be encrypted before being written to a persistent storage (even if the storage has short time-to-live). No-op when specified at intent level. | KnowledgeAnswersSensitivityStoragePolicy | Policies controlling the storage. | boolean |
| encryptFieldCandidateValueTerm | If true, triggers encryption of |value_term| [1] and move into |sensitive_value_term|. This is useful to support finer grain encryption controls for disambiguation, where the broader |encrypt_argument_value| is too restrictive. In particular, when we know that the values being disambiguated are non-sensitive (e.g. opaque event IDs), but the value_terms are sensitive (e.g. event titles), it can be helpful for debugging purposes to circulate the value unencrypted. This policy only has an effect when configured at argument-level. It has no effect in Intent or PreviousQuery stanzas. See go/delete-event-disambiguation-redaction-v2 for context and usage. [1]cs/s:quality.dialog_manager.IntentStateSignals.FieldCandidate.value_term | KnowledgeAnswersSensitivityStoragePolicy | Policies controlling the storage. | boolean |
| encryptQueryAnnotationData | If this is set true, we encrypt QueryAnnotationDataProto prior to writing it to Footprint ASSISTANT_EPHEMERAL corpus. This enables restricting ACL to the data. | KnowledgeAnswersSensitivityStoragePolicy | Policies controlling the storage. | boolean |
| scrubAuxiliaryFieldsInConversationSnapshot | If this is set to true, the following fields in ConversationSnapshot are scrubbed: * circulated_state.squery * spoken_query * All client_op arguments |from_assistant| interactions | KnowledgeAnswersSensitivityStoragePolicy | Policies controlling the storage. | boolean |
| componentSpecificContracts | Contains data about the contracts that this ValueType level is available for. For more information see go/contract-based-conformance. | KnowledgeAnswersStateOfAffairsType | A special type representing a StateOfAffairs. Currently (as of 2021Q2) this is duplicative with semantic_type { name: “StateOfAffairs” } but we (mrf-team) will encourage clients to migrate to this new type. | NlpMeaningComponentSpecificContracts |
| remodelings | Contains data about current schema remodelings at this ValueType level. For more information see go/meaning-remodeling-framework. | KnowledgeAnswersStateOfAffairsType | A special type representing a StateOfAffairs. Currently (as of 2021Q2) this is duplicative with semantic_type { name: “StateOfAffairs” } but we (mrf-team) will encourage clients to migrate to this new type. | NlpMeaningMeaningRemodelings |
| componentSpecificContracts | Contains data about the contracts that this ValueType level is available for. For more information see go/contract-based-conformance. | KnowledgeAnswersStringType | A StringType configures a value whose type is intended to be arbitrary text. | NlpMeaningComponentSpecificContracts |
| remodelings | Contains data about current schema remodelings at this ValueType level. For more information see go/meaning-remodeling-framework. | KnowledgeAnswersStringType | A StringType configures a value whose type is intended to be arbitrary text. | NlpMeaningMeaningRemodelings |
| singleToken | If true, this value will match a single token. If false, this value will match any nonzero number of tokens. | KnowledgeAnswersStringType | A StringType configures a value whose type is intended to be arbitrary text. | boolean |
| componentSpecificContracts | Contains data about the contracts that this ValueType level is available for. For more information see go/contract-based-conformance. | KnowledgeAnswersTimeZoneType | A TimeZoneType configures a value whose type is a timezone. | NlpMeaningComponentSpecificContracts |
| remodelings | Contains data about current schema remodelings at this ValueType level. For more information see go/meaning-remodeling-framework. | KnowledgeAnswersTimeZoneType | A TimeZoneType configures a value whose type is a timezone. | NlpMeaningMeaningRemodelings |
| componentSpecificContracts | Contains data about the contracts that this ValueType level is available for. For more information see go/contract-based-conformance. | KnowledgeAnswersTrackingNumberType | A TrackingNumberType configures a value whose type is a TrackingNumber. | NlpMeaningComponentSpecificContracts |
| remodelings | Contains data about current schema remodelings at this ValueType level. For more information see go/meaning-remodeling-framework. | KnowledgeAnswersTrackingNumberType | A TrackingNumberType configures a value whose type is a TrackingNumber. | NlpMeaningMeaningRemodelings |
| slotNames | KnowledgeAnswersUnionType | list(String) | ||
| anyType | This type is meant to accept “any” type and allow any and all composition. As such, it should not be used for any composition algorithms, e.g. in Loose Parser. See more detailed discussion at go/any-type-in-mrf. This type may appear on an answer_type, implying that the output of that Meaning Schema is allowed to nest in any other slot. However, support for this is NOT implemented in Loose Parser due to risk of overcomposition, but the MRF Conformance checker allows for this. If you are thinking of using this, please contact mrf-team@. | KnowledgeAnswersValueType | Specifies the allowed type(s) that a value can have, e.g. for a Slot. For example, having both entity_type and string_type present in a ValueType field of a Slot means that the Slot can take _either_ an an EntityType _or_ StringType as a value, and nothing else. It may be helpful to think of this proto as being called something like AllAllowedValueTypes. To enforce a component-specific contract (go/contract-based-conformance) for allowed type(s), we add a repeated field view_specific_${x} for the type ${x}. For example, if we want a slot that can hold any type by default, but can only hold an integer when checking against the P2_LWA contract, then the following should be added to MeaningCatalog: slot { name: “integer_only_slot” type { // The default view has no sub_type or other options. number_type {} // The P2_LWA view specifies INTEGER sub_type. view_specific_number_types { sub_type: INTEGER component_specific_contracts: P2_LWA } } } See go/view-based-options-for-valuetype for more information. Next tag id: 26 LINT.IfChange | KnowledgeAnswersAnyType |
| attributeType | KnowledgeAnswersValueType | Specifies the allowed type(s) that a value can have, e.g. for a Slot. For example, having both entity_type and string_type present in a ValueType field of a Slot means that the Slot can take _either_ an an EntityType _or_ StringType as a value, and nothing else. It may be helpful to think of this proto as being called something like AllAllowedValueTypes. To enforce a component-specific contract (go/contract-based-conformance) for allowed type(s), we add a repeated field view_specific_${x} for the type ${x}. For example, if we want a slot that can hold any type by default, but can only hold an integer when checking against the P2_LWA contract, then the following should be added to MeaningCatalog: slot { name: “integer_only_slot” type { // The default view has no sub_type or other options. number_type {} // The P2_LWA view specifies INTEGER sub_type. view_specific_number_types { sub_type: INTEGER component_specific_contracts: P2_LWA } } } See go/view-based-options-for-valuetype for more information. Next tag id: 26 LINT.IfChange | KnowledgeAnswersAttributeType | |
| booleanType | KnowledgeAnswersValueType | Specifies the allowed type(s) that a value can have, e.g. for a Slot. For example, having both entity_type and string_type present in a ValueType field of a Slot means that the Slot can take _either_ an an EntityType _or_ StringType as a value, and nothing else. It may be helpful to think of this proto as being called something like AllAllowedValueTypes. To enforce a component-specific contract (go/contract-based-conformance) for allowed type(s), we add a repeated field view_specific_${x} for the type ${x}. For example, if we want a slot that can hold any type by default, but can only hold an integer when checking against the P2_LWA contract, then the following should be added to MeaningCatalog: slot { name: “integer_only_slot” type { // The default view has no sub_type or other options. number_type {} // The P2_LWA view specifies INTEGER sub_type. view_specific_number_types { sub_type: INTEGER component_specific_contracts: P2_LWA } } } See go/view-based-options-for-valuetype for more information. Next tag id: 26 LINT.IfChange | KnowledgeAnswersBooleanType | |
| collectionType | KnowledgeAnswersValueType | Specifies the allowed type(s) that a value can have, e.g. for a Slot. For example, having both entity_type and string_type present in a ValueType field of a Slot means that the Slot can take _either_ an an EntityType _or_ StringType as a value, and nothing else. It may be helpful to think of this proto as being called something like AllAllowedValueTypes. To enforce a component-specific contract (go/contract-based-conformance) for allowed type(s), we add a repeated field view_specific_${x} for the type ${x}. For example, if we want a slot that can hold any type by default, but can only hold an integer when checking against the P2_LWA contract, then the following should be added to MeaningCatalog: slot { name: “integer_only_slot” type { // The default view has no sub_type or other options. number_type {} // The P2_LWA view specifies INTEGER sub_type. view_specific_number_types { sub_type: INTEGER component_specific_contracts: P2_LWA } } } See go/view-based-options-for-valuetype for more information. Next tag id: 26 LINT.IfChange | KnowledgeAnswersCollectionType | |
| compoundType | KnowledgeAnswersValueType | Specifies the allowed type(s) that a value can have, e.g. for a Slot. For example, having both entity_type and string_type present in a ValueType field of a Slot means that the Slot can take _either_ an an EntityType _or_ StringType as a value, and nothing else. It may be helpful to think of this proto as being called something like AllAllowedValueTypes. To enforce a component-specific contract (go/contract-based-conformance) for allowed type(s), we add a repeated field view_specific_${x} for the type ${x}. For example, if we want a slot that can hold any type by default, but can only hold an integer when checking against the P2_LWA contract, then the following should be added to MeaningCatalog: slot { name: “integer_only_slot” type { // The default view has no sub_type or other options. number_type {} // The P2_LWA view specifies INTEGER sub_type. view_specific_number_types { sub_type: INTEGER component_specific_contracts: P2_LWA } } } See go/view-based-options-for-valuetype for more information. Next tag id: 26 LINT.IfChange | KnowledgeAnswersCompoundType | |
| dateType | KnowledgeAnswersValueType | Specifies the allowed type(s) that a value can have, e.g. for a Slot. For example, having both entity_type and string_type present in a ValueType field of a Slot means that the Slot can take _either_ an an EntityType _or_ StringType as a value, and nothing else. It may be helpful to think of this proto as being called something like AllAllowedValueTypes. To enforce a component-specific contract (go/contract-based-conformance) for allowed type(s), we add a repeated field view_specific_${x} for the type ${x}. For example, if we want a slot that can hold any type by default, but can only hold an integer when checking against the P2_LWA contract, then the following should be added to MeaningCatalog: slot { name: “integer_only_slot” type { // The default view has no sub_type or other options. number_type {} // The P2_LWA view specifies INTEGER sub_type. view_specific_number_types { sub_type: INTEGER component_specific_contracts: P2_LWA } } } See go/view-based-options-for-valuetype for more information. Next tag id: 26 LINT.IfChange | KnowledgeAnswersDateType | |
| dependencyType | Used for configuring dynamic types to allow for type transparency. See: go/type-dependencies | KnowledgeAnswersValueType | Specifies the allowed type(s) that a value can have, e.g. for a Slot. For example, having both entity_type and string_type present in a ValueType field of a Slot means that the Slot can take _either_ an an EntityType _or_ StringType as a value, and nothing else. It may be helpful to think of this proto as being called something like AllAllowedValueTypes. To enforce a component-specific contract (go/contract-based-conformance) for allowed type(s), we add a repeated field view_specific_${x} for the type ${x}. For example, if we want a slot that can hold any type by default, but can only hold an integer when checking against the P2_LWA contract, then the following should be added to MeaningCatalog: slot { name: “integer_only_slot” type { // The default view has no sub_type or other options. number_type {} // The P2_LWA view specifies INTEGER sub_type. view_specific_number_types { sub_type: INTEGER component_specific_contracts: P2_LWA } } } See go/view-based-options-for-valuetype for more information. Next tag id: 26 LINT.IfChange | KnowledgeAnswersDependencyType |
| durationType | KnowledgeAnswersValueType | Specifies the allowed type(s) that a value can have, e.g. for a Slot. For example, having both entity_type and string_type present in a ValueType field of a Slot means that the Slot can take _either_ an an EntityType _or_ StringType as a value, and nothing else. It may be helpful to think of this proto as being called something like AllAllowedValueTypes. To enforce a component-specific contract (go/contract-based-conformance) for allowed type(s), we add a repeated field view_specific_${x} for the type ${x}. For example, if we want a slot that can hold any type by default, but can only hold an integer when checking against the P2_LWA contract, then the following should be added to MeaningCatalog: slot { name: “integer_only_slot” type { // The default view has no sub_type or other options. number_type {} // The P2_LWA view specifies INTEGER sub_type. view_specific_number_types { sub_type: INTEGER component_specific_contracts: P2_LWA } } } See go/view-based-options-for-valuetype for more information. Next tag id: 26 LINT.IfChange | KnowledgeAnswersDurationType | |
| entityType | KnowledgeAnswersValueType | Specifies the allowed type(s) that a value can have, e.g. for a Slot. For example, having both entity_type and string_type present in a ValueType field of a Slot means that the Slot can take _either_ an an EntityType _or_ StringType as a value, and nothing else. It may be helpful to think of this proto as being called something like AllAllowedValueTypes. To enforce a component-specific contract (go/contract-based-conformance) for allowed type(s), we add a repeated field view_specific_${x} for the type ${x}. For example, if we want a slot that can hold any type by default, but can only hold an integer when checking against the P2_LWA contract, then the following should be added to MeaningCatalog: slot { name: “integer_only_slot” type { // The default view has no sub_type or other options. number_type {} // The P2_LWA view specifies INTEGER sub_type. view_specific_number_types { sub_type: INTEGER component_specific_contracts: P2_LWA } } } See go/view-based-options-for-valuetype for more information. Next tag id: 26 LINT.IfChange | KnowledgeAnswersEntityType | |
| inputCompositionConfig | When specified on a slot’s type, restricts composition based on the enum value. This does not mean anything when the value type is to be interpreted as an output_type. | KnowledgeAnswersValueType | Specifies the allowed type(s) that a value can have, e.g. for a Slot. For example, having both entity_type and string_type present in a ValueType field of a Slot means that the Slot can take _either_ an an EntityType _or_ StringType as a value, and nothing else. It may be helpful to think of this proto as being called something like AllAllowedValueTypes. To enforce a component-specific contract (go/contract-based-conformance) for allowed type(s), we add a repeated field view_specific_${x} for the type ${x}. For example, if we want a slot that can hold any type by default, but can only hold an integer when checking against the P2_LWA contract, then the following should be added to MeaningCatalog: slot { name: “integer_only_slot” type { // The default view has no sub_type or other options. number_type {} // The P2_LWA view specifies INTEGER sub_type. view_specific_number_types { sub_type: INTEGER component_specific_contracts: P2_LWA } } } See go/view-based-options-for-valuetype for more information. Next tag id: 26 LINT.IfChange | String |
| measurementType | KnowledgeAnswersValueType | Specifies the allowed type(s) that a value can have, e.g. for a Slot. For example, having both entity_type and string_type present in a ValueType field of a Slot means that the Slot can take _either_ an an EntityType _or_ StringType as a value, and nothing else. It may be helpful to think of this proto as being called something like AllAllowedValueTypes. To enforce a component-specific contract (go/contract-based-conformance) for allowed type(s), we add a repeated field view_specific_${x} for the type ${x}. For example, if we want a slot that can hold any type by default, but can only hold an integer when checking against the P2_LWA contract, then the following should be added to MeaningCatalog: slot { name: “integer_only_slot” type { // The default view has no sub_type or other options. number_type {} // The P2_LWA view specifies INTEGER sub_type. view_specific_number_types { sub_type: INTEGER component_specific_contracts: P2_LWA } } } See go/view-based-options-for-valuetype for more information. Next tag id: 26 LINT.IfChange | KnowledgeAnswersMeasurementType | |
| normalizedStringType | Note that normalized_string_type is NOT supported in the loose parser. A slot with this type will cause the intent to not be parsed. | KnowledgeAnswersValueType | Specifies the allowed type(s) that a value can have, e.g. for a Slot. For example, having both entity_type and string_type present in a ValueType field of a Slot means that the Slot can take _either_ an an EntityType _or_ StringType as a value, and nothing else. It may be helpful to think of this proto as being called something like AllAllowedValueTypes. To enforce a component-specific contract (go/contract-based-conformance) for allowed type(s), we add a repeated field view_specific_${x} for the type ${x}. For example, if we want a slot that can hold any type by default, but can only hold an integer when checking against the P2_LWA contract, then the following should be added to MeaningCatalog: slot { name: “integer_only_slot” type { // The default view has no sub_type or other options. number_type {} // The P2_LWA view specifies INTEGER sub_type. view_specific_number_types { sub_type: INTEGER component_specific_contracts: P2_LWA } } } See go/view-based-options-for-valuetype for more information. Next tag id: 26 LINT.IfChange | KnowledgeAnswersNormalizedStringType |
| numberType | KnowledgeAnswersValueType | Specifies the allowed type(s) that a value can have, e.g. for a Slot. For example, having both entity_type and string_type present in a ValueType field of a Slot means that the Slot can take _either_ an an EntityType _or_ StringType as a value, and nothing else. It may be helpful to think of this proto as being called something like AllAllowedValueTypes. To enforce a component-specific contract (go/contract-based-conformance) for allowed type(s), we add a repeated field view_specific_${x} for the type ${x}. For example, if we want a slot that can hold any type by default, but can only hold an integer when checking against the P2_LWA contract, then the following should be added to MeaningCatalog: slot { name: “integer_only_slot” type { // The default view has no sub_type or other options. number_type {} // The P2_LWA view specifies INTEGER sub_type. view_specific_number_types { sub_type: INTEGER component_specific_contracts: P2_LWA } } } See go/view-based-options-for-valuetype for more information. Next tag id: 26 LINT.IfChange | KnowledgeAnswersNumberType | |
| opaqueType | KnowledgeAnswersValueType | Specifies the allowed type(s) that a value can have, e.g. for a Slot. For example, having both entity_type and string_type present in a ValueType field of a Slot means that the Slot can take _either_ an an EntityType _or_ StringType as a value, and nothing else. It may be helpful to think of this proto as being called something like AllAllowedValueTypes. To enforce a component-specific contract (go/contract-based-conformance) for allowed type(s), we add a repeated field view_specific_${x} for the type ${x}. For example, if we want a slot that can hold any type by default, but can only hold an integer when checking against the P2_LWA contract, then the following should be added to MeaningCatalog: slot { name: “integer_only_slot” type { // The default view has no sub_type or other options. number_type {} // The P2_LWA view specifies INTEGER sub_type. view_specific_number_types { sub_type: INTEGER component_specific_contracts: P2_LWA } } } See go/view-based-options-for-valuetype for more information. Next tag id: 26 LINT.IfChange | KnowledgeAnswersOpaqueType | |
| plexityRequirement | KnowledgeAnswersValueType | Specifies the allowed type(s) that a value can have, e.g. for a Slot. For example, having both entity_type and string_type present in a ValueType field of a Slot means that the Slot can take _either_ an an EntityType _or_ StringType as a value, and nothing else. It may be helpful to think of this proto as being called something like AllAllowedValueTypes. To enforce a component-specific contract (go/contract-based-conformance) for allowed type(s), we add a repeated field view_specific_${x} for the type ${x}. For example, if we want a slot that can hold any type by default, but can only hold an integer when checking against the P2_LWA contract, then the following should be added to MeaningCatalog: slot { name: “integer_only_slot” type { // The default view has no sub_type or other options. number_type {} // The P2_LWA view specifies INTEGER sub_type. view_specific_number_types { sub_type: INTEGER component_specific_contracts: P2_LWA } } } See go/view-based-options-for-valuetype for more information. Next tag id: 26 LINT.IfChange | KnowledgeAnswersPlexityRequirement | |
| polarQuestionType | KnowledgeAnswersValueType | Specifies the allowed type(s) that a value can have, e.g. for a Slot. For example, having both entity_type and string_type present in a ValueType field of a Slot means that the Slot can take _either_ an an EntityType _or_ StringType as a value, and nothing else. It may be helpful to think of this proto as being called something like AllAllowedValueTypes. To enforce a component-specific contract (go/contract-based-conformance) for allowed type(s), we add a repeated field view_specific_${x} for the type ${x}. For example, if we want a slot that can hold any type by default, but can only hold an integer when checking against the P2_LWA contract, then the following should be added to MeaningCatalog: slot { name: “integer_only_slot” type { // The default view has no sub_type or other options. number_type {} // The P2_LWA view specifies INTEGER sub_type. view_specific_number_types { sub_type: INTEGER component_specific_contracts: P2_LWA } } } See go/view-based-options-for-valuetype for more information. Next tag id: 26 LINT.IfChange | KnowledgeAnswersPolarQuestionType | |
| semanticType | KnowledgeAnswersValueType | Specifies the allowed type(s) that a value can have, e.g. for a Slot. For example, having both entity_type and string_type present in a ValueType field of a Slot means that the Slot can take _either_ an an EntityType _or_ StringType as a value, and nothing else. It may be helpful to think of this proto as being called something like AllAllowedValueTypes. To enforce a component-specific contract (go/contract-based-conformance) for allowed type(s), we add a repeated field view_specific_${x} for the type ${x}. For example, if we want a slot that can hold any type by default, but can only hold an integer when checking against the P2_LWA contract, then the following should be added to MeaningCatalog: slot { name: “integer_only_slot” type { // The default view has no sub_type or other options. number_type {} // The P2_LWA view specifies INTEGER sub_type. view_specific_number_types { sub_type: INTEGER component_specific_contracts: P2_LWA } } } See go/view-based-options-for-valuetype for more information. Next tag id: 26 LINT.IfChange | KnowledgeAnswersSemanticType | |
| stateOfAffairsType | KnowledgeAnswersValueType | Specifies the allowed type(s) that a value can have, e.g. for a Slot. For example, having both entity_type and string_type present in a ValueType field of a Slot means that the Slot can take _either_ an an EntityType _or_ StringType as a value, and nothing else. It may be helpful to think of this proto as being called something like AllAllowedValueTypes. To enforce a component-specific contract (go/contract-based-conformance) for allowed type(s), we add a repeated field view_specific_${x} for the type ${x}. For example, if we want a slot that can hold any type by default, but can only hold an integer when checking against the P2_LWA contract, then the following should be added to MeaningCatalog: slot { name: “integer_only_slot” type { // The default view has no sub_type or other options. number_type {} // The P2_LWA view specifies INTEGER sub_type. view_specific_number_types { sub_type: INTEGER component_specific_contracts: P2_LWA } } } See go/view-based-options-for-valuetype for more information. Next tag id: 26 LINT.IfChange | KnowledgeAnswersStateOfAffairsType | |
| stringType | KnowledgeAnswersValueType | Specifies the allowed type(s) that a value can have, e.g. for a Slot. For example, having both entity_type and string_type present in a ValueType field of a Slot means that the Slot can take _either_ an an EntityType _or_ StringType as a value, and nothing else. It may be helpful to think of this proto as being called something like AllAllowedValueTypes. To enforce a component-specific contract (go/contract-based-conformance) for allowed type(s), we add a repeated field view_specific_${x} for the type ${x}. For example, if we want a slot that can hold any type by default, but can only hold an integer when checking against the P2_LWA contract, then the following should be added to MeaningCatalog: slot { name: “integer_only_slot” type { // The default view has no sub_type or other options. number_type {} // The P2_LWA view specifies INTEGER sub_type. view_specific_number_types { sub_type: INTEGER component_specific_contracts: P2_LWA } } } See go/view-based-options-for-valuetype for more information. Next tag id: 26 LINT.IfChange | KnowledgeAnswersStringType | |
| timezoneType | KnowledgeAnswersValueType | Specifies the allowed type(s) that a value can have, e.g. for a Slot. For example, having both entity_type and string_type present in a ValueType field of a Slot means that the Slot can take _either_ an an EntityType _or_ StringType as a value, and nothing else. It may be helpful to think of this proto as being called something like AllAllowedValueTypes. To enforce a component-specific contract (go/contract-based-conformance) for allowed type(s), we add a repeated field view_specific_${x} for the type ${x}. For example, if we want a slot that can hold any type by default, but can only hold an integer when checking against the P2_LWA contract, then the following should be added to MeaningCatalog: slot { name: “integer_only_slot” type { // The default view has no sub_type or other options. number_type {} // The P2_LWA view specifies INTEGER sub_type. view_specific_number_types { sub_type: INTEGER component_specific_contracts: P2_LWA } } } See go/view-based-options-for-valuetype for more information. Next tag id: 26 LINT.IfChange | KnowledgeAnswersTimeZoneType | |
| trackingNumberType | KnowledgeAnswersValueType | Specifies the allowed type(s) that a value can have, e.g. for a Slot. For example, having both entity_type and string_type present in a ValueType field of a Slot means that the Slot can take _either_ an an EntityType _or_ StringType as a value, and nothing else. It may be helpful to think of this proto as being called something like AllAllowedValueTypes. To enforce a component-specific contract (go/contract-based-conformance) for allowed type(s), we add a repeated field view_specific_${x} for the type ${x}. For example, if we want a slot that can hold any type by default, but can only hold an integer when checking against the P2_LWA contract, then the following should be added to MeaningCatalog: slot { name: “integer_only_slot” type { // The default view has no sub_type or other options. number_type {} // The P2_LWA view specifies INTEGER sub_type. view_specific_number_types { sub_type: INTEGER component_specific_contracts: P2_LWA } } } See go/view-based-options-for-valuetype for more information. Next tag id: 26 LINT.IfChange | KnowledgeAnswersTrackingNumberType | |
| viewSpecificNumberTypes | LINT.IfChange Contract-specific typing (go/view-based-options-for-valuetype). NOTE: To facilitate writing macros for view-specific filtering, all view-specific fields should be named with the format “view_specific_${singular_field}s” — e.g., for the singular field |number_type|, the view-specific repeated field is |view_specific_number_types|. LINT.ThenChange( //depot/google3/nlp/meaning/remodel/meaning_remodeling_utils.cc:ViewSpecificTypes, //depot/google3/nlp/meaning/analyzer/checks/component_specific_contracts_checks.cc:ViewSpecificTypes) | KnowledgeAnswersValueType | Specifies the allowed type(s) that a value can have, e.g. for a Slot. For example, having both entity_type and string_type present in a ValueType field of a Slot means that the Slot can take _either_ an an EntityType _or_ StringType as a value, and nothing else. It may be helpful to think of this proto as being called something like AllAllowedValueTypes. To enforce a component-specific contract (go/contract-based-conformance) for allowed type(s), we add a repeated field view_specific_${x} for the type ${x}. For example, if we want a slot that can hold any type by default, but can only hold an integer when checking against the P2_LWA contract, then the following should be added to MeaningCatalog: slot { name: “integer_only_slot” type { // The default view has no sub_type or other options. number_type {} // The P2_LWA view specifies INTEGER sub_type. view_specific_number_types { sub_type: INTEGER component_specific_contracts: P2_LWA } } } See go/view-based-options-for-valuetype for more information. Next tag id: 26 LINT.IfChange | list(KnowledgeAnswersNumberType) |
| days | A day of month, 1-31. If present, year and month must be present as well, and must form a valid date. | KnowledgeGraphDateTimeProto | integer | |
| hours | Hour of the day, 0-23 | KnowledgeGraphDateTimeProto | integer | |
| microseconds | Microsecond, in the interval [0, 999999]. If present, seconds have to be present as well. | KnowledgeGraphDateTimeProto | integer | |
| minutes | Minute, 0-59. If present, hours have to be present as well. | KnowledgeGraphDateTimeProto | integer | |
| months | A month, 1-12. If present, year must be present as well. | KnowledgeGraphDateTimeProto | integer | |
| seconds | Second, in the interval [0, 60], where 60 is an exceptional value reserved for leap seconds. If present, minutes have to be present as well. | KnowledgeGraphDateTimeProto | integer | |
| tzOffset | Timezone offset in seconds (can be positive/negative). If present, hours have to be present as well If absent, we expect the time above to be in local time (a.k.a. civil time, go/httat#civil_time). | KnowledgeGraphDateTimeProto | String | |
| years | A year. | KnowledgeGraphDateTimeProto | integer | |
| predicateObjs | predicate_objs.pred should be unique within the list. | KnowledgeGraphNestedStruct | A nested struct is a recursive tree structure for storing a set of triples. more info can be found at go/nested-struct-primer | list(KnowledgeGraphNestedStructPredicateObjs) |
| objs | KnowledgeGraphNestedStructPredicateObjs | list(KnowledgeGraphTripleObj) | ||
| pred | KnowledgeGraphNestedStructPredicateObjs | String | ||
| pred | The qualifier pred must be a qualifier property defined in KG schema as applying to the predicate of the triple this qualifier is attached to. | KnowledgeGraphQualifier | A qualifier represents an extra piece of context about an assertion/fact. See go/qualifiers-in-kg for more details. | String |
| value | KnowledgeGraphQualifier | A qualifier represents an extra piece of context about an assertion/fact. See go/qualifiers-in-kg for more details. | KnowledgeGraphTripleObj | |
| qualifiers | KnowledgeGraphQualifierSet | A QualifierSet represents a grouping of qualifiers that together with an SPO make up a logical assertion or fact. One triple can contain multiple qualifier sets and thus represent several different assertions about the same SPO. | list(KnowledgeGraphQualifier) | |
| isNegation | If is_negation is set to true then this triple is considered a statement that the fact is false. This allows for the storage of both what we know to be true and what we know to be false. | KnowledgeGraphTriple | A Triple is a representation of data with a Subject, a Predicate, and an Object, For example: (Triple, IS-A, “data representation”). Triples are a very good representation of data where the relationship between data points is significant, because the Object of a Triple can be the Subject of another Triple: (Triple, HAS-A, Subject) (Subject, IS-A, “Term of a proposition”) The ease with which Triples can represent relationships makes them an excellent candidate for representing graphs. Next id: 21 | boolean |
| obj | obj is the value of a relationship. | KnowledgeGraphTriple | A Triple is a representation of data with a Subject, a Predicate, and an Object, For example: (Triple, IS-A, “data representation”). Triples are a very good representation of data where the relationship between data points is significant, because the Object of a Triple can be the Subject of another Triple: (Triple, HAS-A, Subject) (Subject, IS-A, “Term of a proposition”) The ease with which Triples can represent relationships makes them an excellent candidate for representing graphs. Next id: 21 | KnowledgeGraphTripleObj |
| pred | pred is an arbitrary node id representing the predicate (name) of a graph relationship. | KnowledgeGraphTriple | A Triple is a representation of data with a Subject, a Predicate, and an Object, For example: (Triple, IS-A, “data representation”). Triples are a very good representation of data where the relationship between data points is significant, because the Object of a Triple can be the Subject of another Triple: (Triple, HAS-A, Subject) (Subject, IS-A, “Term of a proposition”) The ease with which Triples can represent relationships makes them an excellent candidate for representing graphs. Next id: 21 | String |
| provenance | KnowledgeGraphTriple | A Triple is a representation of data with a Subject, a Predicate, and an Object, For example: (Triple, IS-A, “data representation”). Triples are a very good representation of data where the relationship between data points is significant, because the Object of a Triple can be the Subject of another Triple: (Triple, HAS-A, Subject) (Subject, IS-A, “Term of a proposition”) The ease with which Triples can represent relationships makes them an excellent candidate for representing graphs. Next id: 21 | list(KnowledgeGraphTripleProvenance) | |
| qualifierSets | WARNING: This is currently defined for experimentation purposes only. Please do not set. Data set in this field will not be published to any systems downstream of Livegraph. Together with the SPO of this triple, each qualifier set here represents a different logical assertion/fact. | KnowledgeGraphTriple | A Triple is a representation of data with a Subject, a Predicate, and an Object, For example: (Triple, IS-A, “data representation”). Triples are a very good representation of data where the relationship between data points is significant, because the Object of a Triple can be the Subject of another Triple: (Triple, HAS-A, Subject) (Subject, IS-A, “Term of a proposition”) The ease with which Triples can represent relationships makes them an excellent candidate for representing graphs. Next id: 21 | list(KnowledgeGraphQualifierSet) |
| sub | sub is an arbitrary node id representing the source entity of a graph relationship. | KnowledgeGraphTriple | A Triple is a representation of data with a Subject, a Predicate, and an Object, For example: (Triple, IS-A, “data representation”). Triples are a very good representation of data where the relationship between data points is significant, because the Object of a Triple can be the Subject of another Triple: (Triple, HAS-A, Subject) (Subject, IS-A, “Term of a proposition”) The ease with which Triples can represent relationships makes them an excellent candidate for representing graphs. Next id: 21 | String |
| boolValue | KnowledgeGraphTripleObj | boolean | ||
| datetimeValue | KnowledgeGraphTripleObj | KnowledgeGraphDateTimeProto | ||
| doubleValue | KnowledgeGraphTripleObj | float | ||
| durationValue | seconds | KnowledgeGraphTripleObj | String | |
| idValue | An id representing an entity (mid or hrid) | KnowledgeGraphTripleObj | String | |
| int64Value | KnowledgeGraphTripleObj | String | ||
| locale | The language code for the object value. It must be a BCP 47-compliant language tag (b/10005172). See also go/kg-data-l10n. | KnowledgeGraphTripleObj | String | |
| nestedStructValue | KnowledgeGraphTripleObj | KnowledgeGraphNestedStruct | ||
| protoValue | KnowledgeGraphTripleObj | KnowledgeGraphTripleObjProto | ||
| s2cellId | KnowledgeGraphTripleObj | String | ||
| stringValue | A UTF-8 string value to be used for the following expected schema types: – /type/rawstring – /type/text – /type/key | KnowledgeGraphTripleObj | String | |
| uint64Value | KnowledgeGraphTripleObj | String | ||
| uriValue | A UTF-8 string value to be used for expected type /type/uri – b/68760994. | KnowledgeGraphTripleObj | String | |
| data | The encoded proto data. | KnowledgeGraphTripleObjProto | String | |
| descriptorFullName | The full name of the proto descriptor, such as ‘music.AlbumSummary’. | KnowledgeGraphTripleObjProto | String | |
| accessRequired | Specifies the contract or legal visibility required to see the Triple. See go/kg-triple-level-access-controls for details and background. Note that we use an int32 here so that we won’t lose values when decoding on a stale binary. The int32 references to the enum storage_graph_bfg.Triple.Provenance.AccessRequirement. | KnowledgeGraphTripleProvenance | Message containing information about the source of this triple. See go/kg-provenance for an explanation of the fields. | integer |
| creator | Historically, this field was used to encode the Freebase User ID, Google username, or Google MDB group that was responsible for the pipeline that is producing this data. However, there is currently no horizontal validation in place, and as of Q3 2018, this field is used essentially as a free-form string by multiple data providers. NOTE: Do not use this field in new pipelines without first consulting with the OWNERS of this proto. | KnowledgeGraphTripleProvenance | Message containing information about the source of this triple. See go/kg-provenance for an explanation of the fields. | String |
| datasetMid | The dataset which asserted this data. Must be a valid mid. See go/kg-provenance | KnowledgeGraphTripleProvenance | Message containing information about the source of this triple. See go/kg-provenance for an explanation of the fields. | String |
| isSupportingData | Indicates that the corresponding data is supporting evidence for reconciliation only, and is *not* an assertion that should be visible to other systems or to external users. Note that this also means that no provenances indicating supporting data will be visible in the composed graph. Please see go/supporting-kg-triples-design-doc for additional details and background. | KnowledgeGraphTripleProvenance | Message containing information about the source of this triple. See go/kg-provenance for an explanation of the fields. | boolean |
| lgMetadata | Internal metadata used by Livegraph and possibly other horizontal KG infra systems. This is not part of the logical triple or its provenance, and contents may not be visible downstream of LG. | KnowledgeGraphTripleProvenance | Message containing information about the source of this triple. See go/kg-provenance for an explanation of the fields. | StorageGraphBfgLivegraphProvenanceMetadata |
| policyMetadata | Metadata specifying data governance policies. This information will be processed and enforced in KE systems. For more context, see go/ke-triple-dg-policy-and-metadata. WARNING: This field is WIP and please do not populate it without consulting ke-data-governance@. | KnowledgeGraphTripleProvenance | Message containing information about the source of this triple. See go/kg-provenance for an explanation of the fields. | StorageGraphBfgPolicyMetadata |
| process | An identifier for the process that asserted this triple. | KnowledgeGraphTripleProvenance | Message containing information about the source of this triple. See go/kg-provenance for an explanation of the fields. | String |
| restrictions | KnowledgeGraphTripleProvenance | Message containing information about the source of this triple. See go/kg-provenance for an explanation of the fields. | list(String) | |
| sourceCategory | Used to measure impact of 3P contributions. See go/ke-metrics. | KnowledgeGraphTripleProvenance | Message containing information about the source of this triple. See go/kg-provenance for an explanation of the fields. | String |
| sourceDocId | The websearch doc_id of the source_url. Used in conjunction with source_category for measuring 3P contributions. | KnowledgeGraphTripleProvenance | Message containing information about the source of this triple. See go/kg-provenance for an explanation of the fields. | String |
| sourceUrl | If the triple was extracted from the web, the source URL where the assertion was found. Used for citation if needed (see restrictions field below). | KnowledgeGraphTripleProvenance | Message containing information about the source of this triple. See go/kg-provenance for an explanation of the fields. | String |
| spiiCertification | A fact about potentially sensitive personal info (http://what/SPII) can be “certified” iff it meets specific requirements. See go/kg-spii-certification for details. | KnowledgeGraphTripleProvenance | Message containing information about the source of this triple. See go/kg-provenance for an explanation of the fields. | StorageGraphBfgSpiiCertification |
| featureId | (Mandatory) Oyster ID. | KnowledgeVerticalsWeatherProtoUserSpecifiedLocation | A user specified location to trigger weather for a specific location. Also it can be generalized for other verticals. | GeostoreFeatureIdProto |
| latLng | (Mandatory) Coordinates of the location for which weather is requested. | KnowledgeVerticalsWeatherProtoUserSpecifiedLocation | A user specified location to trigger weather for a specific location. Also it can be generalized for other verticals. | GoogleTypeLatLng |
| locationName | The name to display. If specified it will override the formatted address of “feature_id”. | KnowledgeVerticalsWeatherProtoUserSpecifiedLocation | A user specified location to trigger weather for a specific location. Also it can be generalized for other verticals. | String |
| mid | MID corresponding to the location from feature_id. | KnowledgeVerticalsWeatherProtoUserSpecifiedLocation | A user specified location to trigger weather for a specific location. Also it can be generalized for other verticals. | String |
| timezone | The timezone to display the current conditions observation time. Optional and will override the timezone of “feature_id”. | KnowledgeVerticalsWeatherProtoUserSpecifiedLocation | A user specified location to trigger weather for a specific location. Also it can be generalized for other verticals. | String |
| CountryCode | For Courts, the country the court is in. For Statues,? 3 leter country code ISO 3166 alpha2 | LegalCitation | String | |
| ParseType | LegalCitation | integer | ||
| State | State or province of the court or statue (if applicable) What standard? | LegalCitation | String | |
| Type | DocType | LegalCitation | integer | |
| courtdocument | LegalCitation | LegalCitationCourtDocument | ||
| law | LegalCitation | LegalCitationLaw | ||
| ArguedBefore | One entry per judge who listened to the case in this court | LegalCitationCourtDocument | Information about a published version of the document. Not all references/documents will have this because some will be vendor and/or media neutral. | list(LegalPerson) |
| ArguedDate | LegalCitationCourtDocument | Information about a published version of the document. Not all references/documents will have this because some will be vendor and/or media neutral. | LegalDate | |
| CertiorariCourtName | For an appeal, the name of the lower court that sent this up Abbreviation form? Verbose form? | LegalCitationCourtDocument | Information about a published version of the document. Not all references/documents will have this because some will be vendor and/or media neutral. | String |
| CertiorariRelationship | LegalCitationCourtDocument | Information about a published version of the document. Not all references/documents will have this because some will be vendor and/or media neutral. | integer | |
| CourtTerm | Usually the name of a month. Not sure really what it means. | LegalCitationCourtDocument | Information about a published version of the document. Not all references/documents will have this because some will be vendor and/or media neutral. | String |
| DecidedDate | Various dates related to the generation of document most of these are opinion-centric | LegalCitationCourtDocument | Information about a published version of the document. Not all references/documents will have this because some will be vendor and/or media neutral. | LegalDate |
| FiledDate | LegalCitationCourtDocument | Information about a published version of the document. Not all references/documents will have this because some will be vendor and/or media neutral. | LegalDate | |
| MemoID | Not sure what this is. But I’ve seen it. | LegalCitationCourtDocument | Information about a published version of the document. Not all references/documents will have this because some will be vendor and/or media neutral. | String |
| ModifiedDate | LegalCitationCourtDocument | Information about a published version of the document. Not all references/documents will have this because some will be vendor and/or media neutral. | LegalDate | |
| Syllabus | A summary of the document or a syllabus for this document | LegalCitationCourtDocument | Information about a published version of the document. Not all references/documents will have this because some will be vendor and/or media neutral. | String |
| court | LegalCitationCourtDocument | Information about a published version of the document. Not all references/documents will have this because some will be vendor and/or media neutral. | LegalCitationCourtDocumentCourt | |
| opinioninfo | LegalCitationCourtDocument | Information about a published version of the document. Not all references/documents will have this because some will be vendor and/or media neutral. | list(LegalCitationCourtDocumentOpinionInfo) | |
| perdocketinfo | LegalCitationCourtDocument | Information about a published version of the document. Not all references/documents will have this because some will be vendor and/or media neutral. | list(LegalCitationCourtDocumentPerDocketInfo) | |
| pub | LegalCitationCourtDocument | Information about a published version of the document. Not all references/documents will have this because some will be vendor and/or media neutral. | list(LegalCitationCourtDocumentPub) | |
| unknowndate | LegalCitationCourtDocument | Information about a published version of the document. Not all references/documents will have this because some will be vendor and/or media neutral. | list(LegalCitationCourtDocumentUnknownDate) | |
| DisplayName | The name of the court to be displayed to users. | LegalCitationCourtDocumentCourt | String | |
| Level | Maybe be redundant with the Name. We can remove this later if we don’t find it useful. Court Level | LegalCitationCourtDocumentCourt | integer | |
| Name | Court id for matching records; “name” is a historic misnomer. | LegalCitationCourtDocumentCourt | String | |
| OriginalName | The name of the court as taken directly from the source document | LegalCitationCourtDocumentCourt | String | |
| namecomponent | LegalCitationCourtDocumentCourt | list(LegalCitationCourtDocumentCourtNameComponent) | ||
| Text | LegalCitationCourtDocumentCourtNameComponent | The name broken down into its various components, such as core court, state, and district | String | |
| Type | LegalCitationCourtDocumentCourtNameComponent | The name broken down into its various components, such as core court, state, and district | integer | |
| Bench | LegalCitationCourtDocumentOpinionInfo | A variety of opinions may be published as a single document. We have one OpinionInfo for each opinion About the “CONCURRING” opinion type: It means that a judge “concurs” to the conclusion (judegment) of the majority of the court, however, he may not agree with the argument in the primary opinion. If multiple judges “concur” or “dissent” the primary opinion, then one judge delivers their opinion, and other judges are said to “join” him. | integer | |
| DeliveredBy | if Type == PER_CURIAM, then DeliveredBy is unnecessary since it is delivered by the full court. Who delivered the opinion? | LegalCitationCourtDocumentOpinionInfo | A variety of opinions may be published as a single document. We have one OpinionInfo for each opinion About the “CONCURRING” opinion type: It means that a judge “concurs” to the conclusion (judegment) of the majority of the court, however, he may not agree with the argument in the primary opinion. If multiple judges “concur” or “dissent” the primary opinion, then one judge delivers their opinion, and other judges are said to “join” him. | LegalPerson |
| JoinedBy | Who agrees with the opinion | LegalCitationCourtDocumentOpinionInfo | A variety of opinions may be published as a single document. We have one OpinionInfo for each opinion About the “CONCURRING” opinion type: It means that a judge “concurs” to the conclusion (judegment) of the majority of the court, however, he may not agree with the argument in the primary opinion. If multiple judges “concur” or “dissent” the primary opinion, then one judge delivers their opinion, and other judges are said to “join” him. | LegalPerson |
| Type | OpinionType | LegalCitationCourtDocumentOpinionInfo | A variety of opinions may be published as a single document. We have one OpinionInfo for each opinion About the “CONCURRING” opinion type: It means that a judge “concurs” to the conclusion (judegment) of the majority of the court, however, he may not agree with the argument in the primary opinion. If multiple judges “concur” or “dissent” the primary opinion, then one judge delivers their opinion, and other judges are said to “join” him. | integer |
| DocketID | An alpha-numeric (usually, mostly numeric) string used to identify the case by the court | LegalCitationCourtDocumentPerDocketInfo | Information associated with a docket. Note that multiple dockets can be combined and argued as one and produce a single opinion | String |
| Petitioner | Who is bringing the action? (X in X vs. Y) | LegalCitationCourtDocumentPerDocketInfo | Information associated with a docket. Note that multiple dockets can be combined and argued as one and produce a single opinion | list(LegalPerson) |
| PetitionerCounsel | Who represents the petitioner? | LegalCitationCourtDocumentPerDocketInfo | Information associated with a docket. Note that multiple dockets can be combined and argued as one and produce a single opinion | list(LegalPerson) |
| Respondent | Who is responding to the action? (Y in X vs. Y) | LegalCitationCourtDocumentPerDocketInfo | Information associated with a docket. Note that multiple dockets can be combined and argued as one and produce a single opinion | list(LegalPerson) |
| RespondentCounsel | Who represents the respondent? | LegalCitationCourtDocumentPerDocketInfo | Information associated with a docket. Note that multiple dockets can be combined and argued as one and produce a single opinion | list(LegalPerson) |
| Topic | The “in re” or “matter of” field. | LegalCitationCourtDocumentPerDocketInfo | Information associated with a docket. Note that multiple dockets can be combined and argued as one and produce a single opinion | String |
| Page | Page number | LegalCitationCourtDocumentPub | String | |
| Paragraph | Paragraph number | LegalCitationCourtDocumentPub | String | |
| Reporter | The publisher of the opinion. For example, ‘U.S.’ – United States Reports ‘S. Ct.’ – Supreme Court Reporter ‘L. Ed. 2d’ – Lawyers Edition Second Series | LegalCitationCourtDocumentPub | String | |
| Volume | For documents published by a court reporter. Vendor/Media neutral citations will probably not have this. | LegalCitationCourtDocumentPub | integer | |
| Year | This is the publication year. In many citations, there is one year listed and it is typically the year the opinion was handed down. For example: Roe v. Wade, 410 U.S. 113 (1973) Occasionally, the publication year of the reporter is included. This happens typically when the law reporter volume numbers are numbered within a calendar year. For example, Swiss Bank Corp. v. Air Canada, [1988] 1 F.C. 71. It some (most?) areas, publication date is denoted by [] while opinion date is denoted by (). | LegalCitationCourtDocumentPub | integer | |
| Date | LegalCitationCourtDocumentUnknownDate | Dates that we didn’t fully parse, so we don’t know exactly what they are, but we are keeping in case it’s all we have. | LegalDate | |
| Description | LegalCitationCourtDocumentUnknownDate | Dates that we didn’t fully parse, so we don’t know exactly what they are, but we are keeping in case it’s all we have. | String | |
| RevisionDate | LegalCitationLaw | LegalDate | ||
| Status | LawStatus | LegalCitationLaw | integer | |
| Type | LawType | LegalCitationLaw | integer | |
| collectionname | LegalCitationLaw | LegalCitationLawCollectionName | ||
| level | LegalCitationLaw | list(LegalCitationLawLevel) | ||
| Normalized | LegalCitationLawCollectionName | this is used to store information about law collections Normalized is the normalized name for the law (e.g., USC for USCA and USCS) Source is the text that represents the law in the citation | String | |
| Source | LegalCitationLawCollectionName | this is used to store information about law collections Normalized is the normalized name for the law (e.g., USC for USCA and USCS) Source is the text that represents the law in the citation | String | |
| Depth | A counter that specifies the depth of the level in the parse | LegalCitationLawLevel | Law have tree-like sturcture (title, section, etc), but the levels and their names are not fixed. e.g., we could have: US Constitution -> Article 3 -> Section 4, OR, US Code -> Title 12 -> Chapter 6 -> Sub-chapter I -> Section 602, OR, US Code -> Title 10 -> Sub-title A -> Part 2 -> Chapter 32 -> Section 523. We use a repeated group to represent this structure. NOTE: Always insert higher levels before lower levels, | integer |
| LevelTypeNormalized | “SECTION, TITLE, PART, etc.” | LegalCitationLawLevel | Law have tree-like sturcture (title, section, etc), but the levels and their names are not fixed. e.g., we could have: US Constitution -> Article 3 -> Section 4, OR, US Code -> Title 12 -> Chapter 6 -> Sub-chapter I -> Section 602, OR, US Code -> Title 10 -> Sub-title A -> Part 2 -> Chapter 32 -> Section 523. We use a repeated group to represent this structure. NOTE: Always insert higher levels before lower levels, | String |
| LevelTypeSourceText | “Section, Sect., §, etc” | LegalCitationLawLevel | Law have tree-like sturcture (title, section, etc), but the levels and their names are not fixed. e.g., we could have: US Constitution -> Article 3 -> Section 4, OR, US Code -> Title 12 -> Chapter 6 -> Sub-chapter I -> Section 602, OR, US Code -> Title 10 -> Sub-title A -> Part 2 -> Chapter 32 -> Section 523. We use a repeated group to represent this structure. NOTE: Always insert higher levels before lower levels, | String |
| LevelTypeString | deprecated | LegalCitationLawLevel | Law have tree-like sturcture (title, section, etc), but the levels and their names are not fixed. e.g., we could have: US Constitution -> Article 3 -> Section 4, OR, US Code -> Title 12 -> Chapter 6 -> Sub-chapter I -> Section 602, OR, US Code -> Title 10 -> Sub-title A -> Part 2 -> Chapter 32 -> Section 523. We use a repeated group to represent this structure. NOTE: Always insert higher levels before lower levels, | String |
| Name | The name of the chapter/section/etc. | LegalCitationLawLevel | Law have tree-like sturcture (title, section, etc), but the levels and their names are not fixed. e.g., we could have: US Constitution -> Article 3 -> Section 4, OR, US Code -> Title 12 -> Chapter 6 -> Sub-chapter I -> Section 602, OR, US Code -> Title 10 -> Sub-title A -> Part 2 -> Chapter 32 -> Section 523. We use a repeated group to represent this structure. NOTE: Always insert higher levels before lower levels, | String |
| Type | deprecated | LegalCitationLawLevel | Law have tree-like sturcture (title, section, etc), but the levels and their names are not fixed. e.g., we could have: US Constitution -> Article 3 -> Section 4, OR, US Code -> Title 12 -> Chapter 6 -> Sub-chapter I -> Section 602, OR, US Code -> Title 10 -> Sub-title A -> Part 2 -> Chapter 32 -> Section 523. We use a repeated group to represent this structure. NOTE: Always insert higher levels before lower levels, | integer |
| Value | “3”, “42(a)”, etc | LegalCitationLawLevel | Law have tree-like sturcture (title, section, etc), but the levels and their names are not fixed. e.g., we could have: US Constitution -> Article 3 -> Section 4, OR, US Code -> Title 12 -> Chapter 6 -> Sub-chapter I -> Section 602, OR, US Code -> Title 10 -> Sub-title A -> Part 2 -> Chapter 32 -> Section 523. We use a repeated group to represent this structure. NOTE: Always insert higher levels before lower levels, | String |
| Day | LegalDate | integer | ||
| Month | LegalDate | integer | ||
| Year | LegalDate | integer | ||
| Description | LegalPerson | String | ||
| LastName | LegalPerson | String | ||
| OtherNames | LegalPerson | String | ||
| discretizedAestheticsScore | Aesthetics score discretized into range [0, 100]. | LensDiscoveryStyleAestheticsScoreSignals | Aesthetics score of a style image. Check http://go/styleai-indexing-g3doc#aesthetic-model for more details about the Style AI Aesthetics Model. | integer |
| version | LensDiscoveryStyleAestheticsScoreSignals | Aesthetics score of a style image. Check http://go/styleai-indexing-g3doc#aesthetic-model for more details about the Style AI Aesthetics Model. | String | |
| x1 | LensDiscoveryStyleBoundingBox | Bounding box with absolute integer coordinates. | integer | |
| x2 | LensDiscoveryStyleBoundingBox | Bounding box with absolute integer coordinates. | integer | |
| y1 | LensDiscoveryStyleBoundingBox | Bounding box with absolute integer coordinates. | integer | |
| y2 | LensDiscoveryStyleBoundingBox | Bounding box with absolute integer coordinates. | integer | |
| discretizedFaceVisibilityScore | The visibility of the face of the most iconic person in the image discretized into range [0, 100]. | LensDiscoveryStylePersonAttributes | This message holds person attributes from the Person Interpreter model (go/person-interpreter) and the Style AI Iconic Person Scorer (go/styleai-indexing-g3doc#iconic-person-scorer) for the most iconic person in a style image. Discretization of float values is recommended by CDS for cheaper and more efficient storage. Next ID: 11 | integer |
| discretizedFemaleConfidence | LensDiscoveryStylePersonAttributes | This message holds person attributes from the Person Interpreter model (go/person-interpreter) and the Style AI Iconic Person Scorer (go/styleai-indexing-g3doc#iconic-person-scorer) for the most iconic person in a style image. Discretization of float values is recommended by CDS for cheaper and more efficient storage. Next ID: 11 | integer | |
| discretizedMaleConfidence | Male and female confidence scores are discretized into the [0, 100] range. | LensDiscoveryStylePersonAttributes | This message holds person attributes from the Person Interpreter model (go/person-interpreter) and the Style AI Iconic Person Scorer (go/styleai-indexing-g3doc#iconic-person-scorer) for the most iconic person in a style image. Discretization of float values is recommended by CDS for cheaper and more efficient storage. Next ID: 11 | integer |
| discretizedPredictedAge | Age prediction is rounded to the first decimal place and multiplied by 10 (e.g. 12.3 -> 123). *** Not populated in Amarna for legal reasons. *** | LensDiscoveryStylePersonAttributes | This message holds person attributes from the Person Interpreter model (go/person-interpreter) and the Style AI Iconic Person Scorer (go/styleai-indexing-g3doc#iconic-person-scorer) for the most iconic person in a style image. Discretization of float values is recommended by CDS for cheaper and more efficient storage. Next ID: 11 | integer |
| discretizedVisualSaliencyScore | The area ratio of the most iconic person to the whole image discretized into range [0, 100]. | LensDiscoveryStylePersonAttributes | This message holds person attributes from the Person Interpreter model (go/person-interpreter) and the Style AI Iconic Person Scorer (go/styleai-indexing-g3doc#iconic-person-scorer) for the most iconic person in a style image. Discretization of float values is recommended by CDS for cheaper and more efficient storage. Next ID: 11 | integer |
| personBoundingBox | Bounding box of the most iconic person in the image. | LensDiscoveryStylePersonAttributes | This message holds person attributes from the Person Interpreter model (go/person-interpreter) and the Style AI Iconic Person Scorer (go/styleai-indexing-g3doc#iconic-person-scorer) for the most iconic person in a style image. Discretization of float values is recommended by CDS for cheaper and more efficient storage. Next ID: 11 | LensDiscoveryStyleBoundingBox |
| personVisibilityScores | LensDiscoveryStylePersonAttributes | This message holds person attributes from the Person Interpreter model (go/person-interpreter) and the Style AI Iconic Person Scorer (go/styleai-indexing-g3doc#iconic-person-scorer) for the most iconic person in a style image. Discretization of float values is recommended by CDS for cheaper and more efficient storage. Next ID: 11 | LensDiscoveryStylePersonAttributesPersonVisibilityScores | |
| predictedAgeBucket | Bucketed version of the predicted age. | LensDiscoveryStylePersonAttributes | This message holds person attributes from the Person Interpreter model (go/person-interpreter) and the Style AI Iconic Person Scorer (go/styleai-indexing-g3doc#iconic-person-scorer) for the most iconic person in a style image. Discretization of float values is recommended by CDS for cheaper and more efficient storage. Next ID: 11 | String |
| version | LensDiscoveryStylePersonAttributes | This message holds person attributes from the Person Interpreter model (go/person-interpreter) and the Style AI Iconic Person Scorer (go/styleai-indexing-g3doc#iconic-person-scorer) for the most iconic person in a style image. Discretization of float values is recommended by CDS for cheaper and more efficient storage. Next ID: 11 | String | |
| discretizedPersonVisibilityScore | A measure of the visibility of the most iconic person between [0, 100], derived by combining all label predictions by the Person Visibility model according to go/person-visibility-formula. Higher values indicate greater visibility while lower values indicate lesser visibility. | LensDiscoveryStylePersonAttributesPersonVisibilityScores | integer | |
| personVisibilityPredictions | Repeated for # of PersonVisibility types. | LensDiscoveryStylePersonAttributesPersonVisibilityScores | list(LensDiscoveryStylePersonAttributesPersonVisibilityScoresPersonVisibilityPrediction) | |
| discretizedIconicPersonVisibilityConfidence | Confidence score of the visibility type prediction discretized into range [0, 100]. | LensDiscoveryStylePersonAttributesPersonVisibilityScoresPersonVisibilityPrediction | integer | |
| iconicPersonVisibilityType | Classification of how much of the body of the most iconic person in the image is visible. | LensDiscoveryStylePersonAttributesPersonVisibilityScoresPersonVisibilityPrediction | String | |
| detectedPersons | Information of all detected people in the image, sorted by decreasing size of the bounding box. We store a maximum of 10 detected people. | LensDiscoveryStylePersonDetectionSignals | This message holds bounding boxes of detected people in the image. Next ID: 3 | list(LensDiscoveryStylePersonDetectionSignalsDetectedPerson) |
| version | LensDiscoveryStylePersonDetectionSignals | This message holds bounding boxes of detected people in the image. Next ID: 3 | String | |
| boundingBox | Bounding box of the detected person. | LensDiscoveryStylePersonDetectionSignalsDetectedPerson | Holds information about a detected person in the image. | LensDiscoveryStyleBoundingBox |
| styleImageTypePredictions | Repeated for # of StyleImageType types. | LensDiscoveryStyleStyleImageTypeSignals | Prediction of a style image type: Stage, Stock, Street or Outfits. Check http://go/styleai-indexing-g3doc#style-image-type-classifier for more details about the Style AI Style Image Type Classifier. | list(LensDiscoveryStyleStyleImageTypeSignalsStyleImageTypePrediction) |
| version | LensDiscoveryStyleStyleImageTypeSignals | Prediction of a style image type: Stage, Stock, Street or Outfits. Check http://go/styleai-indexing-g3doc#style-image-type-classifier for more details about the Style AI Style Image Type Classifier. | String | |
| discretizedStyleImageTypeConfidence | Style image type confidence discretized into range [0, 100]. | LensDiscoveryStyleStyleImageTypeSignalsStyleImageTypePrediction | integer | |
| styleImageType | Predicted style image type. | LensDiscoveryStyleStyleImageTypeSignalsStyleImageTypePrediction | String | |
| header | ListSnippetResponse | Data to generate the list snippets UI. | ListSnippetResponseRow | |
| isTable | Should list be formatted as a table? | ListSnippetResponse | Data to generate the list snippets UI. | boolean |
| row | ListSnippetResponse | Data to generate the list snippets UI. | list(ListSnippetResponseRow) | |
| totalRows | The number of rows annotated in the doc, of which ‘row’ is a subset. | ListSnippetResponse | Data to generate the list snippets UI. | integer |
| column | ListSnippetResponseRow | list(String) | ||
| category | The category associated with this chain, currently only used for subchains. | LocalsearchChainId | An unique identification of a chain. The following are the possible chain id forms: 1) prominent_entity_id only: The entity uniquely represents a chain, which may have multiple sitechunks. 2) sitechunk only: The sitechunk uniquely represents a chain while the chain currently does not have an entity in KG. 3) prominent_entity_id + sitechunk: The chain could be represented by the entity, but not merged at last, and the sitechunks represents the chain better. 4) prominent_entity_id + category: There are multiple subchains for the prominent entity, and category is used to differentiate subchains. NOTE: the size and complexity of the ChainId proto has implications in the serving system and should be thoughtfully kept under control. | String |
| prominentEntityId | The Knowledge Graph (KG) entity of the chain, found and used in chain mining. | LocalsearchChainId | An unique identification of a chain. The following are the possible chain id forms: 1) prominent_entity_id only: The entity uniquely represents a chain, which may have multiple sitechunks. 2) sitechunk only: The sitechunk uniquely represents a chain while the chain currently does not have an entity in KG. 3) prominent_entity_id + sitechunk: The chain could be represented by the entity, but not merged at last, and the sitechunks represents the chain better. 4) prominent_entity_id + category: There are multiple subchains for the prominent entity, and category is used to differentiate subchains. NOTE: the size and complexity of the ChainId proto has implications in the serving system and should be thoughtfully kept under control. | String |
| sitechunk | The website sitechunk/domain that is owned by the chain. | LocalsearchChainId | An unique identification of a chain. The following are the possible chain id forms: 1) prominent_entity_id only: The entity uniquely represents a chain, which may have multiple sitechunks. 2) sitechunk only: The sitechunk uniquely represents a chain while the chain currently does not have an entity in KG. 3) prominent_entity_id + sitechunk: The chain could be represented by the entity, but not merged at last, and the sitechunks represents the chain better. 4) prominent_entity_id + category: There are multiple subchains for the prominent entity, and category is used to differentiate subchains. NOTE: the size and complexity of the ChainId proto has implications in the serving system and should be thoughtfully kept under control. | String |
| actionType | The action type of this action metadata. | LocalsearchProtoInternalFoodOrderingActionMetadata | * Proto representing the metadata associated with food ordering internal action. Next ID: 13 | String |
| hasPrimarilyFoodIntent | If true, it indicates that the merchant has a primarily food intent. This field will only be set when enable_food_gcid_strict_check in FoodOrderingRestrictionProto is true, see go/togo-unified:overlapping-for-le. See go/togo-unified-gcid for how this is calculated. | LocalsearchProtoInternalFoodOrderingActionMetadata | * Proto representing the metadata associated with food ordering internal action. Next ID: 13 | boolean |
| isOutOfOperationalHours | If set, indicates that the food ordering service is out of operational hours. This could only be populated if the request explicitly asks for ignore_operational_hours in request (universalsearch/rpc/geo/food_ordering_restriction.proto). Design doc: go/fo-persistent-v1. | LocalsearchProtoInternalFoodOrderingActionMetadata | * Proto representing the metadata associated with food ordering internal action. Next ID: 13 | boolean |
| isWhitelistedExternalRestaurant | When true, indicates that this is a whitelisted restaurant from a first party (but non FO) partner, i.e. a merchant from the orderig app, who is Google owned first party food ordering platform. Design doc: go/onboard-mavn-to-fo. Tracking bug: b/150331855 | LocalsearchProtoInternalFoodOrderingActionMetadata | * Proto representing the metadata associated with food ordering internal action. Next ID: 13 | boolean |
| nextOpeningTime | Next opening time when the food ordering service will be available. This is only present if the unavailability reason is OUT_OF_OPERATIONAL_HOURS. | LocalsearchProtoInternalFoodOrderingActionMetadata | * Proto representing the metadata associated with food ordering internal action. Next ID: 13 | DateTime |
| onlyOrderAheadServicesAvailable | Indicates whether only order ahead services are available. Order ahead services allow only to place order for future and ASAP order can not be placed via them. | LocalsearchProtoInternalFoodOrderingActionMetadata | * Proto representing the metadata associated with food ordering internal action. Next ID: 13 | boolean |
| serviceInfo | Aggregated service information by service type. Each service type would only have one ServiceInfo. Optional. | LocalsearchProtoInternalFoodOrderingActionMetadata | * Proto representing the metadata associated with food ordering internal action. Next ID: 13 | list(LocalsearchProtoInternalFoodOrderingActionMetadataServiceInfo) |
| supportedServiceType | Food ordering service type. | LocalsearchProtoInternalFoodOrderingActionMetadata | * Proto representing the metadata associated with food ordering internal action. Next ID: 13 | String |
| unavailabilityReason | Reason for unavailability of internal food ordering action. This is only present when FOPA is unavailable for a particular restaurant. When this is set, all other fields in this proto will not be populated. Note(fo-search): If there are log only partners and this particular restaurant is only supported because of log only partners, this field will not be set to NOT_INTEGRATED_WITH_FOPA. | LocalsearchProtoInternalFoodOrderingActionMetadata | * Proto representing the metadata associated with food ordering internal action. Next ID: 13 | String |
| availablePartnerId | Available partner’s id. | LocalsearchProtoInternalFoodOrderingActionMetadataAvailablePartnerInfo | Includes all partners that are either open now or supporting order ahead. | String |
| logOnly | Indicates whether the partner is log only. | LocalsearchProtoInternalFoodOrderingActionMetadataAvailablePartnerInfo | Includes all partners that are either open now or supporting order ahead. | boolean |
| availablePartnerInfo | Information about Food Ordering partner, which is used for whitelisting the partner in Food Ordering entry points such as Placesheet. | LocalsearchProtoInternalFoodOrderingActionMetadataServiceInfo | list(LocalsearchProtoInternalFoodOrderingActionMetadataAvailablePartnerInfo) | |
| maxWaitTimeSec | Maximum max_wait_time in second. | LocalsearchProtoInternalFoodOrderingActionMetadataServiceInfo | String | |
| minDeliveryFee | Only present for delivery case, service fee is not included. | LocalsearchProtoInternalFoodOrderingActionMetadataServiceInfo | GoogleTypeMoney | |
| minWaitTimeSec | Minimum min_wait_time in second. | LocalsearchProtoInternalFoodOrderingActionMetadataServiceInfo | String | |
| serviceType | Food ordering service type. Please note that only ServiceType.PICKUP and ServiceType.DELIVERY are valid values for this field. | LocalsearchProtoInternalFoodOrderingActionMetadataServiceInfo | String | |
| address | LocalWWWInfo | Next Id: 36 | list(LocalWWWInfoAddress) | |
| brickAndMortarStrength | LocalWWWInfo | Next Id: 36 | float | |
| cluster | LocalWWWInfo | Next Id: 36 | list(LocalWWWInfoCluster) | |
| docid | LocalWWWInfo | Next Id: 36 | String | |
| geotopicality | Information about geo locations, rather than individual businesses. | LocalWWWInfo | Next Id: 36 | RepositoryAnnotationsGeoTopicality |
| hours | LocalWWWInfo | Next Id: 36 | list(LocalWWWInfoOpeningHours) | |
| isLargeChain | Does this LocalWWWInfo represent a widely-distributed chain? | LocalWWWInfo | Next Id: 36 | boolean |
| isLargeLocalwwwinfo | LocalWWWInfo | Next Id: 36 | boolean | |
| phone | LocalWWWInfo | Next Id: 36 | list(LocalWWWInfoPhone) | |
| siteSiblings | These are per-document signals independent of any particular address. | LocalWWWInfo | Next Id: 36 | integer |
| url | These are for convenience during intermediate data processing, and should be cleared before the data gets into doc-joins. | LocalWWWInfo | Next Id: 36 | String |
| wrapptorItem | LocalWWWInfo | Next Id: 36 | list(LocalWWWInfoWrapptorItem) | |
| addrFprint | LocalWWWInfoAddress | These are the addresses, phone numbers, and opening hours related to this document, or the local businesses mentioned on this document. We currently populate these fields from web extractions, i.e, from the data present explicitly on the document, but in future, they can also be filled with data coming from the local index. We populate addresses and phone numbers only if there are <= 4 addresses and phone numbers on the document, respectively. This is primarily for space reasons. | String | |
| address | LocalWWWInfoAddress | These are the addresses, phone numbers, and opening hours related to this document, or the local businesses mentioned on this document. We currently populate these fields from web extractions, i.e, from the data present explicitly on the document, but in future, they can also be filled with data coming from the local index. We populate addresses and phone numbers only if there are <= 4 addresses and phone numbers on the document, respectively. This is primarily for space reasons. | GeostoreAddressProto | |
| latE7 | LocalWWWInfoAddress | These are the addresses, phone numbers, and opening hours related to this document, or the local businesses mentioned on this document. We currently populate these fields from web extractions, i.e, from the data present explicitly on the document, but in future, they can also be filled with data coming from the local index. We populate addresses and phone numbers only if there are <= 4 addresses and phone numbers on the document, respectively. This is primarily for space reasons. | integer | |
| lngE7 | LocalWWWInfoAddress | These are the addresses, phone numbers, and opening hours related to this document, or the local businesses mentioned on this document. We currently populate these fields from web extractions, i.e, from the data present explicitly on the document, but in future, they can also be filled with data coming from the local index. We populate addresses and phone numbers only if there are <= 4 addresses and phone numbers on the document, respectively. This is primarily for space reasons. | integer | |
| addrFprint | LocalWWWInfoCluster | String | ||
| annotationConfidence | Confidence score for business mention annotations which is copied from LocalEntityAnnotations::location_confidence. | LocalWWWInfoCluster | number | |
| clusterdocid | LocalWWWInfoCluster | String | ||
| clusterid | LocalWWWInfoCluster | String | ||
| confidence | Probability that this is the authority page of the business. Same as LocalListing.authority_page_probability, only set for pages with page_type_flags & AUTHORITY. | LocalWWWInfoCluster | number | |
| featureType | Feature type for this listing, from LocalListing::info::related_feature. A geostore::FeatureProto::TypeCategory. Intended primarily to indicate POI-ness (i.e., TYPE_ESTABLISHMENT_POI). | LocalWWWInfoCluster | integer | |
| hours | Opening hours for the business, from Local attributes and/or extracted annotations. | LocalWWWInfoCluster | GeostoreTimeScheduleProto | |
| hoursSource | LocalWWWInfoCluster | String | ||
| includeInIndex | LocalWWWInfoCluster | boolean | ||
| isPlusbox | TODO(local-universal) Consider deleting is_plusbox once the new scheme that uses make_plusbox_visible rolled out. | LocalWWWInfoCluster | boolean | |
| latitudeE6 | LocalWWWInfoCluster | integer | ||
| level | DEPRECATED / NO LONGER WRITTEN. URL path level from actual references to this webpage. | LocalWWWInfoCluster | integer | |
| longitudeE6 | LocalWWWInfoCluster | integer | ||
| makePlusboxVisible | A hint for frontend to decide whether this plusbox should be visible or not. | LocalWWWInfoCluster | boolean | |
| menuUrl | Menu link for the business. Currently only comes from Local attributes. | LocalWWWInfoCluster | list(String) | |
| pageTypeFlags | Type of the web reference. | LocalWWWInfoCluster | integer | |
| phoneFprint | LocalWWWInfoCluster | String | ||
| phoneNumber | LocalWWWInfoCluster | TelephoneNumber | ||
| postalAddress | LocalWWWInfoCluster | PostalAddress | ||
| relevance | DEPRECATED / NO LONGER WRITTEN. How relevant the webpage is to the business (clustering distance). Same as LocalListing::Reference.relevance. Typically only set for pages with (page_type_flags & WEB_EXTRACTION && !AUTHORITY). | LocalWWWInfoCluster | number | |
| showInSnippets | LocalWWWInfoCluster | boolean | ||
| source | LocalWWWInfoCluster | list(String) | ||
| title | LocalWWWInfoCluster | String | ||
| hours | LocalWWWInfoOpeningHours | Populated from StoreHoursAnnotations. | GeostoreTimeScheduleProto | |
| hoursFprint | LocalWWWInfoOpeningHours | Populated from StoreHoursAnnotations. | String | |
| phoneFprint | LocalWWWInfoPhone | String | ||
| phoneNumber | LocalWWWInfoPhone | TelephoneNumber | ||
| addrFprint | LocalWWWInfoWrapptorItem | A single WrapptorItem, with a business name, an address and a phone number. We keep only the fingerprints of address and phone number. The full address and phone protos will be elsewhere within LocalWWWInfo. | String | |
| bizName | LocalWWWInfoWrapptorItem | A single WrapptorItem, with a business name, an address and a phone number. We keep only the fingerprints of address and phone number. The full address and phone protos will be elsewhere within LocalWWWInfo. | String | |
| phoneFprint | LocalWWWInfoWrapptorItem | A single WrapptorItem, with a business name, an address and a phone number. We keep only the fingerprints of address and phone number. The full address and phone protos will be elsewhere within LocalWWWInfo. | String | |
| country | The country to crawl the country from, defaults to the default non-specified crawling node (which is interpreted by most web-servers as USA). When specified, the crawling will fetch the document from a node in that country instead. | LogsProtoIndexingCrawlerIdCrawlerIdProto | Proto-representation of the Crawler-ID in Web-Search (Alexandria-Scope). The string-representation (covered in //indexing/crawler_id/scope/alexandria/crawler_id.h) and the proto-representation are identical in meaning. For more information in regard to the crawler_id, please look at //depot/google3/indexing/crawler_id Used within the following components: – WebMirror: To understand the parsed crawler-ID and apply attributes within their own tables. – Serving : to identify the crawler-ID within the GenericSearchResponse, which implies being stored in the MDU and returned by ascorer to Superroot. – QSessions: To store the crawler-ID in all logged events for analysis. The default values represent the ’empty string’ crawler-ID for the Alexandria-scope. | String |
| deviceType | The device type, which maps into the useragent to be set when initiating the fetch-request, e.g. desktop-googlebot vs. smartphone-googlebot. | LogsProtoIndexingCrawlerIdCrawlerIdProto | Proto-representation of the Crawler-ID in Web-Search (Alexandria-Scope). The string-representation (covered in //indexing/crawler_id/scope/alexandria/crawler_id.h) and the proto-representation are identical in meaning. For more information in regard to the crawler_id, please look at //depot/google3/indexing/crawler_id Used within the following components: – WebMirror: To understand the parsed crawler-ID and apply attributes within their own tables. – Serving : to identify the crawler-ID within the GenericSearchResponse, which implies being stored in the MDU and returned by ascorer to Superroot. – QSessions: To store the crawler-ID in all logged events for analysis. The default values represent the ’empty string’ crawler-ID for the Alexandria-scope. | String |
| indexGrowthExptType | Specifies whether the document is a duplicated document from the index growth experiment, detailed at go/indexsize_exp, defaults to not in any experiment. | LogsProtoIndexingCrawlerIdCrawlerIdProto | Proto-representation of the Crawler-ID in Web-Search (Alexandria-Scope). The string-representation (covered in //indexing/crawler_id/scope/alexandria/crawler_id.h) and the proto-representation are identical in meaning. For more information in regard to the crawler_id, please look at //depot/google3/indexing/crawler_id Used within the following components: – WebMirror: To understand the parsed crawler-ID and apply attributes within their own tables. – Serving : to identify the crawler-ID within the GenericSearchResponse, which implies being stored in the MDU and returned by ascorer to Superroot. – QSessions: To store the crawler-ID in all logged events for analysis. The default values represent the ’empty string’ crawler-ID for the Alexandria-scope. | String |
| language | The language being set by the crawler. Defaults to UNKNOWN_LANGUAGE which indicates to not apply an accept-language header on the FetchRequest. When a language is specified, on crawling this language is converted into an accept-language header (e.g. GERMAN -> “Accept-language: de”). Script variations, e.g. ZH-HANS vs. ZH-HANT, are handled as different enum values (e.g. CHINESE vs. CHINESE_T). | LogsProtoIndexingCrawlerIdCrawlerIdProto | Proto-representation of the Crawler-ID in Web-Search (Alexandria-Scope). The string-representation (covered in //indexing/crawler_id/scope/alexandria/crawler_id.h) and the proto-representation are identical in meaning. For more information in regard to the crawler_id, please look at //depot/google3/indexing/crawler_id Used within the following components: – WebMirror: To understand the parsed crawler-ID and apply attributes within their own tables. – Serving : to identify the crawler-ID within the GenericSearchResponse, which implies being stored in the MDU and returned by ascorer to Superroot. – QSessions: To store the crawler-ID in all logged events for analysis. The default values represent the ’empty string’ crawler-ID for the Alexandria-scope. | String |
| languageCode | Language-code used for identifying the locale of the document. ‘language’ and ‘country’ above are used for web-based documents, representing the detected language of the document and the country it was crawled from. The language code here, however, rather represents an artifical language_code applied to manually translated webpages (e.g. feeds), for instance for the pidgin-usecase. They are limited to the set of III-codes being supported by the client, yet are beyond the enum in ‘language’, e.g. to support variants of English across different countries. | LogsProtoIndexingCrawlerIdCrawlerIdProto | Proto-representation of the Crawler-ID in Web-Search (Alexandria-Scope). The string-representation (covered in //indexing/crawler_id/scope/alexandria/crawler_id.h) and the proto-representation are identical in meaning. For more information in regard to the crawler_id, please look at //depot/google3/indexing/crawler_id Used within the following components: – WebMirror: To understand the parsed crawler-ID and apply attributes within their own tables. – Serving : to identify the crawler-ID within the GenericSearchResponse, which implies being stored in the MDU and returned by ascorer to Superroot. – QSessions: To store the crawler-ID in all logged events for analysis. The default values represent the ’empty string’ crawler-ID for the Alexandria-scope. | String |
| aggregateFlags | LogsSemanticInterpretationIntentQueryEntityLinkMetadata | Logs version of the repository_webref.EntityLinkMetadata proto Used to represent QRef implications | LogsSemanticInterpretationIntentQueryLinkKindFlags | |
| kindInfo | LogsSemanticInterpretationIntentQueryEntityLinkMetadata | Logs version of the repository_webref.EntityLinkMetadata proto Used to represent QRef implications | list(LogsSemanticInterpretationIntentQueryLinkKindInfo) | |
| cluster | LogsSemanticInterpretationIntentQueryLinkKindFlags | Logs version of the repository_webref.LinkKindFlags proto Used to represent QRef implications Next available tag: 8 | String | |
| geoContainment | LogsSemanticInterpretationIntentQueryLinkKindFlags | Logs version of the repository_webref.LinkKindFlags proto Used to represent QRef implications Next available tag: 8 | String | |
| implication | LogsSemanticInterpretationIntentQueryLinkKindFlags | Logs version of the repository_webref.LinkKindFlags proto Used to represent QRef implications Next available tag: 8 | String | |
| latentEntity | LogsSemanticInterpretationIntentQueryLinkKindFlags | Logs version of the repository_webref.LinkKindFlags proto Used to represent QRef implications Next available tag: 8 | String | |
| mdvc | LogsSemanticInterpretationIntentQueryLinkKindFlags | Logs version of the repository_webref.LinkKindFlags proto Used to represent QRef implications Next available tag: 8 | String | |
| property | LogsSemanticInterpretationIntentQueryLinkKindFlags | Logs version of the repository_webref.LinkKindFlags proto Used to represent QRef implications Next available tag: 8 | String | |
| resolution | Has not been useful since at least 2015 (before this was logged). | LogsSemanticInterpretationIntentQueryLinkKindFlags | Logs version of the repository_webref.LinkKindFlags proto Used to represent QRef implications Next available tag: 8 | String |
| flags | LogsSemanticInterpretationIntentQueryLinkKindInfo | Logs version of the repository_webref.LinkKindInfo proto Used to represent QRef implications | LogsSemanticInterpretationIntentQueryLinkKindFlags | |
| kcLinkName | Not set for a while. | LogsSemanticInterpretationIntentQueryLinkKindInfo | Logs version of the repository_webref.LinkKindInfo proto Used to represent QRef implications | String |
| topicPropertyName | LogsSemanticInterpretationIntentQueryLinkKindInfo | Logs version of the repository_webref.LinkKindInfo proto Used to represent QRef implications | String | |
| allowWildcardIntents | LogsSemanticInterpretationIntentQuerySupportTransferRule | Logs version of the repository_webref.SupportTransferRule proto Non-logs version supports go/stbr | boolean | |
| domain | LogsSemanticInterpretationIntentQuerySupportTransferRule | Logs version of the repository_webref.SupportTransferRule proto Non-logs version supports go/stbr | String | |
| isReverseLink | LogsSemanticInterpretationIntentQuerySupportTransferRule | Logs version of the repository_webref.SupportTransferRule proto Non-logs version supports go/stbr | boolean | |
| mentionsOnly | LogsSemanticInterpretationIntentQuerySupportTransferRule | Logs version of the repository_webref.SupportTransferRule proto Non-logs version supports go/stbr | boolean | |
| supportShare | LogsSemanticInterpretationIntentQuerySupportTransferRule | Logs version of the repository_webref.SupportTransferRule proto Non-logs version supports go/stbr | boolean | |
| targetCollection | LogsSemanticInterpretationIntentQuerySupportTransferRule | Logs version of the repository_webref.SupportTransferRule proto Non-logs version supports go/stbr | String | |
| userCountry | LogsSemanticInterpretationIntentQuerySupportTransferRule | Logs version of the repository_webref.SupportTransferRule proto Non-logs version supports go/stbr | String | |
| userLanguage | LogsSemanticInterpretationIntentQuerySupportTransferRule | Logs version of the repository_webref.SupportTransferRule proto Non-logs version supports go/stbr | String | |
| entityIndex | LogsSemanticInterpretationIntentQueryWebrefEntityRelationship | Logs version of the repository_webref.WebrefEntityRelationship proto Used to represent QRef implications | integer | |
| linkMetadata | LogsSemanticInterpretationIntentQueryWebrefEntityRelationship | Logs version of the repository_webref.WebrefEntityRelationship proto Used to represent QRef implications | LogsSemanticInterpretationIntentQueryEntityLinkMetadata | |
| linkWeight | LogsSemanticInterpretationIntentQueryWebrefEntityRelationship | Logs version of the repository_webref.WebrefEntityRelationship proto Used to represent QRef implications | number | |
| entry | LongStructuredSnippet | An experimental long snippet. The protocol allows any permutation of headers and plain text paragraphs, but typical responses are just paragraphs or alternating headers and paragraphs. | list(LongStructuredSnippetEntry) | |
| header | Is this a header or normal paragraph? | LongStructuredSnippetEntry | boolean | |
| text | The text of the header or paragraph. | LongStructuredSnippetEntry | String | |
| shortcutContactType | MajelContactInformationShortcutInformation | The information on whether the contact is related to an app shortcut. Next ID: 2 | String | |
| isAlleyAffix | An affix that indicates an alley. Alleys are unnamed, numbered routes that are always linked to a “parent street”. As these parent streets can be named e.g. “7th street” and alleys might be referred to as “7th alley”, we need to be able to distinguish those affixes. For more details about alleys see go/vn-alley-geocoding. | MapsQualitySpecialWordsFlags | Flags that describe the information about a special word. If you add another flag please add it to the special words implemenation in google3/maps/quality/internal/special_words.cc. — Next available id: 22 — | boolean |
| isCommonWord | Common words E.g.: center, park, etc. | MapsQualitySpecialWordsFlags | Flags that describe the information about a special word. If you add another flag please add it to the special words implemenation in google3/maps/quality/internal/special_words.cc. — Next available id: 22 — | boolean |
| isDeconstructible | Whether this special word is part of a name without a separator (like e.g. suffix “strasse” in Freigutstrasse). | MapsQualitySpecialWordsFlags | Flags that describe the information about a special word. If you add another flag please add it to the special words implemenation in google3/maps/quality/internal/special_words.cc. — Next available id: 22 — | boolean |
| isDirectionalModifier | Directional modifier. E.g.: north, south, etc. | MapsQualitySpecialWordsFlags | Flags that describe the information about a special word. If you add another flag please add it to the special words implemenation in google3/maps/quality/internal/special_words.cc. — Next available id: 22 — | boolean |
| isDistanceMarker | An affix that indicates distance marker on a route, e.g., ‘km’. | MapsQualitySpecialWordsFlags | Flags that describe the information about a special word. If you add another flag please add it to the special words implemenation in google3/maps/quality/internal/special_words.cc. — Next available id: 22 — | boolean |
| isForbiddenWord | Whether geo paths are forbidden to contain this word. | MapsQualitySpecialWordsFlags | Flags that describe the information about a special word. If you add another flag please add it to the special words implemenation in google3/maps/quality/internal/special_words.cc. — Next available id: 22 — | boolean |
| isHouseIdIdentifier | A keyword for a house id. | MapsQualitySpecialWordsFlags | Flags that describe the information about a special word. If you add another flag please add it to the special words implemenation in google3/maps/quality/internal/special_words.cc. — Next available id: 22 — | boolean |
| isIntersectionConnector | Intersection. E.g.: and, at, corner. | MapsQualitySpecialWordsFlags | Flags that describe the information about a special word. If you add another flag please add it to the special words implemenation in google3/maps/quality/internal/special_words.cc. — Next available id: 22 — | boolean |
| isLandmarkIdentifier | An affix that indicates a landmark, e.g. “opposite”, “near” etc. | MapsQualitySpecialWordsFlags | Flags that describe the information about a special word. If you add another flag please add it to the special words implemenation in google3/maps/quality/internal/special_words.cc. — Next available id: 22 — | boolean |
| isLanguageIndicator | Language indicator. E.g.: platz in German, straat in Dutch. | MapsQualitySpecialWordsFlags | Flags that describe the information about a special word. If you add another flag please add it to the special words implemenation in google3/maps/quality/internal/special_words.cc. — Next available id: 22 — | boolean |
| isNameSynonym | Whether this is a name synonym and should be allowed to be matched on when searching (that is, added to the retrieval query with the name/ prefix). | MapsQualitySpecialWordsFlags | Flags that describe the information about a special word. If you add another flag please add it to the special words implemenation in google3/maps/quality/internal/special_words.cc. — Next available id: 22 — | boolean |
| isNotForLegacyStreetNumberDetection | Terms which are not allowed to be used by the legacy street number detection. | MapsQualitySpecialWordsFlags | Flags that describe the information about a special word. If you add another flag please add it to the special words implemenation in google3/maps/quality/internal/special_words.cc. — Next available id: 22 — | boolean |
| isNotOptionalizable | Terms which are not allowed to be treated as optional. | MapsQualitySpecialWordsFlags | Flags that describe the information about a special word. If you add another flag please add it to the special words implemenation in google3/maps/quality/internal/special_words.cc. — Next available id: 22 — | boolean |
| isNumber | Numbers. E.g.: 1, one, 2, two. | MapsQualitySpecialWordsFlags | Flags that describe the information about a special word. If you add another flag please add it to the special words implemenation in google3/maps/quality/internal/special_words.cc. — Next available id: 22 — | boolean |
| isNumberSuffix | E.g. suffixes in French: bis, ter. | MapsQualitySpecialWordsFlags | Flags that describe the information about a special word. If you add another flag please add it to the special words implemenation in google3/maps/quality/internal/special_words.cc. — Next available id: 22 — | boolean |
| isOptional | Is this special word optional? | MapsQualitySpecialWordsFlags | Flags that describe the information about a special word. If you add another flag please add it to the special words implemenation in google3/maps/quality/internal/special_words.cc. — Next available id: 22 — | boolean |
| isOrdinalNumber | E.g.: 1st, first. | MapsQualitySpecialWordsFlags | Flags that describe the information about a special word. If you add another flag please add it to the special words implemenation in google3/maps/quality/internal/special_words.cc. — Next available id: 22 — | boolean |
| isPenalizedIfMissing | Optional terms that should not geocode by themselves. | MapsQualitySpecialWordsFlags | Flags that describe the information about a special word. If you add another flag please add it to the special words implemenation in google3/maps/quality/internal/special_words.cc. — Next available id: 22 — | boolean |
| isPersonalTitle | Personal titles (e.g. doctor, professor, general, etc.) | MapsQualitySpecialWordsFlags | Flags that describe the information about a special word. If you add another flag please add it to the special words implemenation in google3/maps/quality/internal/special_words.cc. — Next available id: 22 — | boolean |
| isStopWord | E.g.: the, in, near, where. | MapsQualitySpecialWordsFlags | Flags that describe the information about a special word. If you add another flag please add it to the special words implemenation in google3/maps/quality/internal/special_words.cc. — Next available id: 22 — | boolean |
| isStreetNumberIdentifier | A keyword that denotes a street number, e.g. “number”, “unit” etc. | MapsQualitySpecialWordsFlags | Flags that describe the information about a special word. If you add another flag please add it to the special words implemenation in google3/maps/quality/internal/special_words.cc. — Next available id: 22 — | boolean |
| alternate | Alternate versions of this canonical form. This is mainly abbreviations of the canonical form e.g. “St”, “NE”, etc. This should be present as it is used in the specified language with the correct capitalization, accents, etc. in UTF-8. | MapsQualitySpecialWordsProto | The goal of the special words are to: – Canonicalize the user query by rewriting abbreviations into the canonical version that is indexed. – Figure out at index time for each element which tokens are important. We use this to decide if an address component is matched or not. For instance in “1600 Pennsylvania Ave NW” since “NW” is recognised as a directional (and “Ave” is recognised as a street visible type), “Pennsylvania” becomes the name and you can’t match this street by just specifying “avenue” or “NW”. | list(String) |
| canonical | Canonical versions: the version which is in oyster. This should be present as it is used in the specified language with the correct capitalization, accents, etc. in UTF-8. The canonical can be a single or a multi-token string. There can be several canonicals, e.g. “center” and “centre” in English. | MapsQualitySpecialWordsProto | The goal of the special words are to: – Canonicalize the user query by rewriting abbreviations into the canonical version that is indexed. – Figure out at index time for each element which tokens are important. We use this to decide if an address component is matched or not. For instance in “1600 Pennsylvania Ave NW” since “NW” is recognised as a directional (and “Ave” is recognised as a street visible type), “Pennsylvania” becomes the name and you can’t match this street by just specifying “avenue” or “NW”. | list(String) |
| country | If empty, apply this rule to any country. Otherwise, a list of ISO 3166-1 alpha-2 (2-letter uppercase) country codes that this description applies to. | MapsQualitySpecialWordsProto | The goal of the special words are to: – Canonicalize the user query by rewriting abbreviations into the canonical version that is indexed. – Figure out at index time for each element which tokens are important. We use this to decide if an address component is matched or not. For instance in “1600 Pennsylvania Ave NW” since “NW” is recognised as a directional (and “Ave” is recognised as a street visible type), “Pennsylvania” becomes the name and you can’t match this street by just specifying “avenue” or “NW”. | list(String) |
| flags | Boolean flags indicating what type of special word this is. | MapsQualitySpecialWordsProto | The goal of the special words are to: – Canonicalize the user query by rewriting abbreviations into the canonical version that is indexed. – Figure out at index time for each element which tokens are important. We use this to decide if an address component is matched or not. For instance in “1600 Pennsylvania Ave NW” since “NW” is recognised as a directional (and “Ave” is recognised as a street visible type), “Pennsylvania” becomes the name and you can’t match this street by just specifying “avenue” or “NW”. | MapsQualitySpecialWordsFlags |
| language | The III language code of the language that this description applies to. No language means that this applies worldwide. This could be useful for codes like country codes or airport codes or for displayed language neutral icons. A special word with a language code here also applies to the regional variants of that language (e.g. “en” applies to “en-GB” and “en-US” as well). | MapsQualitySpecialWordsProto | The goal of the special words are to: – Canonicalize the user query by rewriting abbreviations into the canonical version that is indexed. – Figure out at index time for each element which tokens are important. We use this to decide if an address component is matched or not. For instance in “1600 Pennsylvania Ave NW” since “NW” is recognised as a directional (and “Ave” is recognised as a street visible type), “Pennsylvania” becomes the name and you can’t match this street by just specifying “avenue” or “NW”. | list(String) |
| position | MapsQualitySpecialWordsProto | The goal of the special words are to: – Canonicalize the user query by rewriting abbreviations into the canonical version that is indexed. – Figure out at index time for each element which tokens are important. We use this to decide if an address component is matched or not. For instance in “1600 Pennsylvania Ave NW” since “NW” is recognised as a directional (and “Ave” is recognised as a street visible type), “Pennsylvania” becomes the name and you can’t match this street by just specifying “avenue” or “NW”. | String | |
| visibleTypeId | visible_type_id from VisibleTypeProto for visible types converted to the special words. For original special words this field is empty. | MapsQualitySpecialWordsProto | The goal of the special words are to: – Canonicalize the user query by rewriting abbreviations into the canonical version that is indexed. – Figure out at index time for each element which tokens are important. We use this to decide if an address component is matched or not. For instance in “1600 Pennsylvania Ave NW” since “NW” is recognised as a directional (and “Ave” is recognised as a street visible type), “Pennsylvania” becomes the name and you can’t match this street by just specifying “avenue” or “NW”. | list(String) |
| areaFraction | The area of the region as a fraction of the image. The value is in the range (0, 1). | MediaIndexBoundingbox | Stores coordinates corresponding to the dimensions of the box surrounding the region of interest. Coordinates may be normalized or absolute depending on the implementation and signal corresponding to this field. | number |
| xmax | MediaIndexBoundingbox | Stores coordinates corresponding to the dimensions of the box surrounding the region of interest. Coordinates may be normalized or absolute depending on the implementation and signal corresponding to this field. | number | |
| xmin | MediaIndexBoundingbox | Stores coordinates corresponding to the dimensions of the box surrounding the region of interest. Coordinates may be normalized or absolute depending on the implementation and signal corresponding to this field. | number | |
| ymax | MediaIndexBoundingbox | Stores coordinates corresponding to the dimensions of the box surrounding the region of interest. Coordinates may be normalized or absolute depending on the implementation and signal corresponding to this field. | number | |
| ymin | MediaIndexBoundingbox | Stores coordinates corresponding to the dimensions of the box surrounding the region of interest. Coordinates may be normalized or absolute depending on the implementation and signal corresponding to this field. | number | |
| customSource | The custom source should only be a-z[0-9] dashes, underscores, and colons. Special characters should be avoided. | MediaIndexEntityField | Packages entity id and score together for a given source. | String |
| entityId | MediaIndexEntityField | Packages entity id and score together for a given source. | String | |
| quantizedScore | MediaIndexEntityField | Packages entity id and score together for a given source. | String | |
| source | MediaIndexEntityField | Packages entity id and score together for a given source. | String | |
| previewFrameZeroVariant | MediaIndexFrameIdentifier | Identifier for frames associated with a video. | MediaIndexFrameIdentifierPreviewFrameZeroVariant | |
| timestampMs | Offset of the frame from the beginning of the video (in milliseconds). | MediaIndexFrameIdentifier | Identifier for frames associated with a video. | integer |
| previewLength | MediaIndexFrameIdentifierPreviewFrameZeroVariant | This variant defines the frame to be the first frame of the video’s generated preview. | String | |
| xtagList | All xtags used in the generation of the preview. The same frame generated from the same preview with different xtags will likely have different bytes (such as, for example, resulting from a different aspect ratio). | MediaIndexFrameIdentifierPreviewFrameZeroVariant | This variant defines the frame to be the first frame of the video’s generated preview. | MediaIndexXtagList |
| boundingBox | The bounding box corresponding to the region. | MediaIndexRegion | Metadata associated with a region in an image. NEXT_ID: 14 | MediaIndexBoundingbox |
| entityFields | Detected Entities found within this region. | MediaIndexRegion | Metadata associated with a region in an image. NEXT_ID: 14 | list(MediaIndexEntityField) |
| labels | The labels associated with the region encoded as a SparseFloatVector to facilitate dot product computation during sorting. The columns are the fingerprints of the labels and the values are the corresponding confidence scores. The vector is L2 normalized. | MediaIndexRegion | Metadata associated with a region in an image. NEXT_ID: 14 | MediaIndexSparseFloatVector |
| primiApparelFeaturesV2 | PRIMI Apparel Features v2 embedding and tokens. | MediaIndexRegion | Metadata associated with a region in an image. NEXT_ID: 14 | String |
| primiApparelTokensV2 | MediaIndexRegion | Metadata associated with a region in an image. NEXT_ID: 14 | list(String) | |
| primiGenericFeaturesV25 | PRIMI Generic Features v2.5 embedding and tokens. | MediaIndexRegion | Metadata associated with a region in an image. NEXT_ID: 14 | String |
| primiGenericTokensV25 | MediaIndexRegion | Metadata associated with a region in an image. NEXT_ID: 14 | list(String) | |
| starburstFeaturesV4 | Starburst v4 embedding and tokens. | MediaIndexRegion | Metadata associated with a region in an image. NEXT_ID: 14 | String |
| starburstFeaturesV5 | Starburst v5 embedding and tokens. | MediaIndexRegion | Metadata associated with a region in an image. NEXT_ID: 14 | String |
| starburstTokensV4 | MediaIndexRegion | Metadata associated with a region in an image. NEXT_ID: 14 | list(String) | |
| starburstTokensV5 | MediaIndexRegion | Metadata associated with a region in an image. NEXT_ID: 14 | list(String) | |
| starburstV4 | MediaIndexRegion | Metadata associated with a region in an image. NEXT_ID: 14 | ImageContentStarburstVersionGroup | |
| starburstV5 | MediaIndexRegion | Metadata associated with a region in an image. NEXT_ID: 14 | ImageContentStarburstVersionGroup | |
| columns | Parallel arrays of column / value. Exactly one of those columns vector should be set. Columns must be in monotonically increasing order. | MediaIndexSparseFloatVector | list(String) | |
| columnsInt16 | MediaIndexSparseFloatVector | String | ||
| columnsInt32 | MediaIndexSparseFloatVector | list(integer) | ||
| columnsInt64 | Columns are fixed integers, used for accelerated parse. | MediaIndexSparseFloatVector | list(String) | |
| columnsInt8 | MediaIndexSparseFloatVector | String | ||
| values | MediaIndexSparseFloatVector | list(number) | ||
| domainScores | MediaIndexVideoCentroid | Data about the behavior of the video across the pages it is embedded in. | list(MediaIndexVideoCentroidDomainScore) | |
| domain | The domain this score was generated for. | MediaIndexVideoCentroidDomainScore | See go/video-centroid-domain-score. | String |
| numDocs | Number of pages from the domain used to generate this DomainScore. | MediaIndexVideoCentroidDomainScore | See go/video-centroid-domain-score. | integer |
| score | In general, lower scores indicate the video is appearing on more diverse pages. | MediaIndexVideoCentroidDomainScore | See go/video-centroid-domain-score. | number |
| centroid | MediaIndexVideoCoreSignals | Core signals for video content corpus which will be fetched for every query. If a signal is required only for a subset of search queries then it should be added as a separate field in the schema. | MediaIndexVideoCentroid | |
| videoFrames | MediaIndexVideoCoreSignals | Core signals for video content corpus which will be fetched for every query. If a signal is required only for a subset of search queries then it should be added as a separate field in the schema. | list(MediaIndexVideoFrame) | |
| docid | The canonical docid of the frame. | MediaIndexVideoFrame | Data about a frame associated with the video. | String |
| frameIdentifier | MediaIndexVideoFrame | Data about a frame associated with the video. | MediaIndexFrameIdentifier | |
| regions | Metadata associated with regions within this frame. | MediaIndexVideoFrame | Data about a frame associated with the video. | list(MediaIndexRegion) |
| starburstFeaturesV4 | Starburst v4 embedding and tokens. | MediaIndexVideoFrame | Data about a frame associated with the video. | String |
| starburstTokensV4 | Note: due to the migration to Golden7-source Starburst v4 embedding, no starburst_tokens_v4 will be provided in video content corpus (go/video-content-corpus). But this field is kept in case other purposes may still use it in the proto. | MediaIndexVideoFrame | Data about a frame associated with the video. | list(String) |
| thumbnailType | Set of available thumbnail types for this frame. Should be valid image_base.ThumbnailType values (enumerated at http://google3/image/base/thumbnail-type.proto). | MediaIndexVideoFrame | Data about a frame associated with the video. | list(String) |
| videoFrames | MediaIndexVideoFrames | Data about multiple video frames associated with the video. | list(MediaIndexVideoFrame) | |
| name | Names are all stored case-sensitive, and no case-folding is done for comparisons. | MediaIndexXtag | String | |
| value | The value associated with this Xtag. Values are all stored case-sensitive, and no case-folding is done for comparisons. | MediaIndexXtag | String | |
| xtags | MediaIndexXtagList | XtagList — a collection of Xtag instances with unique names. This would be associated with one specific piece of content. | list(MediaIndexXtag) | |
| flags | MobilePerDocData | Note: This message is also in the RTUpdate protocol buffer. | integer | |
| mobileurl | DEPRECATED: Url of the mobile version of the document. This is set during canonicalization if we do not know that the Web url also serves the mobile version. | MobilePerDocData | Note: This message is also in the RTUpdate protocol buffer. | String |
| transcodedPageScore | DEPRECATED: The transcoded page quality repesented in 7-bits range from 0 to 127. | MobilePerDocData | Note: This message is also in the RTUpdate protocol buffer. | integer |
| present | Whether the field (data field or pointer) is defined. | MultiscaleFieldPresence | Defines the presence of a field. This can help distinguish between empty vs. not-present annotations. | boolean |
| wellDefined | MultiscaleFieldPresence | Defines the presence of a field. This can help distinguish between empty vs. not-present annotations. | String | |
| implicitLength | If the layer is not materialized but things point into it, this gives the effective length. | MultiscaleLayerPresence | Defines the presence of a layer (previously called “scale”). | integer |
| present | Whether the layer is present. | MultiscaleLayerPresence | Defines the presence of a layer (previously called “scale”). | boolean |
| index | The index of the node that this pointer points to. | MultiscalePointerIndex | Pointer to a single node in a target scale. `pointer.Index` fields should be annotated with a `(pointer.to)` annotation, indicating what scale they point at. | integer |
| limit | The exclusive end index for the span of nodes that this pointer points to — i.e., one plus the index of the last node in the span. Must be greater than or equal to `start`. If equal to `start`, then the target span is empty. | MultiscalePointerSpan | Pointer to a contiguous range of nodes in a target scale. `pointer.Span` fields should be annotated with a `(pointer.to)` annotation, indicating what scale they point at. | integer |
| start | The inclusive start index for the span of nodes that this pointer points to — i.e., the index of the first node in the span. | MultiscalePointerSpan | Pointer to a contiguous range of nodes in a target scale. `pointer.Span` fields should be annotated with a `(pointer.to)` annotation, indicating what scale they point at. | integer |
| name | Name corresponds to the names in WebChooserScorer::FeatureNames. | MustangReposWwwSnippetsCandidateFeature | CandidateFeature contains a pair of feature name and score for a snippet candidate. | String |
| score | MustangReposWwwSnippetsCandidateFeature | CandidateFeature contains a pair of feature name and score for a snippet candidate. | number | |
| header | The texts of header and listing items. | MustangReposWwwSnippetsOrganicListSnippetResponse | Data to generate the list preview for organic list snippets. | String |
| headerTitleRedundancy | The ratio of header tokens covered by title. | MustangReposWwwSnippetsOrganicListSnippetResponse | Data to generate the list preview for organic list snippets. | number |
| headerUsedInSnippet | If the header being used in organic snippet. | MustangReposWwwSnippetsOrganicListSnippetResponse | Data to generate the list preview for organic list snippets. | boolean |
| items | MustangReposWwwSnippetsOrganicListSnippetResponse | Data to generate the list preview for organic list snippets. | list(String) | |
| originalTotalItems | The number of items in the original list. | MustangReposWwwSnippetsOrganicListSnippetResponse | Data to generate the list preview for organic list snippets. | integer |
| radishScore | The score of the radish signal. | MustangReposWwwSnippetsOrganicListSnippetResponse | Data to generate the list preview for organic list snippets. | number |
| dataSourceType | data_source_type corresponds to the ChosenSnippet::SnippetType enum. | MustangReposWwwSnippetsSnippetCandidate | This message contains features for candidates at the chooser level. For each snippet candidate, we also log the final score as the last candidate feature. | integer |
| features | MustangReposWwwSnippetsSnippetCandidate | This message contains features for candidates at the chooser level. For each snippet candidate, we also log the final score as the last candidate feature. | list(MustangReposWwwSnippetsCandidateFeature) | |
| text | MustangReposWwwSnippetsSnippetCandidate | This message contains features for candidates at the chooser level. For each snippet candidate, we also log the final score as the last candidate feature. | String | |
| browserWidth | Browser width. | MustangReposWwwSnippetsSnippetsRanklabFeatures | This is a protocol buffer to export into flatfiles in ranklab. All fields are converted into flatfiles with some specific prefix and a field name like ‘snippet_features_snippet_data_source_type’. | integer |
| candidates | Features for snippets candidates, generated by both old and new scorer. Currently only features for chosen candidate is generated. | MustangReposWwwSnippetsSnippetsRanklabFeatures | This is a protocol buffer to export into flatfiles in ranklab. All fields are converted into flatfiles with some specific prefix and a field name like ‘snippet_features_snippet_data_source_type’. | list(MustangReposWwwSnippetsSnippetCandidate) |
| displaySnippet | Snippet features for the final chosen snippet. This field is firstly populated by Muppet, and then overwriten by Superroot if SnippetBrain is triggered. | MustangReposWwwSnippetsSnippetsRanklabFeatures | This is a protocol buffer to export into flatfiles in ranklab. All fields are converted into flatfiles with some specific prefix and a field name like ‘snippet_features_snippet_data_source_type’. | QualityPreviewRanklabSnippet |
| documentLanguage | locale of the document. | MustangReposWwwSnippetsSnippetsRanklabFeatures | This is a protocol buffer to export into flatfiles in ranklab. All fields are converted into flatfiles with some specific prefix and a field name like ‘snippet_features_snippet_data_source_type’. | String |
| originalQueryTermCoverages | Original query term coverage in titles and / or snippets. | MustangReposWwwSnippetsSnippetsRanklabFeatures | This is a protocol buffer to export into flatfiles in ranklab. All fields are converted into flatfiles with some specific prefix and a field name like ‘snippet_features_snippet_data_source_type’. | QualityPreviewSnippetQueryTermCoverageFeatures |
| queryLanguage | locale of the query, | MustangReposWwwSnippetsSnippetsRanklabFeatures | This is a protocol buffer to export into flatfiles in ranklab. All fields are converted into flatfiles with some specific prefix and a field name like ‘snippet_features_snippet_data_source_type’. | String |
| snippetDataSourceType | Snippet data source. | MustangReposWwwSnippetsSnippetsRanklabFeatures | This is a protocol buffer to export into flatfiles in ranklab. All fields are converted into flatfiles with some specific prefix and a field name like ‘snippet_features_snippet_data_source_type’. | integer |
| snippetQueryTermCoverage | Query term coverage in snippets. | MustangReposWwwSnippetsSnippetsRanklabFeatures | This is a protocol buffer to export into flatfiles in ranklab. All fields are converted into flatfiles with some specific prefix and a field name like ‘snippet_features_snippet_data_source_type’. | number |
| snippets | Snippet features for Muppet snippet candidates. In production, only the data for chosen snippet will be recorded. | MustangReposWwwSnippetsSnippetsRanklabFeatures | This is a protocol buffer to export into flatfiles in ranklab. All fields are converted into flatfiles with some specific prefix and a field name like ‘snippet_features_snippet_data_source_type’. | list(QualityPreviewRanklabSnippet) |
| titleDataSourceType | Title data source. | MustangReposWwwSnippetsSnippetsRanklabFeatures | This is a protocol buffer to export into flatfiles in ranklab. All fields are converted into flatfiles with some specific prefix and a field name like ‘snippet_features_snippet_data_source_type’. | integer |
| titleQueryTermCoverage | Query term coverage in titles. | MustangReposWwwSnippetsSnippetsRanklabFeatures | This is a protocol buffer to export into flatfiles in ranklab. All fields are converted into flatfiles with some specific prefix and a field name like ‘snippet_features_snippet_data_source_type’. | number |
| titleSnippetQueryTermCoverage | Query term coverage in titles and snippets. | MustangReposWwwSnippetsSnippetsRanklabFeatures | This is a protocol buffer to export into flatfiles in ranklab. All fields are converted into flatfiles with some specific prefix and a field name like ‘snippet_features_snippet_data_source_type’. | number |
| titles | Per-candidate title features for ranklab models, sorted from the best candidate to the worst candidate (i.e., the first element is the actually selected title). | MustangReposWwwSnippetsSnippetsRanklabFeatures | This is a protocol buffer to export into flatfiles in ranklab. All fields are converted into flatfiles with some specific prefix and a field name like ‘snippet_features_snippet_data_source_type’. | list(QualityPreviewRanklabTitle) |
| bolded | Is the rendered token bolded (insided ) | MustangSnippetsRenderedToken | Tidbit token rendered in generating snippet/title. | boolean |
| byteOffsetBegin | Byte offset range in the rendered text that corresponds to this token. [byte_offset_begin, byte_offset_end) inclusive | MustangSnippetsRenderedToken | Tidbit token rendered in generating snippet/title. | integer |
| byteOffsetEnd | exclusive | MustangSnippetsRenderedToken | Tidbit token rendered in generating snippet/title. | integer |
| section | Section and TokenPos of the token. | MustangSnippetsRenderedToken | Tidbit token rendered in generating snippet/title. | String |
| tokenPos | MustangSnippetsRenderedToken | Tidbit token rendered in generating snippet/title. | String | |
| id | required | NetFabricRpcVirtualNetworkId | Globally unique identifier for a virtual network. | integer |
| componentSpecificContracts | NlpMeaningComponentSpecificContracts | A Component-Specific Contract is a proto message that can be placed on various elements of the MeaningCatalog (intent schemas, slots, types) that signals whether that element is part of the contract for a given component. go/contract-based-conformance | list(String) | |
| deletion | This field can be set to true to indicate that the associated part of the schema is being deleted as part of the remodeling. | NlpMeaningMeaningRemodeling | boolean | |
| id | The remodeling ID. Each remodeling has a unique ID that is used to associate changes with that remodeling. | NlpMeaningMeaningRemodeling | String | |
| remodelingId | NlpMeaningMeaningRemodelingControl | This is the FunctionCall counterpart to the “MeaningRemodelings” structure. When present, it is used for typechecking the FunctionCall against the schema with the remodelings enabled. | list(String) | |
| remodeling | NlpMeaningMeaningRemodelings | This proto will be added as a field to part of a schema to indicate it is being remodeled. | list(NlpMeaningMeaningRemodeling) | |
| componentSpecificContracts | NlpMeaningSemanticTypeNameComponentSpecificContracts | Component-Specific Contract for SemanticTypes, which are atomic string values (and thus can’t have a ComponentSpecificContracts message attached to them). go/contract-based-conformance | NlpMeaningComponentSpecificContracts | |
| name | Semantic type name. | NlpMeaningSemanticTypeNameComponentSpecificContracts | Component-Specific Contract for SemanticTypes, which are atomic string values (and thus can’t have a ComponentSpecificContracts message attached to them). go/contract-based-conformance | String |
| name | Semantic type name. | NlpMeaningSemanticTypeNameMeaningRemodelings | Associates remodeling data with a semantic type name. | String |
| remodelings | NlpMeaningSemanticTypeNameMeaningRemodelings | Associates remodeling data with a semantic type name. | NlpMeaningMeaningRemodelings | |
| info | Annotation for this phrase. | NlpSaftAnnotatedPhrase | Representation of a phrase in the document with a particular annotation. Provides the ability to annotate arbitrary spans in the document. This is intended for representing spans that SAFT does NOT consider to be mentions of entities within a SAFT document. | Proto2BridgeMessageSet |
| phrase | Contains start and end pointers to the token array for this span. | NlpSaftAnnotatedPhrase | Representation of a phrase in the document with a particular annotation. Provides the ability to annotate arbitrary spans in the document. This is intended for representing spans that SAFT does NOT consider to be mentions of entities within a SAFT document. | NlpSaftPhrase |
| child | An arbitrary number of children, ordered from left to right; empty for preterminals. Represented via indices into Document.constituency_node. | NlpSaftConstituencyNode | Constituency parse tree node with tokens as the leaf nodes. | list(integer) |
| label | The label of the current node. | NlpSaftConstituencyNode | Constituency parse tree node with tokens as the leaf nodes. | String |
| phrase | A phrase that contains information about the span and the (optional) head token. For terminal nodes the head of the phrase holds the word. | NlpSaftConstituencyNode | Constituency parse tree node with tokens as the leaf nodes. | NlpSaftPhrase |
| relation | Relations between entities in the document. | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | list(NlpSaftRelation) |
| annotations | Generic annotations. | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | Proto2BridgeMessageSet |
| contentage | Age of the content of the document. For details, see: quality/historical/shingle/signals/contentage.proto The format has been translated to a canonical timestamp (seconds since epoch). | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | String |
| bylineDate | Document’s byline date, if available: this is the date that will be shown in the snippets in web search results. It is stored as the number of seconds since epoch. See segindexer/compositedoc.proto | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | String |
| date | Document anchor date in YYYYMMDDhhmmss format. | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | String |
| entity | Entities in the document. | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | list(NlpSaftEntity) |
| semanticNode | The semantic nodes for the document represent arbitrary types of higher-level abstractions beyond entity mention coreference and binary relations between entities. These may include: n-ary relations, semantic frames or events. The semantic nodes for a document are the nodes in a directed acyclic graph, with an adjacency list representation. | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | list(NlpSaftSemanticNode) |
| lastSignificantUpdate | Last significant update of the page content, in the same format as the contentage field, and also derived from ContentAge.last_significant_update in quality/historical/shingle/signals/contentage.proto. | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | String |
| token | Tokenization of the document. | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | list(NlpSaftToken) |
| measure | Measures in the documents. This covers both time expressions as well as physical quantities. | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | list(NlpSaftMeasure) |
| hyperlink | The hyperlinks in the document. Multiple hyperlinks are sorted in left-to-right order. | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | list(NlpSaftHyperlink) |
| annotatedPhrase | Annotated phrases in the document that are not semantically well-defined mentions of entities. | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | list(NlpSaftAnnotatedPhrase) |
| contentFirstseen | Stores minimum of first time google successfully crawled a document, or indexed the document with contents (i.e, not roboted). It is stored as the number of seconds since epoch. See quality/historical/signals/firstseen/firstseen.proto | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | String |
| contentType | Optional document content_type (from webutil/http/content-type.proto). Used for setting the content_type when converting the SAFT Document to a CompositeDoc. Will be inferred if not given here. | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | integer |
| entityLabel | Entity labels used in this document. This field is used to define labels for the Entity::entity_type_probability field, which contains corresponding probabilities. WARNING: This field is deprecated. go/saft-replace-deprecated-entity-type | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | list(String) |
| httpHeaders | HTTP header for document. If the HTTP headers field is set it should be the complete header including the HTTP status line and the trailing cr/nl. HTTP headers are not required to be valid UTF-8. Per the HTTP/1.1 Syntax (RFC7230) standard, non-ASCII octets should be treated as opaque data. | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | String |
| topic | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | list(NlpSaftDocumentTopic) | |
| docid | Identifier for document. | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | String |
| language | Document language (default is English). This field’s value maps cleanly to the i18n.languages.Language proto enum (i18n::languages::Language in C++). | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | integer |
| text | Raw text contents of document. (In docjoin attachments from the SAFT goldmine annotator this field will be empty.) | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | String |
| trace | Whether to enable component tracing during analysis of this document. See http://go/saft-tracing for details. | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | boolean |
| golden | Flag for indicating that the document is a gold-standard document. This can be used for putting additional weight on human-labeled documents in contrast to automatically labeled annotations. | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | boolean |
| focusEntity | Focus entity. For lexicon articles, like Wikipedia pages, a document is often about a certain entity. This is the local entity id of the focus entity for the document. | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | integer |
| constituencyRoot | The root node of the constituency tree for each sentence. If non-empty, the list of roots will be aligned with the sentences in the document. Note that some sentences may not have been parsed for various reasons; these sentences will be annotated with placeholder “stub parses”. For details, see //nlp/saft/components/constituents/util/stub-parse.h. | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | list(integer) |
| author | Document author(s). | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | list(String) |
| syntacticDate | Document’s syntactic date (e.g. date explicitly mentioned in the URL of the document or in the document title). It is stored as the number of seconds since epoch. See quality/timebased/syntacticdate/proto/syntactic-date.proto | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | String |
| url | Source document URL. | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | String |
| privacySensitive | True if this document contains privacy sensitive data. When the document is transferred in RPC calls the RPC should use SSL_PRIVACY_AND_INTEGRITY security level. | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | boolean |
| subsection | Sub-sections for document for dividing a document into volumes, parts, chapters, sections, etc. | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | list(NlpSaftDocument) |
| constituencyNode | Constituency parse tree nodes for the sentences in this document. | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | list(NlpSaftConstituencyNode) |
| rpcError | True if some RPC which touched this document had an error. | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | boolean |
| title | Optional document title. | NlpSaftDocument | A document contains the raw text contents of the document as well as an analysis. The document can be split into tokens which can contain information about POS tags and dependency relations. The document can also contain entities and mentions of these entities in the document. Next available id: 36 | String |
| name | Topic name or identifier. | NlpSaftDocumentTopic | Document topic(s). | String |
| score | Topic score. | NlpSaftDocumentTopic | Document topic(s). | number |
| antecedent | Antecedent for entity. This is used to make coreference chains before the mentions in the document are grouped by entity. | NlpSaftEntity | Named entities in the document. | integer |
| entityType | Entity type (e.g. PER, ORG, LOC). WARNING: This field is deprecated. go/saft-replace-deprecated-entity-type | NlpSaftEntity | Named entities in the document. | String |
| entityTypeProbability | Probability distribution over entity types. These values correspond to Document.entity_label values: doc.entity[e].entity_type_probability[n] is the probability that the correct label for doc.entity[e] is doc.entity_label[n]. These probabilities sum to 1.0 (with possible rounding error). WARNING: This field is deprecated. go/saft-replace-deprecated-entity-type | NlpSaftEntity | Named entities in the document. | list(float) |
| gender | Gender for entity. | NlpSaftEntity | Named entities in the document. | String |
| info | Application-specific information about this entity. | NlpSaftEntity | Named entities in the document. | Proto2BridgeMessageSet |
| mention | Mentions of the entity in the document. | NlpSaftEntity | Named entities in the document. | list(NlpSaftMention) |
| name | Representative entity name. | NlpSaftEntity | Named entities in the document. | String |
| profile | Profile for entity. | NlpSaftEntity | Named entities in the document. | NlpSaftEntityProfile |
| referent | Referent information for discourse context entities that are not mentioned in the document. These can be merged with mentioned entities during analysis if they are deemed to be coreferent. Entities with referents should not have any mentions if they do not corefer with anything. For example, when adding context entities to an input document prior to SAFT analysis, those entities should have a referent and no mentions. | NlpSaftEntity | Named entities in the document. | NlpSaftReferent |
| representativeMention | Representative mention, as an index into mention. | NlpSaftEntity | Named entities in the document. | integer |
| salience | Score indicating the saliency (centrality) of this entity to the document. | NlpSaftEntity | Named entities in the document. | float |
| type | Entity types of the entity. These can include SAFT types (/saft/location, /saft/art, /saft/other/living_thing, etc), collections types (/collection/tv_personalities, /collection/statistical_regions, etc), and more. This refers to the type of the entity itself: in “She is on TV”, “She” refers to a specific actor, with type “/collection/tv_personalities”. Cf. Mention.Type, which is the type of the referring mention. | NlpSaftEntity | Named entities in the document. | list(NlpSaftEntityType) |
| alternate | NlpSaftEntityProfile | An entity profile contains a summary of the information about a single unique entity. Next available index: 46. | list(NlpSaftEntityProfileAlternate) | |
| annotations | Generic annotations. | NlpSaftEntityProfile | An entity profile contains a summary of the information about a single unique entity. Next available index: 46. | Proto2BridgeMessageSet |
| attribute | List of attributes for the entity. | NlpSaftEntityProfile | An entity profile contains a summary of the information about a single unique entity. Next available index: 46. | list(NlpSaftEntityProfileAttribute) |
| canonicalName | Canonical entity name. | NlpSaftEntityProfile | An entity profile contains a summary of the information about a single unique entity. Next available index: 46. | String |
| collectionScoreType | NlpSaftEntityProfile | An entity profile contains a summary of the information about a single unique entity. Next available index: 46. | String | |
| disambiguation | Disambiguation phrase. The combination of entity name and disambiguation phrase should be unique within the corpus. | NlpSaftEntityProfile | An entity profile contains a summary of the information about a single unique entity. Next available index: 46. | String |
| embedding | Entity embeding vector, representing the entity in a dense low-dimensional embedding space. | NlpSaftEntityProfile | An entity profile contains a summary of the information about a single unique entity. Next available index: 46. | list(number) |
| frame | Profile frame in binary SLING encoding. | NlpSaftEntityProfile | An entity profile contains a summary of the information about a single unique entity. Next available index: 46. | String |
| gender | Gender of the entity. | NlpSaftEntityProfile | An entity profile contains a summary of the information about a single unique entity. Next available index: 46. | String |
| id | Unique global id for entity. | NlpSaftEntityProfile | An entity profile contains a summary of the information about a single unique entity. Next available index: 46. | String |
| identifier | External identifiers for entity. | NlpSaftEntityProfile | An entity profile contains a summary of the information about a single unique entity. Next available index: 46. | list(NlpSaftIdentifier) |
| keyword | NlpSaftEntityProfile | An entity profile contains a summary of the information about a single unique entity. Next available index: 46. | list(NlpSaftEntityProfileKeyword) | |
| mid | Freebase MID for entity. This field should be the same as FREEBASE_MID identifier for the entity profile. | NlpSaftEntityProfile | An entity profile contains a summary of the information about a single unique entity. Next available index: 46. | String |
| name | Representative name for entity. | NlpSaftEntityProfile | An entity profile contains a summary of the information about a single unique entity. Next available index: 46. | String |
| nameLanguage | Language for the name and disambiguation. | NlpSaftEntityProfile | An entity profile contains a summary of the information about a single unique entity. Next available index: 46. | integer |
| nature | Nature of the entity. | NlpSaftEntityProfile | An entity profile contains a summary of the information about a single unique entity. Next available index: 46. | String |
| reference | NlpSaftEntityProfile | An entity profile contains a summary of the information about a single unique entity. Next available index: 46. | list(NlpSaftEntityProfileReference) | |
| related | NlpSaftEntityProfile | An entity profile contains a summary of the information about a single unique entity. Next available index: 46. | list(NlpSaftEntityProfileRelated) | |
| type | Entity type. | NlpSaftEntityProfile | An entity profile contains a summary of the information about a single unique entity. Next available index: 46. | String |
| count | NlpSaftEntityProfileAlternate | Alternative names for entity. | integer | |
| form | see nlp/saft/resolution/name-form.h for values | NlpSaftEntityProfileAlternate | Alternative names for entity. | integer |
| frame | frame in SLING encoding | NlpSaftEntityProfileAlternate | Alternative names for entity. | String |
| language | NlpSaftEntityProfileAlternate | Alternative names for entity. | integer | |
| name | NlpSaftEntityProfileAlternate | Alternative names for entity. | String | |
| sources | (1 << SRC_DEFAULT) | NlpSaftEntityProfileAlternate | Alternative names for entity. | integer |
| boolValue | Boolean attribute value, e.g. for IsDeceased. | NlpSaftEntityProfileAttribute | boolean | |
| floatValue | Double attribute value, e.g. for height/weight. | NlpSaftEntityProfileAttribute | float | |
| intValue | Integer attribute value, e.g. IntId(“April”). | NlpSaftEntityProfileAttribute | String | |
| language | Language, in case the attribute value is a string. | NlpSaftEntityProfileAttribute | integer | |
| type | String name of the type of attribute, e.g. /birth/date | NlpSaftEntityProfileAttribute | String | |
| typeId | Any id of the type of the attribute, e.g. IntId(/birth/date) | NlpSaftEntityProfileAttribute | integer | |
| value | String attribute value, e.g. “April 2010” or “3,235,121”. | NlpSaftEntityProfileAttribute | String | |
| valueType | The type of the value. | NlpSaftEntityProfileAttribute | String | |
| count | NlpSaftEntityProfileKeyword | Keywords and key phrases for entity. | integer | |
| language | NlpSaftEntityProfileKeyword | Keywords and key phrases for entity. | integer | |
| score | Score associated with the keyword. For fine-grained types this is a probability. | NlpSaftEntityProfileKeyword | Keywords and key phrases for entity. | float |
| term | NlpSaftEntityProfileKeyword | Keywords and key phrases for entity. | String | |
| type | NlpSaftEntityProfileKeyword | Keywords and key phrases for entity. | String | |
| docid | NlpSaftEntityProfileReference | References to entity. | String | |
| entity | NlpSaftEntityProfileReference | References to entity. | integer | |
| count | Number of occurrences. | NlpSaftEntityProfileRelated | Related entities. | integer |
| inverse | Inverse relations can be marked in a bidirectional graph. | NlpSaftEntityProfileRelated | Related entities. | boolean |
| relationId | Optional integer id for the relation. | NlpSaftEntityProfileRelated | Related entities. | integer |
| relationIdentifier | Optional external identifier for the relation. | NlpSaftEntityProfileRelated | Related entities. | NlpSaftIdentifier |
| score | Score for related entity, i.e. p(e->r | e). | NlpSaftEntityProfileRelated | Related entities. | number |
| targetId | Profile id of related entity. | NlpSaftEntityProfileRelated | Related entities. | String |
| targetIdentifier | Optional external identifier for the target entity. | NlpSaftEntityProfileRelated | Related entities. | NlpSaftIdentifier |
| targetName | Name of related entity. | NlpSaftEntityProfileRelated | Related entities. | String |
| type | Type of relation. | NlpSaftEntityProfileRelated | Related entities. | String |
| basedOnMention | This field can be used to specify if the entity type has been annotated or predicted from a specific mention of the entity. However, the entity type does still apply to the entity as a whole, and not just a specific mention. | NlpSaftEntityType | A generic type description for an entity. | integer |
| domain | A domain name for the set that this particular type belongs to. | NlpSaftEntityType | A generic type description for an entity. | String |
| info | Application-specific information about this entity type. | NlpSaftEntityType | A generic type description for an entity. | Proto2BridgeMessageSet |
| name | The type name, like “/saft/person”. See README.entity-types for the inventory of SAFT type tags. | NlpSaftEntityType | A generic type description for an entity. | String |
| score | A score for this type. | NlpSaftEntityType | A generic type description for an entity. | number |
| anchorText | Clean anchor text (no HTML markup). | NlpSaftHyperlink | A link on an HTML page. | String |
| byteEnd | note: inclusive | NlpSaftHyperlink | A link on an HTML page. | integer |
| byteStart | begin/end options are for goldmine AnnotationsFinder to locate the offsets of saft tokens. Start is inclusive by default and end is marked. The indices of the first and last byte covered by the hyperlink. | NlpSaftHyperlink | A link on an HTML page. | integer |
| phrase | The indices of the first and last token covered by the hyperlink. | NlpSaftHyperlink | A link on an HTML page. | NlpSaftPhrase |
| url | (Absolute) URL that the links to. | NlpSaftHyperlink | A link on an HTML page. | String |
| domain | Domain for the identifier. | NlpSaftIdentifier | External identifier. An external identifier is a persistent identifier for an object within a domain. | String |
| id | Identifier within domain. | NlpSaftIdentifier | External identifier. An external identifier is a persistent identifier for an object within a domain. | String |
| byteEnd | note: inclusive | NlpSaftLabeledSpan | A generic span, possibly with an associated label. The span may be defined by either byte-level or token-level boundaries. | integer |
| byteStart | The indices of the first and last byte covered by the span. | NlpSaftLabeledSpan | A generic span, possibly with an associated label. The span may be defined by either byte-level or token-level boundaries. | integer |
| label | The label associated with the span. | NlpSaftLabeledSpan | A generic span, possibly with an associated label. The span may be defined by either byte-level or token-level boundaries. | String |
| labelScores | Optionally stores alternative labels with associated scores for the span. | NlpSaftLabeledSpan | A generic span, possibly with an associated label. The span may be defined by either byte-level or token-level boundaries. | map |
| score | A score associated with the span. | NlpSaftLabeledSpan | A generic span, possibly with an associated label. The span may be defined by either byte-level or token-level boundaries. | number |
| tokenEnd | note: inclusive | NlpSaftLabeledSpan | A generic span, possibly with an associated label. The span may be defined by either byte-level or token-level boundaries. | integer |
| tokenStart | The indices of the first and last token covered by the span. | NlpSaftLabeledSpan | A generic span, possibly with an associated label. The span may be defined by either byte-level or token-level boundaries. | integer |
| labeledSpan | NlpSaftLabeledSpans | A list of labeled spans of the same type. | list(NlpSaftLabeledSpan) | |
| canonical | Canonical value for measurement. | NlpSaftMeasure | Measures in the documents. This covers both time expressions as well as physical quantities. | float |
| granularity | Granularity for measurement. | NlpSaftMeasure | Measures in the documents. This covers both time expressions as well as physical quantities. | float |
| info | Application-specific information about this measure. | NlpSaftMeasure | Measures in the documents. This covers both time expressions as well as physical quantities. | Proto2BridgeMessageSet |
| phrase | Phrase containing the measure. | NlpSaftMeasure | Measures in the documents. This covers both time expressions as well as physical quantities. | NlpSaftPhrase |
| type | NlpSaftMeasure | Measures in the documents. This covers both time expressions as well as physical quantities. | String | |
| unit | NlpSaftMeasure | Measures in the documents. This covers both time expressions as well as physical quantities. | String | |
| value | Measurement value and unit. | NlpSaftMeasure | Measures in the documents. This covers both time expressions as well as physical quantities. | String |
| confidence | Estimate of the confidence that this mention is in the correct cluster. Zero means this mention is probably in the wrong cluster, 1 means this mention is probably in the correct cluster. See nlp/saft/components/coreference/coreference-confidence.h for details about what “correct cluster” might mean. | NlpSaftMention | Mentions of the entity in the document. | float |
| info | Application-specific information about this mention. | NlpSaftMention | Mentions of the entity in the document. | Proto2BridgeMessageSet |
| kind | NlpSaftMention | Mentions of the entity in the document. | String | |
| nestingRelation | NlpSaftMention | Mentions of the entity in the document. | String | |
| phrase | Phrase for the mention. | NlpSaftMention | Mentions of the entity in the document. | NlpSaftPhrase |
| resolution | Mention-level resolution. This is used for encoding the meaning of the mention rather than the entity. For example, definite references and appositions are resolved to the mid for the concept rather than the entity. | NlpSaftMention | Mentions of the entity in the document. | NlpSaftMentionResolution |
| role | NlpSaftMention | Mentions of the entity in the document. | String | |
| type | NlpSaftMention | Mentions of the entity in the document. | String | |
| profile | Profile for mention information. | NlpSaftMentionResolution | Mention resolution for encoding the concept id (e.g. mid) for a mention. | NlpSaftEntityProfile |
| type | NlpSaftMentionResolution | Mention resolution for encoding the concept id (e.g. mid) for a mention. | String | |
| attrValue | A list of morphology attribute-value pairs. | NlpSaftMorphology | Message that stores information about the morphology of a token. | list(String) |
| end | NlpSaftPhrase | A document phrase marks a range of tokens in a document as a phrase. The indices are token positions in the document. | integer | |
| facet | NlpSaftPhrase | A document phrase marks a range of tokens in a document as a phrase. The indices are token positions in the document. | String | |
| head | The head token in the phrase is the id of the top-most token within the phrase. It either has an arc from outside the phrase going to it, or it is a root token of the sentence. A value of -1 indicates that the head has not yet been computed for the phrase (not the same semantics as the head of a token!). Note that even when it is uniquely defined, there is no guarantee that the head is set for entities and measurements within a document: you may need to explicitly compute it. | NlpSaftPhrase | A document phrase marks a range of tokens in a document as a phrase. The indices are token positions in the document. | integer |
| start | First and last token in the phrase. The phrase goes from start to end (inclusive). | NlpSaftPhrase | A document phrase marks a range of tokens in a document as a phrase. The indices are token positions in the document. | integer |
| distance | Distance of this referent from the markables in the Document. Smaller values imply that the referent is more accessible to be an antecedent for a markable in the Document. The expectation is that this field would increase with every new Document in which this referent is not mentioned. | NlpSaftReferent | A referent contains information about what a discourse context entity is referring to. It acts like a canonical mention of the entity. | float |
| explicitness | NlpSaftReferent | A referent contains information about what a discourse context entity is referring to. It acts like a canonical mention of the entity. | String | |
| info | Application-specific information about this referent. | NlpSaftReferent | A referent contains information about what a discourse context entity is referring to. It acts like a canonical mention of the entity. | Proto2BridgeMessageSet |
| phrase | Entity name phrase. The phrase indices are relative to the token array above. The phrase should normally cover all the tokens in the name and the head must be set to be the head token of the name. | NlpSaftReferent | A referent contains information about what a discourse context entity is referring to. It acts like a canonical mention of the entity. | NlpSaftPhrase |
| prominence | Prominence score for referent. This is roughly equivalent to the number of previous mentions of the referent. | NlpSaftReferent | A referent contains information about what a discourse context entity is referring to. It acts like a canonical mention of the entity. | float |
| role | NlpSaftReferent | A referent contains information about what a discourse context entity is referring to. It acts like a canonical mention of the entity. | String | |
| token | Tokenized representation for the canonical name of the referent entity. | NlpSaftReferent | A referent contains information about what a discourse context entity is referring to. It acts like a canonical mention of the entity. | list(NlpSaftToken) |
| identifier | External identifier for relation. | NlpSaftRelation | Relations between entities in the document. A relation is between two different entities in the document. A relation can have a number of mentions in the document. Next available id: 11 | NlpSaftIdentifier |
| info | Application-specific information about this relation. | NlpSaftRelation | Relations between entities in the document. A relation is between two different entities in the document. A relation can have a number of mentions in the document. Next available id: 11 | Proto2BridgeMessageSet |
| kind | NlpSaftRelation | Relations between entities in the document. A relation is between two different entities in the document. A relation can have a number of mentions in the document. Next available id: 11 | String | |
| mention | Mentions of the relation in the document. | NlpSaftRelation | Relations between entities in the document. A relation is between two different entities in the document. A relation can have a number of mentions in the document. Next available id: 11 | list(NlpSaftRelationMention) |
| score | Relation score. | NlpSaftRelation | Relations between entities in the document. A relation is between two different entities in the document. A relation can have a number of mentions in the document. Next available id: 11 | number |
| source | Source and target entity indices. These are indices into the entity array in the document. If this is an attribute relation the target is the index of a measure in the document. | NlpSaftRelation | Relations between entities in the document. A relation is between two different entities in the document. A relation can have a number of mentions in the document. Next available id: 11 | integer |
| target | NlpSaftRelation | Relations between entities in the document. A relation is between two different entities in the document. A relation can have a number of mentions in the document. Next available id: 11 | integer | |
| type | Relation type. | NlpSaftRelation | Relations between entities in the document. A relation is between two different entities in the document. A relation can have a number of mentions in the document. Next available id: 11 | String |
| typeId | Relation type id. | NlpSaftRelation | Relations between entities in the document. A relation is between two different entities in the document. A relation can have a number of mentions in the document. Next available id: 11 | integer |
| info | Application-specific information about this relation mention. | NlpSaftRelationMention | Mentions of relations in the document. A relation mention is between a mention of the source entity and a mention of the target entity. | Proto2BridgeMessageSet |
| phrase | Phrase in the document that indicates the relation mention. | NlpSaftRelationMention | Mentions of relations in the document. A relation mention is between a mention of the source entity and a mention of the target entity. | NlpSaftPhrase |
| source | Source and target mention indices. These are indices into the mention arrays for their respective entities. The target is not used for attributes. | NlpSaftRelationMention | Mentions of relations in the document. A relation mention is between a mention of the source entity and a mention of the target entity. | integer |
| sourceInfo | The info of the source models or systems of the relation mention. | NlpSaftRelationMention | Mentions of relations in the document. A relation mention is between a mention of the source entity and a mention of the target entity. | list(String) |
| target | NlpSaftRelationMention | Mentions of relations in the document. A relation mention is between a mention of the source entity and a mention of the target entity. | integer | |
| arc | The arcs from this node. For example, if this node is the root of a subgraph representing a predicate-argument structure, this node will typically refer to the predicate, and there will typically be one arc per argument. | NlpSaftSemanticNode | Semantic node for annotating semantic constructions in documents. A set of SemanticNode instances represents a directed acyclic graph with an adjacency list representation. Each node can optionally be connected to some existing type system, such as PropBank. Each node can optionally be connected to one or more concrete elements in a SAFT document, specifically, an entity mention, a measure and/or a token span (Phrase). Next available id: 23 | list(NlpSaftSemanticNodeArc) |
| confidence | Confidence score for the annotation. | NlpSaftSemanticNode | Semantic node for annotating semantic constructions in documents. A set of SemanticNode instances represents a directed acyclic graph with an adjacency list representation. Each node can optionally be connected to some existing type system, such as PropBank. Each node can optionally be connected to one or more concrete elements in a SAFT document, specifically, an entity mention, a measure and/or a token span (Phrase). Next available id: 23 | number |
| description | Human-readable description of the information in the subgraph represented by this node. This field is only meant for display purposes. | NlpSaftSemanticNode | Semantic node for annotating semantic constructions in documents. A set of SemanticNode instances represents a directed acyclic graph with an adjacency list representation. Each node can optionally be connected to some existing type system, such as PropBank. Each node can optionally be connected to one or more concrete elements in a SAFT document, specifically, an entity mention, a measure and/or a token span (Phrase). Next available id: 23 | String |
| entity | The entity and mention fields specify a unique entity mention referred to by this semantic node. | NlpSaftSemanticNode | Semantic node for annotating semantic constructions in documents. A set of SemanticNode instances represents a directed acyclic graph with an adjacency list representation. Each node can optionally be connected to some existing type system, such as PropBank. Each node can optionally be connected to one or more concrete elements in a SAFT document, specifically, an entity mention, a measure and/or a token span (Phrase). Next available id: 23 | integer |
| implicit | Indicates whether the semantic node is not explicit (grounded) in the text (e.g. pro-drop for a text author or an implicit predicate node for interpreting a compound noun), rather than any explicit phrase or text inside the document. | NlpSaftSemanticNode | Semantic node for annotating semantic constructions in documents. A set of SemanticNode instances represents a directed acyclic graph with an adjacency list representation. Each node can optionally be connected to some existing type system, such as PropBank. Each node can optionally be connected to one or more concrete elements in a SAFT document, specifically, an entity mention, a measure and/or a token span (Phrase). Next available id: 23 | boolean |
| info | Application-specific information about this node. | NlpSaftSemanticNode | Semantic node for annotating semantic constructions in documents. A set of SemanticNode instances represents a directed acyclic graph with an adjacency list representation. Each node can optionally be connected to some existing type system, such as PropBank. Each node can optionally be connected to one or more concrete elements in a SAFT document, specifically, an entity mention, a measure and/or a token span (Phrase). Next available id: 23 | Proto2BridgeMessageSet |
| kind | Encodes the kind of this node and, possibly, the entire subgraph rooted at this node. For example, if this node represents a predicate-argument structure in PropBank, then this node’s kind will be PROPBANK, its phrase field will be set to correspond to the span of tokens corresponding to the predicate (such as a verb) and it will have one arc per argument. If the kind is MONOTONIC this node corresponds to a semantic graph node, and arcs correspond to semantic graph edges outgoing from the node. If the kind field is not set, then this node is not directly connected to any type system. In such a case, this node may still optionally have a concrete “payload” in the form of references to an entity mention, measure or span of tokens (Phrase) in a SAFT document. The values or existence of the kind field need not be identical in any subgraph. For example, even if this node’s kind field is not set, it may still be the destination node of an arc from some other node whose kind field is set. | NlpSaftSemanticNode | Semantic node for annotating semantic constructions in documents. A set of SemanticNode instances represents a directed acyclic graph with an adjacency list representation. Each node can optionally be connected to some existing type system, such as PropBank. Each node can optionally be connected to one or more concrete elements in a SAFT document, specifically, an entity mention, a measure and/or a token span (Phrase). Next available id: 23 | String |
| measure | The index of the measure referred to by this semantic node. | NlpSaftSemanticNode | Semantic node for annotating semantic constructions in documents. A set of SemanticNode instances represents a directed acyclic graph with an adjacency list representation. Each node can optionally be connected to some existing type system, such as PropBank. Each node can optionally be connected to one or more concrete elements in a SAFT document, specifically, an entity mention, a measure and/or a token span (Phrase). Next available id: 23 | integer |
| mention | NlpSaftSemanticNode | Semantic node for annotating semantic constructions in documents. A set of SemanticNode instances represents a directed acyclic graph with an adjacency list representation. Each node can optionally be connected to some existing type system, such as PropBank. Each node can optionally be connected to one or more concrete elements in a SAFT document, specifically, an entity mention, a measure and/or a token span (Phrase). Next available id: 23 | integer | |
| phrase | Phrase (span of text) for this node. This field does not need to be set, but if it is, this node has a textual “payload” corresponding to the specified token span. For example, if this node is the root of a subgraph corresponding to a predicate-argument structure, then the phrase field will be set to be the span of tokens corresponding to the predicate (e.g., a verb). | NlpSaftSemanticNode | Semantic node for annotating semantic constructions in documents. A set of SemanticNode instances represents a directed acyclic graph with an adjacency list representation. Each node can optionally be connected to some existing type system, such as PropBank. Each node can optionally be connected to one or more concrete elements in a SAFT document, specifically, an entity mention, a measure and/or a token span (Phrase). Next available id: 23 | NlpSaftPhrase |
| type | Arbitrary type string for this semantic node, or for the subgraph rooted at this node. This type string might come from an external resource, type system or ontology that contains a predefined set of types. | NlpSaftSemanticNode | Semantic node for annotating semantic constructions in documents. A set of SemanticNode instances represents a directed acyclic graph with an adjacency list representation. Each node can optionally be connected to some existing type system, such as PropBank. Each node can optionally be connected to one or more concrete elements in a SAFT document, specifically, an entity mention, a measure and/or a token span (Phrase). Next available id: 23 | String |
| value | Arbitrary value string for this semantic node. | NlpSaftSemanticNode | Semantic node for annotating semantic constructions in documents. A set of SemanticNode instances represents a directed acyclic graph with an adjacency list representation. Each node can optionally be connected to some existing type system, such as PropBank. Each node can optionally be connected to one or more concrete elements in a SAFT document, specifically, an entity mention, a measure and/or a token span (Phrase). Next available id: 23 | String |
| description | Human-readable description of this arc’s type (for display purposes). | NlpSaftSemanticNodeArc | An arc contained by a source node pointing to a destination node in a directed acyclic graph. | String |
| implicit | Indicates the arc is for an implicit semantic relation between nodes, for example one that does not correspond to a grammatical relation in the text. | NlpSaftSemanticNodeArc | An arc contained by a source node pointing to a destination node in a directed acyclic graph. | boolean |
| info | Application-specific information about this arc. | NlpSaftSemanticNodeArc | An arc contained by a source node pointing to a destination node in a directed acyclic graph. | Proto2BridgeMessageSet |
| semanticNode | Index of the semantic node pointed to by this arc. | NlpSaftSemanticNodeArc | An arc contained by a source node pointing to a destination node in a directed acyclic graph. | integer |
| type | Arc type (akin to an edge label, or semantic operator). | NlpSaftSemanticNodeArc | An arc contained by a source node pointing to a destination node in a directed acyclic graph. | String |
| breakLevel | NlpSaftToken | A document token marks a span of bytes in the document text as a token or word. Next available index: 16. | String | |
| breakSkippedText | Whether the break skipped over non-tag text (excluding script/style). | NlpSaftToken | A document token marks a span of bytes in the document text as a token or word. Next available index: 16. | boolean |
| category | Coarse-grained word category for token. See README.categories for category inventory. | NlpSaftToken | A document token marks a span of bytes in the document text as a token or word. Next available index: 16. | String |
| end | NlpSaftToken | A document token marks a span of bytes in the document text as a token or word. Next available index: 16. | integer | |
| head | Head of this token in the dependency tree: the id of the token which has an arc going to this one. If it is the root token of a sentence, then it is set to -1. | NlpSaftToken | A document token marks a span of bytes in the document text as a token or word. Next available index: 16. | integer |
| info | Annotation for this token. | NlpSaftToken | A document token marks a span of bytes in the document text as a token or word. Next available index: 16. | Proto2BridgeMessageSet |
| label | Label for dependency relation between this token and its head. See README.labels for label inventory. | NlpSaftToken | A document token marks a span of bytes in the document text as a token or word. Next available index: 16. | String |
| lemma | Word lemma. This is only filled if the lemma is different from the word form. | NlpSaftToken | A document token marks a span of bytes in the document text as a token or word. Next available index: 16. | String |
| morph | Morphology information. | NlpSaftToken | A document token marks a span of bytes in the document text as a token or word. Next available index: 16. | NlpSaftMorphology |
| scriptCode | A string representation (typically four letters, sometimes longer) of the token’s Unicode script code, based on BCP 47/CLDR, capitalized according to ISO 15924. See i18n/identifiers/scriptcode.h for details. | NlpSaftToken | A document token marks a span of bytes in the document text as a token or word. Next available index: 16. | String |
| start | [start, end] describe the inclusive byte range of the UTF-8 encoded token in document.text. End gives the index of the last byte, which may be a UTF-8 continuation byte, and the length in bytes is end – start + 1. begin/end options are for goldmine AnnotationsFinder to locate the offsets of saft tokens. Start is inclusive by default and end is marked. | NlpSaftToken | A document token marks a span of bytes in the document text as a token or word. Next available index: 16. | integer |
| tag | Part-of-speech tag for token. See README.tags for tag inventory. | NlpSaftToken | A document token marks a span of bytes in the document text as a token or word. Next available index: 16. | String |
| tagConfidence | Confidence score for the tag prediction — should be interpreted as a probability estimate that the tag is correct. | NlpSaftToken | A document token marks a span of bytes in the document text as a token or word. Next available index: 16. | number |
| textProperties | NlpSaftToken | A document token marks a span of bytes in the document text as a token or word. Next available index: 16. | integer | |
| word | Token word form. This may not be identical to the original. For example, in goldmine annotation we do UTF-8 normalization and punctuation normalization. The punctuation normalization includes inferring the directionality of straight doublequotes — that is, we map ” to open quote (“) or close quote (”), and sometimes we get it wrong. SAFT processing in other contexts (such as queries in qrewrite) involves different normalizations. | NlpSaftToken | A document token marks a span of bytes in the document text as a token or word. Next available index: 16. | String |
| analyzedText | All the text in this article, separated into Sections and Paragraphs. See nlp_sciencelit.ScaleSetExtensions for the extensions to ScaleSet used. | NlpSciencelitArticleData | A copy of the text of an article along with references to internal figures and external citations, datasets, etc. Next available ID: 19 | NlxDataSchemaScaleSet |
| articleId | NlpSciencelitArticleData | A copy of the text of an article along with references to internal figures and external citations, datasets, etc. Next available ID: 19 | list(NlpSciencelitArticleId) | |
| citation | All references from this article (Bibliography). | NlpSciencelitArticleData | A copy of the text of an article along with references to internal figures and external citations, datasets, etc. Next available ID: 19 | list(NlpSciencelitCitationData) |
| earliestPubDate | The result of selecting the earliest date from various metadata (PMC, PubMed Metadata, scholar citations). | NlpSciencelitArticleData | A copy of the text of an article along with references to internal figures and external citations, datasets, etc. Next available ID: 19 | String |
| metadata | NlpSciencelitArticleData | A copy of the text of an article along with references to internal figures and external citations, datasets, etc. Next available ID: 19 | NlpSciencelitArticleMetadata | |
| nonAbstractWordCount | NlpSciencelitArticleData | A copy of the text of an article along with references to internal figures and external citations, datasets, etc. Next available ID: 19 | String | |
| parsedFrom | Path of the source document from which this was parsed. | NlpSciencelitArticleData | A copy of the text of an article along with references to internal figures and external citations, datasets, etc. Next available ID: 19 | String |
| pubDate | All dates from the PMC article metadata Year/Mon/Day. | NlpSciencelitArticleData | A copy of the text of an article along with references to internal figures and external citations, datasets, etc. Next available ID: 19 | list(NlpSciencelitPubDate) |
| referencedBlock | All figure captions within this article. | NlpSciencelitArticleData | A copy of the text of an article along with references to internal figures and external citations, datasets, etc. Next available ID: 19 | list(NlpSciencelitReferencedBlock) |
| scholarCitation | Citation for this article. | NlpSciencelitArticleData | A copy of the text of an article along with references to internal figures and external citations, datasets, etc. Next available ID: 19 | ScienceCitation |
| scholarDocument | DocJoins with full text article. | NlpSciencelitArticleData | A copy of the text of an article along with references to internal figures and external citations, datasets, etc. Next available ID: 19 | list(CompositeDoc) |
| scholarSignal | May also add the Scholar index signal information: | NlpSciencelitArticleData | A copy of the text of an article along with references to internal figures and external citations, datasets, etc. Next available ID: 19 | ScienceIndexSignal |
| source | Source of this article data (e.g., PubMed, scholar index, other source.). | NlpSciencelitArticleData | A copy of the text of an article along with references to internal figures and external citations, datasets, etc. Next available ID: 19 | String |
| title | NlpSciencelitArticleData | A copy of the text of an article along with references to internal figures and external citations, datasets, etc. Next available ID: 19 | String | |
| wordCount | Number of words in the entire article and everywhere outside of abstract sections. | NlpSciencelitArticleData | A copy of the text of an article along with references to internal figures and external citations, datasets, etc. Next available ID: 19 | String |
| id | NlpSciencelitArticleId | Article IDs associated with an article (e.g., PMID, DOI, PMC). | String | |
| idType | NlpSciencelitArticleId | Article IDs associated with an article (e.g., PMID, DOI, PMC). | String | |
| abstract | Abstract of article from metadata. | NlpSciencelitArticleMetadata | Next available ID: 20. | NlpSciencelitTokenizedText |
| articleId | NlpSciencelitArticleMetadata | Next available ID: 20. | list(NlpSciencelitArticleId) | |
| author | Author of article. | NlpSciencelitArticleMetadata | Next available ID: 20. | list(NlpSciencelitAuthor) |
| dataset | Datasets referenced from this article. | NlpSciencelitArticleMetadata | Next available ID: 20. | list(NlpSciencelitDataset) |
| dateStr | Most recent date YYYY-MM-DD. | NlpSciencelitArticleMetadata | Next available ID: 20. | String |
| deleted | Citation for flagged for deletion by source. | NlpSciencelitArticleMetadata | Next available ID: 20. | boolean |
| heading | Mesh Terms. | NlpSciencelitArticleMetadata | Next available ID: 20. | list(NlpSciencelitMeshHeading) |
| issue | NlpSciencelitArticleMetadata | Next available ID: 20. | String | |
| journal | Title of journal. For books: Journal = Publisher Volume = Collection | NlpSciencelitArticleMetadata | Next available ID: 20. | String |
| language | NlpSciencelitArticleMetadata | Next available ID: 20. | String | |
| lastRevisedDateStr | Last entry revision date YYYY-MM-DD. | NlpSciencelitArticleMetadata | Next available ID: 20. | String |
| metadataSource | NlpSciencelitArticleMetadata | Next available ID: 20. | list(String) | |
| parsedFrom | Source Pubmed/Medline XML file. | NlpSciencelitArticleMetadata | Next available ID: 20. | String |
| pmid | PMID of article (for non-pubmed data, this is the docid). | NlpSciencelitArticleMetadata | Next available ID: 20. | String |
| publicationType | NlpSciencelitArticleMetadata | Next available ID: 20. | list(NlpSciencelitPublicationType) | |
| scamRestrictTokens | Optional ScaM restrict tokens to be added to all GFVs generated from this article’s data. | NlpSciencelitArticleMetadata | Next available ID: 20. | ResearchScamV3Restrict |
| title | Title of article. | NlpSciencelitArticleMetadata | Next available ID: 20. | String |
| url | URL(s) for the document. If possible, order by decreasing desirability. | NlpSciencelitArticleMetadata | Next available ID: 20. | list(String) |
| volume | NlpSciencelitArticleMetadata | Next available ID: 20. | String | |
| firstName | NlpSciencelitAuthor | String | ||
| lastName | NlpSciencelitAuthor | String | ||
| articleId | NlpSciencelitCitationData | Next available ID: 8 | list(NlpSciencelitArticleId) | |
| author | NlpSciencelitCitationData | Next available ID: 8 | list(NlpSciencelitAuthor) | |
| externalLink | NlpSciencelitCitationData | Next available ID: 8 | String | |
| fullText | NlpSciencelitCitationData | Next available ID: 8 | String | |
| reference | Reference used in text (e.g., PMC rid). | NlpSciencelitCitationData | Next available ID: 8 | String |
| scholarCitation | Scholar citation information from scholar index. | NlpSciencelitCitationData | Next available ID: 8 | ScienceCitation |
| title | Optional information about the publication. | NlpSciencelitCitationData | Next available ID: 8 | String |
| association | NlpSciencelitDataset | String | ||
| datasetMetadata | NlpSciencelitDataset | ResearchScienceSearchReconciledMetadata | ||
| meshDescriptor | NlpSciencelitMeshHeading | A full Mesh Heading containing a descriptor and optionally multiple qualifiers. https://www.nlm.nih.gov/bsd/licensee/elements_descriptions.html#meshheadinglist | NlpSciencelitSubjectHeading | |
| meshQualifier | NlpSciencelitMeshHeading | A full Mesh Heading containing a descriptor and optionally multiple qualifiers. https://www.nlm.nih.gov/bsd/licensee/elements_descriptions.html#meshheadinglist | list(NlpSciencelitSubjectHeading) | |
| dateStr | NlpSciencelitPubDate | Pubdate extracted from PMC article metadata. | String | |
| pubType | “ppub” for a print ISSN and “epub” for an electronic ISSN. | NlpSciencelitPubDate | Pubdate extracted from PMC article metadata. | String |
| name | Display name for the publication type, e.g. “Journal Article” | NlpSciencelitPublicationType | String | |
| ui | MeSH unique identifiers for publication types, e.g. “D016428” | NlpSciencelitPublicationType | String | |
| caption | Caption tokens – all text in the caption other than the block. | NlpSciencelitReferencedBlock | Data associate with the ReferencesBlock. Next available ID: 5 | NlpSciencelitTokenizedText |
| reference | Reference used from the text to point to this figure. | NlpSciencelitReferencedBlock | Data associate with the ReferencesBlock. Next available ID: 5 | String |
| title | Title tokens – these come from a block within a caption. | NlpSciencelitReferencedBlock | Data associate with the ReferencesBlock. Next available ID: 5 | NlpSciencelitTokenizedText |
| type | Type of figure (table, figure, etc.). | NlpSciencelitReferencedBlock | Data associate with the ReferencesBlock. Next available ID: 5 | String |
| scamQueryEncoding | The query encoding sent to scam for retrieval. | NlpSciencelitRetrievalQueryEncodingDebugInfo | ResearchScamGenericFeatureVector | |
| articleData | Only set if RequestOptions.debug_return_article_data is true. | NlpSciencelitRetrievalSearchResultDebugInfo | Returned by Delver API in SearchResult.debug_info. | NlpSciencelitArticleData |
| goldDocid | NlpSciencelitRetrievalSearchResultDebugInfo | Returned by Delver API in SearchResult.debug_info. | list(String) | |
| goldSnippets | NlpSciencelitRetrievalSearchResultDebugInfo | Returned by Delver API in SearchResult.debug_info. | list(String) | |
| isGold | Not set by server; only used by evals. | NlpSciencelitRetrievalSearchResultDebugInfo | Returned by Delver API in SearchResult.debug_info. | boolean |
| rerankingScore | See SearchResultInternal.reranking_score. | NlpSciencelitRetrievalSearchResultDebugInfo | Returned by Delver API in SearchResult.debug_info. | number |
| reverseRerankingOrder | See SearchResultInternal.reverse_reranking_order. | NlpSciencelitRetrievalSearchResultDebugInfo | Returned by Delver API in SearchResult.debug_info. | integer |
| sectionIrScore | See SearchResultInternal.section_ir_score. | NlpSciencelitRetrievalSearchResultDebugInfo | Returned by Delver API in SearchResult.debug_info. | map |
| queryEncoding | NlpSciencelitRetrievalSearchResultSetDebugInfo | Optionally returned by Delver API in the response’s debug_info field. | NlpSciencelitRetrievalQueryEncodingDebugInfo | |
| scamResponse | NlpSciencelitRetrievalSearchResultSetDebugInfo | Optionally returned by Delver API in the response’s debug_info field. | ResearchScamQueryResponse | |
| goldHighlightSentenceIndices | Which highlights have sentence overlap with gold snippets. Not ordered. Might only be set for the first gold highlight. | NlpSciencelitRetrievalSnippetDebugInfo | Returned by Delver API in Snippet.debug_info. | list(integer) |
| highlightIdxToOverlap | Map of highlight index to best overlap with any gold snippet [0,1]. | NlpSciencelitRetrievalSnippetDebugInfo | Returned by Delver API in Snippet.debug_info. | map |
| highlightIdxToSentenceOverlap | Map of highlight index to best overlap with any gold sentence [0,1]. | NlpSciencelitRetrievalSnippetDebugInfo | Returned by Delver API in Snippet.debug_info. | map |
| isGold | Not set by server; only used by certain evals. Might only be set for the first gold snippet. | NlpSciencelitRetrievalSnippetDebugInfo | Returned by Delver API in Snippet.debug_info. | boolean |
| offsetWithinSection | Byte index of text within the full section text (or within title). | NlpSciencelitRetrievalSnippetDebugInfo | Returned by Delver API in Snippet.debug_info. | integer |
| sectionIndex | Section within the document. -1 if title. | NlpSciencelitRetrievalSnippetDebugInfo | Returned by Delver API in Snippet.debug_info. | integer |
| sectionIrScore | IR score of the section the snippet is coming from. | NlpSciencelitRetrievalSnippetDebugInfo | Returned by Delver API in Snippet.debug_info. | number |
| snippetBleuScore | BLEU score for the entire snippet. | NlpSciencelitRetrievalSnippetDebugInfo | Returned by Delver API in Snippet.debug_info. | number |
| id | NlpSciencelitSubjectHeading | A subject heading from Mesh | String | |
| majorTopic | NlpSciencelitSubjectHeading | A subject heading from Mesh | boolean | |
| term | NlpSciencelitSubjectHeading | A subject heading from Mesh | String | |
| text | NlpSciencelitTokenizedText | Tokenized text with optional original representation. | String | |
| token | NlpSciencelitTokenizedText | Tokenized text with optional original representation. | list(String) | |
| additionalSpans | Additional spans after the first. Empty in all additional_spans. | NlpSemanticParsingAnnotationEvalData | Annotators whose semantics are represented via a protocol message should add to that message a field or extension of this type and set it using Annotator::PopulateAnnotationEvalData to enable span-based evaluation metrics in training. Evaluation is done based on token spans. The byte span aligns with the token span and is used when saving examples. Background: In some settings, the examples used to induce/train a grammar do not specify complete semantics of an annotation. For example, some examples that come from Ewok specify only the span associated with each annotation. This message allows evaluation metrics to test the span by embedding it in the semantics. LINT.IfChange | list(NlpSemanticParsingAnnotationEvalData) |
| numBytes | NlpSemanticParsingAnnotationEvalData | Annotators whose semantics are represented via a protocol message should add to that message a field or extension of this type and set it using Annotator::PopulateAnnotationEvalData to enable span-based evaluation metrics in training. Evaluation is done based on token spans. The byte span aligns with the token span and is used when saving examples. Background: In some settings, the examples used to induce/train a grammar do not specify complete semantics of an annotation. For example, some examples that come from Ewok specify only the span associated with each annotation. This message allows evaluation metrics to test the span by embedding it in the semantics. LINT.IfChange | integer | |
| numTokens | NlpSemanticParsingAnnotationEvalData | Annotators whose semantics are represented via a protocol message should add to that message a field or extension of this type and set it using Annotator::PopulateAnnotationEvalData to enable span-based evaluation metrics in training. Evaluation is done based on token spans. The byte span aligns with the token span and is used when saving examples. Background: In some settings, the examples used to induce/train a grammar do not specify complete semantics of an annotation. For example, some examples that come from Ewok specify only the span associated with each annotation. This message allows evaluation metrics to test the span by embedding it in the semantics. LINT.IfChange | integer | |
| startByte | Byte position within the utterance. Safe to use across different components of the NLU stack as long as said components have access to the same query. | NlpSemanticParsingAnnotationEvalData | Annotators whose semantics are represented via a protocol message should add to that message a field or extension of this type and set it using Annotator::PopulateAnnotationEvalData to enable span-based evaluation metrics in training. Evaluation is done based on token spans. The byte span aligns with the token span and is used when saving examples. Background: In some settings, the examples used to induce/train a grammar do not specify complete semantics of an annotation. For example, some examples that come from Ewok specify only the span associated with each annotation. This message allows evaluation metrics to test the span by embedding it in the semantics. LINT.IfChange | integer |
| startToken | Token position. This is cleared when normalizing examples for storage because tokenization changes over time. DO NOT use these two fields across components that use different tokenizations. | NlpSemanticParsingAnnotationEvalData | Annotators whose semantics are represented via a protocol message should add to that message a field or extension of this type and set it using Annotator::PopulateAnnotationEvalData to enable span-based evaluation metrics in training. Evaluation is done based on token spans. The byte span aligns with the token span and is used when saving examples. Background: In some settings, the examples used to induce/train a grammar do not specify complete semantics of an annotation. For example, some examples that come from Ewok specify only the span associated with each annotation. This message allows evaluation metrics to test the span by embedding it in the semantics. LINT.IfChange | integer |
| appInfo | The app_info is to store specific information about installed/uninstalled apps annotated by app annotator servlet. It contains app name, package name, confidence, and source. | NlpSemanticParsingAppAnnotation | The App annotator annotates potential app name in the parser’s input and outputs the proto with the details about app(s). | list(QualityActionsAppInfo) |
| allowPersonal | allow_personal determines if personal datetimes are allowed to be used in the resolution of the personal datetime. If allow_personal is false and a personal date exists, the entire parse will be thrown out. | NlpSemanticParsingDatetimeAbsoluteDateTime | AbsoluteDateTime represents the resolved date/time expressions that need no further calculation. It has a section for date and a section for time. The date section will always be filled; if the time section is filled, hour is always filled; for (minute, second, partial_second), they are optional with a zero default value. But if partial_second is filled, (minute, second) must be filled, even they are 0s; if second is filled, minute must be filled. Next field#: 22. | boolean |
| day | NlpSemanticParsingDatetimeAbsoluteDateTime | AbsoluteDateTime represents the resolved date/time expressions that need no further calculation. It has a section for date and a section for time. The date section will always be filled; if the time section is filled, hour is always filled; for (minute, second, partial_second), they are optional with a zero default value. But if partial_second is filled, (minute, second) must be filled, even they are 0s; if second is filled, minute must be filled. Next field#: 22. | integer | |
| deleted11 | Deprecated fields. Do NOT use. | NlpSemanticParsingDatetimeAbsoluteDateTime | AbsoluteDateTime represents the resolved date/time expressions that need no further calculation. It has a section for date and a section for time. The date section will always be filled; if the time section is filled, hour is always filled; for (minute, second, partial_second), they are optional with a zero default value. But if partial_second is filled, (minute, second) must be filled, even they are 0s; if second is filled, minute must be filled. Next field#: 22. | String |
| holiday | season, quarters and holidays will be soon handled as fetched relative datetimes and will be removed from the AbsoluteDateTime message. | NlpSemanticParsingDatetimeAbsoluteDateTime | AbsoluteDateTime represents the resolved date/time expressions that need no further calculation. It has a section for date and a section for time. The date section will always be filled; if the time section is filled, hour is always filled; for (minute, second, partial_second), they are optional with a zero default value. But if partial_second is filled, (minute, second) must be filled, even they are 0s; if second is filled, minute must be filled. Next field#: 22. | NlpSemanticParsingDatetimeHoliday |
| hour | Time is 24-hour military time. | NlpSemanticParsingDatetimeAbsoluteDateTime | AbsoluteDateTime represents the resolved date/time expressions that need no further calculation. It has a section for date and a section for time. The date section will always be filled; if the time section is filled, hour is always filled; for (minute, second, partial_second), they are optional with a zero default value. But if partial_second is filled, (minute, second) must be filled, even they are 0s; if second is filled, minute must be filled. Next field#: 22. | integer |
| hourState | Note: This is marked as deprecated as we are moving into explicit parses using the `meridiem` field, and leave the inference over implicit parses to the grounding/resolution libraries. | NlpSemanticParsingDatetimeAbsoluteDateTime | AbsoluteDateTime represents the resolved date/time expressions that need no further calculation. It has a section for date and a section for time. The date section will always be filled; if the time section is filled, hour is always filled; for (minute, second, partial_second), they are optional with a zero default value. But if partial_second is filled, (minute, second) must be filled, even they are 0s; if second is filled, minute must be filled. Next field#: 22. | String |
| isBc | |is_bc| is true if and only the date is Before Christ/Common Era. If |is_bc| is true, only year is meaningful in this proto, as Gregorian calendar is only meaningful for A.D. date/times. | NlpSemanticParsingDatetimeAbsoluteDateTime | AbsoluteDateTime represents the resolved date/time expressions that need no further calculation. It has a section for date and a section for time. The date section will always be filled; if the time section is filled, hour is always filled; for (minute, second, partial_second), they are optional with a zero default value. But if partial_second is filled, (minute, second) must be filled, even they are 0s; if second is filled, minute must be filled. Next field#: 22. | boolean |
| meridiem | For expressions such as “am”, “pm”. Note: the name “meridiem” has been taken by a field in message ResolutionProperties. Examples: * “9 am”: point { hour: 9 meridiem: AM hour_state: UNAMBIGUOUS } | NlpSemanticParsingDatetimeAbsoluteDateTime | AbsoluteDateTime represents the resolved date/time expressions that need no further calculation. It has a section for date and a section for time. The date section will always be filled; if the time section is filled, hour is always filled; for (minute, second, partial_second), they are optional with a zero default value. But if partial_second is filled, (minute, second) must be filled, even they are 0s; if second is filled, minute must be filled. Next field#: 22. | String |
| minute | NlpSemanticParsingDatetimeAbsoluteDateTime | AbsoluteDateTime represents the resolved date/time expressions that need no further calculation. It has a section for date and a section for time. The date section will always be filled; if the time section is filled, hour is always filled; for (minute, second, partial_second), they are optional with a zero default value. But if partial_second is filled, (minute, second) must be filled, even they are 0s; if second is filled, minute must be filled. Next field#: 22. | integer | |
| modifier | For expressions such as “around 2 pm”. | NlpSemanticParsingDatetimeAbsoluteDateTime | AbsoluteDateTime represents the resolved date/time expressions that need no further calculation. It has a section for date and a section for time. The date section will always be filled; if the time section is filled, hour is always filled; for (minute, second, partial_second), they are optional with a zero default value. But if partial_second is filled, (minute, second) must be filled, even they are 0s; if second is filled, minute must be filled. Next field#: 22. | String |
| month | NlpSemanticParsingDatetimeAbsoluteDateTime | AbsoluteDateTime represents the resolved date/time expressions that need no further calculation. It has a section for date and a section for time. The date section will always be filled; if the time section is filled, hour is always filled; for (minute, second, partial_second), they are optional with a zero default value. But if partial_second is filled, (minute, second) must be filled, even they are 0s; if second is filled, minute must be filled. Next field#: 22. | String | |
| nonGregorianDate | If present then: 1) the incoming non-Gregorian datetime will be converted to Gregorian. 2) exported DateTimeProperty fields will contain the converted Gregorian datetime. 3) DateTimeProperty.source_calendar will be set to the calendar-system that was used to specify the non-Gregorian date. | NlpSemanticParsingDatetimeAbsoluteDateTime | AbsoluteDateTime represents the resolved date/time expressions that need no further calculation. It has a section for date and a section for time. The date section will always be filled; if the time section is filled, hour is always filled; for (minute, second, partial_second), they are optional with a zero default value. But if partial_second is filled, (minute, second) must be filled, even they are 0s; if second is filled, minute must be filled. Next field#: 22. | NlpSemanticParsingDatetimeNonGregorianDate |
| partialSecond | NlpSemanticParsingDatetimeAbsoluteDateTime | AbsoluteDateTime represents the resolved date/time expressions that need no further calculation. It has a section for date and a section for time. The date section will always be filled; if the time section is filled, hour is always filled; for (minute, second, partial_second), they are optional with a zero default value. But if partial_second is filled, (minute, second) must be filled, even they are 0s; if second is filled, minute must be filled. Next field#: 22. | float | |
| properties | NlpSemanticParsingDatetimeAbsoluteDateTime | AbsoluteDateTime represents the resolved date/time expressions that need no further calculation. It has a section for date and a section for time. The date section will always be filled; if the time section is filled, hour is always filled; for (minute, second, partial_second), they are optional with a zero default value. But if partial_second is filled, (minute, second) must be filled, even they are 0s; if second is filled, minute must be filled. Next field#: 22. | NlpSemanticParsingDatetimeDateTimeProperty | |
| quarter | NlpSemanticParsingDatetimeAbsoluteDateTime | AbsoluteDateTime represents the resolved date/time expressions that need no further calculation. It has a section for date and a section for time. The date section will always be filled; if the time section is filled, hour is always filled; for (minute, second, partial_second), they are optional with a zero default value. But if partial_second is filled, (minute, second) must be filled, even they are 0s; if second is filled, minute must be filled. Next field#: 22. | String | |
| rangeModifier | Modifier that return the appropriate subrange. For more information, see the description of RangeOfDateTimeModifier. Example: * *early* 2020 * *early* on March 20th When a point have a range_modifier field, the resolution library will expand the point into the widest range in contains. For example, in the case of a single date point like “April 22nd, 2022”, the point will be transformed into a range with: – “begin: April 22nd 2022 00:00:00h” – “end: April 22nd 2022 23:59:59h” The modifier will then be applied over that range. | NlpSemanticParsingDatetimeAbsoluteDateTime | AbsoluteDateTime represents the resolved date/time expressions that need no further calculation. It has a section for date and a section for time. The date section will always be filled; if the time section is filled, hour is always filled; for (minute, second, partial_second), they are optional with a zero default value. But if partial_second is filled, (minute, second) must be filled, even they are 0s; if second is filled, minute must be filled. Next field#: 22. | String |
| season | NlpSemanticParsingDatetimeAbsoluteDateTime | AbsoluteDateTime represents the resolved date/time expressions that need no further calculation. It has a section for date and a section for time. The date section will always be filled; if the time section is filled, hour is always filled; for (minute, second, partial_second), they are optional with a zero default value. But if partial_second is filled, (minute, second) must be filled, even they are 0s; if second is filled, minute must be filled. Next field#: 22. | String | |
| second | NlpSemanticParsingDatetimeAbsoluteDateTime | AbsoluteDateTime represents the resolved date/time expressions that need no further calculation. It has a section for date and a section for time. The date section will always be filled; if the time section is filled, hour is always filled; for (minute, second, partial_second), they are optional with a zero default value. But if partial_second is filled, (minute, second) must be filled, even they are 0s; if second is filled, minute must be filled. Next field#: 22. | integer | |
| timezone | A string representation of the timezone information, see i18n/identifiers/timezones.{h,cc}. | NlpSemanticParsingDatetimeAbsoluteDateTime | AbsoluteDateTime represents the resolved date/time expressions that need no further calculation. It has a section for date and a section for time. The date section will always be filled; if the time section is filled, hour is always filled; for (minute, second, partial_second), they are optional with a zero default value. But if partial_second is filled, (minute, second) must be filled, even they are 0s; if second is filled, minute must be filled. Next field#: 22. | String |
| weekday | The |weekday| field is populated to indicate that a day-of-the-week is explicitly mentioned in an absolute date utterance, such as [Tuesday, July 6th, 2021]. Note that when a day-of-the-week is included in other, non-absolute-date expressions, such as [on Tuesday], then this this field is not populated (and in fact an AbsoluteDateTime is not used at all.) Note: This field is populated only when the original expression contains a day-of-the-week. It is not populated by the grounding library to indicate that the date happens to be a Tuesday. Examples: * “Tuesday, July 6th 2021” –> the day of the week is part of an absolute date expression, so this field is populated: point { year: 2021 month: JULY day: 6 weekday: TUESDAY } * “on Tuesday” –> the day of the week is not part of an absolute date expression, so it is interpreted as a relative datetime: relative { fetched { target { weekday: TUESDAY } } } | NlpSemanticParsingDatetimeAbsoluteDateTime | AbsoluteDateTime represents the resolved date/time expressions that need no further calculation. It has a section for date and a section for time. The date section will always be filled; if the time section is filled, hour is always filled; for (minute, second, partial_second), they are optional with a zero default value. But if partial_second is filled, (minute, second) must be filled, even they are 0s; if second is filled, minute must be filled. Next field#: 22. | String |
| year | Date. | NlpSemanticParsingDatetimeAbsoluteDateTime | AbsoluteDateTime represents the resolved date/time expressions that need no further calculation. It has a section for date and a section for time. The date section will always be filled; if the time section is filled, hour is always filled; for (minute, second, partial_second), they are optional with a zero default value. But if partial_second is filled, (minute, second) must be filled, even they are 0s; if second is filled, minute must be filled. Next field#: 22. | integer |
| dateType | NlpSemanticParsingDateTimeAnnotation | Example: “Remind me to go to the store on (Friday) (9am)” would output two non-overlapping and unrelated annotations. One would have a start_date = Friday and the other would have start_time = 9am. It’s possible for Friday to be one of several upcoming Friday’s, so start_date is a repeated field. Next ID: 10 | String | |
| endDate | NlpSemanticParsingDateTimeAnnotation | Example: “Remind me to go to the store on (Friday) (9am)” would output two non-overlapping and unrelated annotations. One would have a start_date = Friday and the other would have start_time = 9am. It’s possible for Friday to be one of several upcoming Friday’s, so start_date is a repeated field. Next ID: 10 | list(String) | |
| endTime | NlpSemanticParsingDateTimeAnnotation | Example: “Remind me to go to the store on (Friday) (9am)” would output two non-overlapping and unrelated annotations. One would have a start_date = Friday and the other would have start_time = 9am. It’s possible for Friday to be one of several upcoming Friday’s, so start_date is a repeated field. Next ID: 10 | list(String) | |
| endWeekday | NlpSemanticParsingDateTimeAnnotation | Example: “Remind me to go to the store on (Friday) (9am)” would output two non-overlapping and unrelated annotations. One would have a start_date = Friday and the other would have start_time = 9am. It’s possible for Friday to be one of several upcoming Friday’s, so start_date is a repeated field. Next ID: 10 | String | |
| rawText | NlpSemanticParsingDateTimeAnnotation | Example: “Remind me to go to the store on (Friday) (9am)” would output two non-overlapping and unrelated annotations. One would have a start_date = Friday and the other would have start_time = 9am. It’s possible for Friday to be one of several upcoming Friday’s, so start_date is a repeated field. Next ID: 10 | String | |
| startDate | NOTE: None of these are co-indexed. If the query is ‘morning’, there could be multiple start_time’s, start_date’s, end_date’s, and end_time’s, and they do not correspond to one another in any structured way. | NlpSemanticParsingDateTimeAnnotation | Example: “Remind me to go to the store on (Friday) (9am)” would output two non-overlapping and unrelated annotations. One would have a start_date = Friday and the other would have start_time = 9am. It’s possible for Friday to be one of several upcoming Friday’s, so start_date is a repeated field. Next ID: 10 | list(String) |
| startTime | NlpSemanticParsingDateTimeAnnotation | Example: “Remind me to go to the store on (Friday) (9am)” would output two non-overlapping and unrelated annotations. One would have a start_date = Friday and the other would have start_time = 9am. It’s possible for Friday to be one of several upcoming Friday’s, so start_date is a repeated field. Next ID: 10 | list(String) | |
| startWeekday | NlpSemanticParsingDateTimeAnnotation | Example: “Remind me to go to the store on (Friday) (9am)” would output two non-overlapping and unrelated annotations. One would have a start_date = Friday and the other would have start_time = 9am. It’s possible for Friday to be one of several upcoming Friday’s, so start_date is a repeated field. Next ID: 10 | String | |
| timeType | NlpSemanticParsingDateTimeAnnotation | Example: “Remind me to go to the store on (Friday) (9am)” would output two non-overlapping and unrelated annotations. One would have a start_date = Friday and the other would have start_time = 9am. It’s possible for Friday to be one of several upcoming Friday’s, so start_date is a repeated field. Next ID: 10 | String | |
| compositionElement | For temporal expressions that consist of components with different types, the elements in the composition are nested according to the order they should be grounded/resolved. For example, “tomorrow at 8am” has a relative component [tomorrow] and an absolute datetime component [8am] so the annotation will be represented in the following way, indicating that the relative datetime for tomorrow should be grounded first, and then resolve the actual 8am point for that given date: point { hour: 8 hour_state: UNAMBIGUOUS properties { time_format: AM_PM_TOKEN } } composition_element { relative { fetched { ordinal: 1 target { unit: DAY } base_type: CURRENT_DATETIME } } grounding_stage: UNGROUNDED } grounding_stage: UNGROUNDED_COMPOSITION The composition_element field will be populated only when the grounding_stage is set to UNGROUNDED_COMPOSITION and it will hold the nested DateTime value for the rest the compositional expression. More details in: go/datetime-resolution-decoupling. | NlpSemanticParsingDatetimeDateTime | The top-level DATE/TIME representation. It can represent either (1) one or multiple Date/Time ranges, or (2) one or multiple of Date/Time points, or (3) a recurrent date/time expression. Next available ID: 12. Only one of |range|, |point| and |recurrent| will be set: |range| contains a list of resolved Date/Time ranges. |point| contains a list of resolved Date/Time points. |recurrent| contains the representation for periodical dates/times. |range| and |point| are repeated to accommodate the need when the date/time expression under one non-terminal is resolved to a list of correct values. For example, “Mondays in April, 2014” may have 4 correct dates. | NlpSemanticParsingDatetimeDateTime |
| deleted7 | Deprecated fields. Do NOT use. | NlpSemanticParsingDatetimeDateTime | The top-level DATE/TIME representation. It can represent either (1) one or multiple Date/Time ranges, or (2) one or multiple of Date/Time points, or (3) a recurrent date/time expression. Next available ID: 12. Only one of |range|, |point| and |recurrent| will be set: |range| contains a list of resolved Date/Time ranges. |point| contains a list of resolved Date/Time points. |recurrent| contains the representation for periodical dates/times. |range| and |point| are repeated to accommodate the need when the date/time expression under one non-terminal is resolved to a list of correct values. For example, “Mondays in April, 2014” may have 4 correct dates. | boolean |
| deleted8 | NlpSemanticParsingDatetimeDateTime | The top-level DATE/TIME representation. It can represent either (1) one or multiple Date/Time ranges, or (2) one or multiple of Date/Time points, or (3) a recurrent date/time expression. Next available ID: 12. Only one of |range|, |point| and |recurrent| will be set: |range| contains a list of resolved Date/Time ranges. |point| contains a list of resolved Date/Time points. |recurrent| contains the representation for periodical dates/times. |range| and |point| are repeated to accommodate the need when the date/time expression under one non-terminal is resolved to a list of correct values. For example, “Mondays in April, 2014” may have 4 correct dates. | boolean | |
| evalData | This field of the DateTime message should not in general be used by outside clients of the grammar. It is intended to be used internally in Aqua for evaluation purposes. The rationale is that token counts depend on the particular tokenization used in Aqua which may be different from the one used by the client and may change from time to time. Outside clients should not create a dependency on the current tokenization used in Aqua. | NlpSemanticParsingDatetimeDateTime | The top-level DATE/TIME representation. It can represent either (1) one or multiple Date/Time ranges, or (2) one or multiple of Date/Time points, or (3) a recurrent date/time expression. Next available ID: 12. Only one of |range|, |point| and |recurrent| will be set: |range| contains a list of resolved Date/Time ranges. |point| contains a list of resolved Date/Time points. |recurrent| contains the representation for periodical dates/times. |range| and |point| are repeated to accommodate the need when the date/time expression under one non-terminal is resolved to a list of correct values. For example, “Mondays in April, 2014” may have 4 correct dates. | NlpSemanticParsingAnnotationEvalData |
| groundingStage | NlpSemanticParsingDatetimeDateTime | The top-level DATE/TIME representation. It can represent either (1) one or multiple Date/Time ranges, or (2) one or multiple of Date/Time points, or (3) a recurrent date/time expression. Next available ID: 12. Only one of |range|, |point| and |recurrent| will be set: |range| contains a list of resolved Date/Time ranges. |point| contains a list of resolved Date/Time points. |recurrent| contains the representation for periodical dates/times. |range| and |point| are repeated to accommodate the need when the date/time expression under one non-terminal is resolved to a list of correct values. For example, “Mondays in April, 2014” may have 4 correct dates. | String | |
| point | NlpSemanticParsingDatetimeDateTime | The top-level DATE/TIME representation. It can represent either (1) one or multiple Date/Time ranges, or (2) one or multiple of Date/Time points, or (3) a recurrent date/time expression. Next available ID: 12. Only one of |range|, |point| and |recurrent| will be set: |range| contains a list of resolved Date/Time ranges. |point| contains a list of resolved Date/Time points. |recurrent| contains the representation for periodical dates/times. |range| and |point| are repeated to accommodate the need when the date/time expression under one non-terminal is resolved to a list of correct values. For example, “Mondays in April, 2014” may have 4 correct dates. | list(NlpSemanticParsingDatetimeAbsoluteDateTime) | |
| properties | NlpSemanticParsingDatetimeDateTime | The top-level DATE/TIME representation. It can represent either (1) one or multiple Date/Time ranges, or (2) one or multiple of Date/Time points, or (3) a recurrent date/time expression. Next available ID: 12. Only one of |range|, |point| and |recurrent| will be set: |range| contains a list of resolved Date/Time ranges. |point| contains a list of resolved Date/Time points. |recurrent| contains the representation for periodical dates/times. |range| and |point| are repeated to accommodate the need when the date/time expression under one non-terminal is resolved to a list of correct values. For example, “Mondays in April, 2014” may have 4 correct dates. | NlpSemanticParsingDatetimeResolutionProperties | |
| range | Note that there is a difference between this scenario and an ambiguous date/time expression. The latter is resolved to multiple proto messages, not multiple values within one proto message. To be concrete, consider “Monday” in “Monday football”. It is ambiguous and can be reasonably resolved to “Monday last week,” “Monday this week” and “Monday next week.” The 3 values are represented as 3 separate DateTime messages, not 3 values within one DateTime message. | NlpSemanticParsingDatetimeDateTime | The top-level DATE/TIME representation. It can represent either (1) one or multiple Date/Time ranges, or (2) one or multiple of Date/Time points, or (3) a recurrent date/time expression. Next available ID: 12. Only one of |range|, |point| and |recurrent| will be set: |range| contains a list of resolved Date/Time ranges. |point| contains a list of resolved Date/Time points. |recurrent| contains the representation for periodical dates/times. |range| and |point| are repeated to accommodate the need when the date/time expression under one non-terminal is resolved to a list of correct values. For example, “Mondays in April, 2014” may have 4 correct dates. | list(NlpSemanticParsingDatetimeRange) |
| recurrent | NlpSemanticParsingDatetimeDateTime | The top-level DATE/TIME representation. It can represent either (1) one or multiple Date/Time ranges, or (2) one or multiple of Date/Time points, or (3) a recurrent date/time expression. Next available ID: 12. Only one of |range|, |point| and |recurrent| will be set: |range| contains a list of resolved Date/Time ranges. |point| contains a list of resolved Date/Time points. |recurrent| contains the representation for periodical dates/times. |range| and |point| are repeated to accommodate the need when the date/time expression under one non-terminal is resolved to a list of correct values. For example, “Mondays in April, 2014” may have 4 correct dates. | NlpSemanticParsingDatetimeRecurrent | |
| relative | NlpSemanticParsingDatetimeDateTime | The top-level DATE/TIME representation. It can represent either (1) one or multiple Date/Time ranges, or (2) one or multiple of Date/Time points, or (3) a recurrent date/time expression. Next available ID: 12. Only one of |range|, |point| and |recurrent| will be set: |range| contains a list of resolved Date/Time ranges. |point| contains a list of resolved Date/Time points. |recurrent| contains the representation for periodical dates/times. |range| and |point| are repeated to accommodate the need when the date/time expression under one non-terminal is resolved to a list of correct values. For example, “Mondays in April, 2014” may have 4 correct dates. | NlpSemanticParsingDatetimeRelativeDateTime | |
| span | See comments of Span. | NlpSemanticParsingDatetimeDateTime | The top-level DATE/TIME representation. It can represent either (1) one or multiple Date/Time ranges, or (2) one or multiple of Date/Time points, or (3) a recurrent date/time expression. Next available ID: 12. Only one of |range|, |point| and |recurrent| will be set: |range| contains a list of resolved Date/Time ranges. |point| contains a list of resolved Date/Time points. |recurrent| contains the representation for periodical dates/times. |range| and |point| are repeated to accommodate the need when the date/time expression under one non-terminal is resolved to a list of correct values. For example, “Mondays in April, 2014” may have 4 correct dates. | NlpSemanticParsingDatetimeSpan |
| dateFormat | NlpSemanticParsingDatetimeDateTimeProperty | DateTimeProperty contains various metadata about the DateTime interpretation. Next field: 13 | String | |
| expandYearToCurrent | NlpSemanticParsingDatetimeDateTimeProperty | DateTimeProperty contains various metadata about the DateTime interpretation. Next field: 13 | boolean | |
| hourStatus | NlpSemanticParsingDatetimeDateTimeProperty | DateTimeProperty contains various metadata about the DateTime interpretation. Next field: 13 | String | |
| inferredDateValue | NlpSemanticParsingDatetimeDateTimeProperty | DateTimeProperty contains various metadata about the DateTime interpretation. Next field: 13 | String | |
| metadata | Note: this may be changed to a repeated field in the future. | NlpSemanticParsingDatetimeDateTimeProperty | DateTimeProperty contains various metadata about the DateTime interpretation. Next field: 13 | String |
| personalReferenceMetadata | Metadata about the personal reference if the date was generated from a personal reference. | NlpSemanticParsingDatetimeDateTimeProperty | DateTimeProperty contains various metadata about the DateTime interpretation. Next field: 13 | CopleyPersonalReferenceMetadata |
| relationToReference | NlpSemanticParsingDatetimeDateTimeProperty | DateTimeProperty contains various metadata about the DateTime interpretation. Next field: 13 | String | |
| relative | Expresses the relative DateTime query that gave rise to these grounded semantics. | NlpSemanticParsingDatetimeDateTimeProperty | DateTimeProperty contains various metadata about the DateTime interpretation. Next field: 13 | NlpSemanticParsingDatetimeRelativeDateTime |
| sourceCalendar | NlpSemanticParsingDatetimeDateTimeProperty | DateTimeProperty contains various metadata about the DateTime interpretation. Next field: 13 | String | |
| sourceTypeList | If the annotation was created by using personal data, we record the provenance for that data here. | NlpSemanticParsingDatetimeDateTimeProperty | DateTimeProperty contains various metadata about the DateTime interpretation. Next field: 13 | CopleySourceTypeList |
| timeFormat | NlpSemanticParsingDatetimeDateTimeProperty | DateTimeProperty contains various metadata about the DateTime interpretation. Next field: 13 | list(String) | |
| timezoneIsExplicit | True iff the timezone value in AbsoluteDateTime is explicit in the annotated text or not. In the following examples the timezone is explicit: Query Timezone ————————– ——– 10pst Pacific Standard Time 10 utc UTC 10 sydney time Australia Eastern Time | NlpSemanticParsingDatetimeDateTimeProperty | DateTimeProperty contains various metadata about the DateTime interpretation. Next field: 13 | boolean |
| evalData | This field of the Duration message should not in general be used by outside clients of the grammar. It is intended to be used internally in Aqua for evaluation purposes. The rationale is that token counts depend on the particular tokenization used in Aqua which may be different from the one used by the client and may change from time to time. Outside clients should not create a dependency on the current tokenization used in Aqua. | NlpSemanticParsingDatetimeDuration | To represent unanchored durations – the length of a date/time expression not related to calendar in local context. E.g., “play first (DURATION: 5 minutes) of Yellow Submarine”, “it takes (DURATION: more than 3 days) to finish.” In contrast, queries like: “wake me up in 5 minutes” will be resolved to a AbsoluteDateTime since the query indicates that the reference is now. A duration can be turned into a range if either end is anchored. | NlpSemanticParsingAnnotationEvalData |
| modifier | For expressions such as “about 2 hrs”. | NlpSemanticParsingDatetimeDuration | To represent unanchored durations – the length of a date/time expression not related to calendar in local context. E.g., “play first (DURATION: 5 minutes) of Yellow Submarine”, “it takes (DURATION: more than 3 days) to finish.” In contrast, queries like: “wake me up in 5 minutes” will be resolved to a AbsoluteDateTime since the query indicates that the reference is now. A duration can be turned into a range if either end is anchored. | String |
| quantity | NlpSemanticParsingDatetimeDuration | To represent unanchored durations – the length of a date/time expression not related to calendar in local context. E.g., “play first (DURATION: 5 minutes) of Yellow Submarine”, “it takes (DURATION: more than 3 days) to finish.” In contrast, queries like: “wake me up in 5 minutes” will be resolved to a AbsoluteDateTime since the query indicates that the reference is now. A duration can be turned into a range if either end is anchored. | NlpSemanticParsingDatetimeQuantity | |
| span | See comments of Span. | NlpSemanticParsingDatetimeDuration | To represent unanchored durations – the length of a date/time expression not related to calendar in local context. E.g., “play first (DURATION: 5 minutes) of Yellow Submarine”, “it takes (DURATION: more than 3 days) to finish.” In contrast, queries like: “wake me up in 5 minutes” will be resolved to a AbsoluteDateTime since the query indicates that the reference is now. A duration can be turned into a range if either end is anchored. | NlpSemanticParsingDatetimeSpan |
| holiday | NlpSemanticParsingDatetimeEvent | This message is defined to be a representation of events that could interact with datetimes expressions through composition by shifting or fetching. For “native” datetime events like sunset, sunrise, etc the type is enough, but this should be extended as needed to represent richer event information. | String | |
| moonEvent | NlpSemanticParsingDatetimeEvent | This message is defined to be a representation of events that could interact with datetimes expressions through composition by shifting or fetching. For “native” datetime events like sunset, sunrise, etc the type is enough, but this should be extended as needed to represent richer event information. | NlpSemanticParsingDatetimeMoonEventInfo | |
| sunEvent | NlpSemanticParsingDatetimeEvent | This message is defined to be a representation of events that could interact with datetimes expressions through composition by shifting or fetching. For “native” datetime events like sunset, sunrise, etc the type is enough, but this should be extended as needed to represent richer event information. | String | |
| type | NlpSemanticParsingDatetimeEvent | This message is defined to be a representation of events that could interact with datetimes expressions through composition by shifting or fetching. For “native” datetime events like sunset, sunrise, etc the type is enough, but this should be extended as needed to represent richer event information. | String | |
| baseType | NlpSemanticParsingDatetimeFetchedRelativeDateTime | For a more detailed presentation on what’s a fetching operation, see go/datetime-meaning-schemas. Examples to illustrate how the proto is used: I. Fetching day-of-weeks: a) query: “1st 2 Mondays of April” proto: ordinal: 1 target {weekday: MONDAY} count: 2 range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} b) query: “1st and last Monday of April” proto: ordinal: 1 ordinal: -1 target {weekday: MONDAY} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} c) query: “next Monday” proto: ordinal: 1 target {weekday: MONDAY} d) query: “last 2 Mondays” proto: ordinal: -1 count: 2 target {weekday: MONDAY} e) query: “this Monday” proto: ordinal: 0 target {weekday: MONDAY} f) query: “the monday after next” proto: ordinal: 2 target {weekday: MONDAY} g) query: “third Monday in April” proto: ordinal: 3 target {weekday: MONDAY} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} h) query: “the monday before last” proto: ordinal: -2 target {weekday: MONDAY} i) query: “the second to the last monday in April” proto: ordinal: -2 target {weekday: MONDAY} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} II. Fetching date/time unit: a) query: “1st 2 weeks of April” proto: ordinal: 1 target {unit: WEEK} count: 2 range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} b) query: “1st and last week of April” proto: ordinal: 1 ordinal: -1 target {unit: WEEK} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} c) query: “next year” proto: ordinal: 1 target {unit: YEAR} d) query: “last 2 weeks” proto: ordinal: -1 count: 2 target {unit: WEEK} e) query: “this month” proto: ordinal: 0 target {unit: MONTH} f) query: “the week after next” proto: ordinal: 2 target {unit: WEEK} g) query: “third week in April” proto: ordinal: 3 target {unit: WEEK} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} h) query: “the week before last” proto: ordinal: -2 target {unit: WEEK} i) query: “the second to the last week in April” proto: ordinal: -2 target {unit: WEEK} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} Next field: 9 | String | |
| count | How many to fetch (e.g. [next weekend] vs. [next two weeks]) | NlpSemanticParsingDatetimeFetchedRelativeDateTime | For a more detailed presentation on what’s a fetching operation, see go/datetime-meaning-schemas. Examples to illustrate how the proto is used: I. Fetching day-of-weeks: a) query: “1st 2 Mondays of April” proto: ordinal: 1 target {weekday: MONDAY} count: 2 range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} b) query: “1st and last Monday of April” proto: ordinal: 1 ordinal: -1 target {weekday: MONDAY} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} c) query: “next Monday” proto: ordinal: 1 target {weekday: MONDAY} d) query: “last 2 Mondays” proto: ordinal: -1 count: 2 target {weekday: MONDAY} e) query: “this Monday” proto: ordinal: 0 target {weekday: MONDAY} f) query: “the monday after next” proto: ordinal: 2 target {weekday: MONDAY} g) query: “third Monday in April” proto: ordinal: 3 target {weekday: MONDAY} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} h) query: “the monday before last” proto: ordinal: -2 target {weekday: MONDAY} i) query: “the second to the last monday in April” proto: ordinal: -2 target {weekday: MONDAY} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} II. Fetching date/time unit: a) query: “1st 2 weeks of April” proto: ordinal: 1 target {unit: WEEK} count: 2 range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} b) query: “1st and last week of April” proto: ordinal: 1 ordinal: -1 target {unit: WEEK} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} c) query: “next year” proto: ordinal: 1 target {unit: YEAR} d) query: “last 2 weeks” proto: ordinal: -1 count: 2 target {unit: WEEK} e) query: “this month” proto: ordinal: 0 target {unit: MONTH} f) query: “the week after next” proto: ordinal: 2 target {unit: WEEK} g) query: “third week in April” proto: ordinal: 3 target {unit: WEEK} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} h) query: “the week before last” proto: ordinal: -2 target {unit: WEEK} i) query: “the second to the last week in April” proto: ordinal: -2 target {unit: WEEK} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} Next field: 9 | integer |
| metadata | Can be used to tag relative datetime expressions with metadata information in the grammar. | NlpSemanticParsingDatetimeFetchedRelativeDateTime | For a more detailed presentation on what’s a fetching operation, see go/datetime-meaning-schemas. Examples to illustrate how the proto is used: I. Fetching day-of-weeks: a) query: “1st 2 Mondays of April” proto: ordinal: 1 target {weekday: MONDAY} count: 2 range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} b) query: “1st and last Monday of April” proto: ordinal: 1 ordinal: -1 target {weekday: MONDAY} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} c) query: “next Monday” proto: ordinal: 1 target {weekday: MONDAY} d) query: “last 2 Mondays” proto: ordinal: -1 count: 2 target {weekday: MONDAY} e) query: “this Monday” proto: ordinal: 0 target {weekday: MONDAY} f) query: “the monday after next” proto: ordinal: 2 target {weekday: MONDAY} g) query: “third Monday in April” proto: ordinal: 3 target {weekday: MONDAY} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} h) query: “the monday before last” proto: ordinal: -2 target {weekday: MONDAY} i) query: “the second to the last monday in April” proto: ordinal: -2 target {weekday: MONDAY} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} II. Fetching date/time unit: a) query: “1st 2 weeks of April” proto: ordinal: 1 target {unit: WEEK} count: 2 range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} b) query: “1st and last week of April” proto: ordinal: 1 ordinal: -1 target {unit: WEEK} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} c) query: “next year” proto: ordinal: 1 target {unit: YEAR} d) query: “last 2 weeks” proto: ordinal: -1 count: 2 target {unit: WEEK} e) query: “this month” proto: ordinal: 0 target {unit: MONTH} f) query: “the week after next” proto: ordinal: 2 target {unit: WEEK} g) query: “third week in April” proto: ordinal: 3 target {unit: WEEK} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} h) query: “the week before last” proto: ordinal: -2 target {unit: WEEK} i) query: “the second to the last week in April” proto: ordinal: -2 target {unit: WEEK} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} Next field: 9 | String |
| ordinal | Encodes expressions like next (+1), last (-1), after next (+2), this (0). | NlpSemanticParsingDatetimeFetchedRelativeDateTime | For a more detailed presentation on what’s a fetching operation, see go/datetime-meaning-schemas. Examples to illustrate how the proto is used: I. Fetching day-of-weeks: a) query: “1st 2 Mondays of April” proto: ordinal: 1 target {weekday: MONDAY} count: 2 range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} b) query: “1st and last Monday of April” proto: ordinal: 1 ordinal: -1 target {weekday: MONDAY} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} c) query: “next Monday” proto: ordinal: 1 target {weekday: MONDAY} d) query: “last 2 Mondays” proto: ordinal: -1 count: 2 target {weekday: MONDAY} e) query: “this Monday” proto: ordinal: 0 target {weekday: MONDAY} f) query: “the monday after next” proto: ordinal: 2 target {weekday: MONDAY} g) query: “third Monday in April” proto: ordinal: 3 target {weekday: MONDAY} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} h) query: “the monday before last” proto: ordinal: -2 target {weekday: MONDAY} i) query: “the second to the last monday in April” proto: ordinal: -2 target {weekday: MONDAY} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} II. Fetching date/time unit: a) query: “1st 2 weeks of April” proto: ordinal: 1 target {unit: WEEK} count: 2 range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} b) query: “1st and last week of April” proto: ordinal: 1 ordinal: -1 target {unit: WEEK} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} c) query: “next year” proto: ordinal: 1 target {unit: YEAR} d) query: “last 2 weeks” proto: ordinal: -1 count: 2 target {unit: WEEK} e) query: “this month” proto: ordinal: 0 target {unit: MONTH} f) query: “the week after next” proto: ordinal: 2 target {unit: WEEK} g) query: “third week in April” proto: ordinal: 3 target {unit: WEEK} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} h) query: “the week before last” proto: ordinal: -2 target {unit: WEEK} i) query: “the second to the last week in April” proto: ordinal: -2 target {unit: WEEK} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} Next field: 9 | list(integer) |
| range | The restriction range on which fetching is operated, e.g., “April” in “first Tuesday in/of April.” If this field is missing, the operation is done relative to the base_type (or if not given, to the query’s reference datetime). When the fetching operation is performed relative to a reference time point, positive ordinal values represent upcoming instances from the reference point, negative ordinal values represent previous instances from the reference point. Similarly, ordinal=0 represents a reference to the “current instance”, which may vary depending on the target. E.g. “this week” is simply defined as the week range that contains the current reference time point, but “this ” can be ambiguous and its resolution will depend on language/locale conventions (“this monday” in some languages refers to the closest upcoming instance of Monday, while in other languages it represents the Monday instance within the current week). | NlpSemanticParsingDatetimeFetchedRelativeDateTime | For a more detailed presentation on what’s a fetching operation, see go/datetime-meaning-schemas. Examples to illustrate how the proto is used: I. Fetching day-of-weeks: a) query: “1st 2 Mondays of April” proto: ordinal: 1 target {weekday: MONDAY} count: 2 range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} b) query: “1st and last Monday of April” proto: ordinal: 1 ordinal: -1 target {weekday: MONDAY} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} c) query: “next Monday” proto: ordinal: 1 target {weekday: MONDAY} d) query: “last 2 Mondays” proto: ordinal: -1 count: 2 target {weekday: MONDAY} e) query: “this Monday” proto: ordinal: 0 target {weekday: MONDAY} f) query: “the monday after next” proto: ordinal: 2 target {weekday: MONDAY} g) query: “third Monday in April” proto: ordinal: 3 target {weekday: MONDAY} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} h) query: “the monday before last” proto: ordinal: -2 target {weekday: MONDAY} i) query: “the second to the last monday in April” proto: ordinal: -2 target {weekday: MONDAY} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} II. Fetching date/time unit: a) query: “1st 2 weeks of April” proto: ordinal: 1 target {unit: WEEK} count: 2 range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} b) query: “1st and last week of April” proto: ordinal: 1 ordinal: -1 target {unit: WEEK} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} c) query: “next year” proto: ordinal: 1 target {unit: YEAR} d) query: “last 2 weeks” proto: ordinal: -1 count: 2 target {unit: WEEK} e) query: “this month” proto: ordinal: 0 target {unit: MONTH} f) query: “the week after next” proto: ordinal: 2 target {unit: WEEK} g) query: “third week in April” proto: ordinal: 3 target {unit: WEEK} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} h) query: “the week before last” proto: ordinal: -2 target {unit: WEEK} i) query: “the second to the last week in April” proto: ordinal: -2 target {unit: WEEK} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} Next field: 9 | NlpSemanticParsingDatetimeRange |
| rangeModifier | Modifier that return the appropriate subrange. For more information, see the description of RangeOfDateTimeModifier. Example: * *early* next week * *late* next Monday | NlpSemanticParsingDatetimeFetchedRelativeDateTime | For a more detailed presentation on what’s a fetching operation, see go/datetime-meaning-schemas. Examples to illustrate how the proto is used: I. Fetching day-of-weeks: a) query: “1st 2 Mondays of April” proto: ordinal: 1 target {weekday: MONDAY} count: 2 range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} b) query: “1st and last Monday of April” proto: ordinal: 1 ordinal: -1 target {weekday: MONDAY} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} c) query: “next Monday” proto: ordinal: 1 target {weekday: MONDAY} d) query: “last 2 Mondays” proto: ordinal: -1 count: 2 target {weekday: MONDAY} e) query: “this Monday” proto: ordinal: 0 target {weekday: MONDAY} f) query: “the monday after next” proto: ordinal: 2 target {weekday: MONDAY} g) query: “third Monday in April” proto: ordinal: 3 target {weekday: MONDAY} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} h) query: “the monday before last” proto: ordinal: -2 target {weekday: MONDAY} i) query: “the second to the last monday in April” proto: ordinal: -2 target {weekday: MONDAY} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} II. Fetching date/time unit: a) query: “1st 2 weeks of April” proto: ordinal: 1 target {unit: WEEK} count: 2 range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} b) query: “1st and last week of April” proto: ordinal: 1 ordinal: -1 target {unit: WEEK} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} c) query: “next year” proto: ordinal: 1 target {unit: YEAR} d) query: “last 2 weeks” proto: ordinal: -1 count: 2 target {unit: WEEK} e) query: “this month” proto: ordinal: 0 target {unit: MONTH} f) query: “the week after next” proto: ordinal: 2 target {unit: WEEK} g) query: “third week in April” proto: ordinal: 3 target {unit: WEEK} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} h) query: “the week before last” proto: ordinal: -2 target {unit: WEEK} i) query: “the second to the last week in April” proto: ordinal: -2 target {unit: WEEK} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} Next field: 9 | String |
| relativeRange | If the underlying range comes from a relative datetime expression, encode the expression here instead. | NlpSemanticParsingDatetimeFetchedRelativeDateTime | For a more detailed presentation on what’s a fetching operation, see go/datetime-meaning-schemas. Examples to illustrate how the proto is used: I. Fetching day-of-weeks: a) query: “1st 2 Mondays of April” proto: ordinal: 1 target {weekday: MONDAY} count: 2 range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} b) query: “1st and last Monday of April” proto: ordinal: 1 ordinal: -1 target {weekday: MONDAY} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} c) query: “next Monday” proto: ordinal: 1 target {weekday: MONDAY} d) query: “last 2 Mondays” proto: ordinal: -1 count: 2 target {weekday: MONDAY} e) query: “this Monday” proto: ordinal: 0 target {weekday: MONDAY} f) query: “the monday after next” proto: ordinal: 2 target {weekday: MONDAY} g) query: “third Monday in April” proto: ordinal: 3 target {weekday: MONDAY} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} h) query: “the monday before last” proto: ordinal: -2 target {weekday: MONDAY} i) query: “the second to the last monday in April” proto: ordinal: -2 target {weekday: MONDAY} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} II. Fetching date/time unit: a) query: “1st 2 weeks of April” proto: ordinal: 1 target {unit: WEEK} count: 2 range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} b) query: “1st and last week of April” proto: ordinal: 1 ordinal: -1 target {unit: WEEK} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} c) query: “next year” proto: ordinal: 1 target {unit: YEAR} d) query: “last 2 weeks” proto: ordinal: -1 count: 2 target {unit: WEEK} e) query: “this month” proto: ordinal: 0 target {unit: MONTH} f) query: “the week after next” proto: ordinal: 2 target {unit: WEEK} g) query: “third week in April” proto: ordinal: 3 target {unit: WEEK} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} h) query: “the week before last” proto: ordinal: -2 target {unit: WEEK} i) query: “the second to the last week in April” proto: ordinal: -2 target {unit: WEEK} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} Next field: 9 | NlpSemanticParsingDatetimeResolutionProperties |
| target | The target to be fetched. This could be a named day-of-week or month (e.g., “Monday”, “April”), or a date/time unit (e.g., “day”, “week”, “month”). | NlpSemanticParsingDatetimeFetchedRelativeDateTime | For a more detailed presentation on what’s a fetching operation, see go/datetime-meaning-schemas. Examples to illustrate how the proto is used: I. Fetching day-of-weeks: a) query: “1st 2 Mondays of April” proto: ordinal: 1 target {weekday: MONDAY} count: 2 range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} b) query: “1st and last Monday of April” proto: ordinal: 1 ordinal: -1 target {weekday: MONDAY} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} c) query: “next Monday” proto: ordinal: 1 target {weekday: MONDAY} d) query: “last 2 Mondays” proto: ordinal: -1 count: 2 target {weekday: MONDAY} e) query: “this Monday” proto: ordinal: 0 target {weekday: MONDAY} f) query: “the monday after next” proto: ordinal: 2 target {weekday: MONDAY} g) query: “third Monday in April” proto: ordinal: 3 target {weekday: MONDAY} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} h) query: “the monday before last” proto: ordinal: -2 target {weekday: MONDAY} i) query: “the second to the last monday in April” proto: ordinal: -2 target {weekday: MONDAY} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} II. Fetching date/time unit: a) query: “1st 2 weeks of April” proto: ordinal: 1 target {unit: WEEK} count: 2 range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} b) query: “1st and last week of April” proto: ordinal: 1 ordinal: -1 target {unit: WEEK} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} c) query: “next year” proto: ordinal: 1 target {unit: YEAR} d) query: “last 2 weeks” proto: ordinal: -1 count: 2 target {unit: WEEK} e) query: “this month” proto: ordinal: 0 target {unit: MONTH} f) query: “the week after next” proto: ordinal: 2 target {unit: WEEK} g) query: “third week in April” proto: ordinal: 3 target {unit: WEEK} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} h) query: “the week before last” proto: ordinal: -2 target {unit: WEEK} i) query: “the second to the last week in April” proto: ordinal: -2 target {unit: WEEK} range: {begin {year: RESOLVED_YEAR month: APRIL day: 1} {end {year: RESOLVED_YEAR month: APRIL day: 30} Next field: 9 | NlpSemanticParsingDatetimeTargetToFetch |
| nonFixed | There are 3 types of holidays supported by the datetime subgrammar: 1) NonFixedHolidayEnum: e.g., “easter”, “chinese new year”. 2) FetchedRelativeDateTime: e.g., “Thanksgiving” => [4th Thursday of November] 3) HolidayByMonthDay: e.g., “xmas” => [December 25] Each holiday of the first type is resolved by a C++ function; the 2nd and 3rd type of holidays are mapped to AbsoluteDateTime and FetchedRelativeDateTime, respectively, in grammar and are not needed to be represented in proto. | NlpSemanticParsingDatetimeHoliday | List of holidays that are not fixed absolute or relative dates on the Gregorian calendar. | String |
| phase | NlpSemanticParsingDatetimeMoonEventInfo | String | ||
| type | NlpSemanticParsingDatetimeMoonEventInfo | String | ||
| chineseMonth | NlpSemanticParsingDatetimeNonGregorianDate | Non-Gregorian dates are similar to AbsoluteDateTime, but use non-Gregorian calendars. | String | |
| day | The day is the offset within the month, same as in Gregorian calendars. | NlpSemanticParsingDatetimeNonGregorianDate | Non-Gregorian dates are similar to AbsoluteDateTime, but use non-Gregorian calendars. | integer |
| hebrewMonth | NlpSemanticParsingDatetimeNonGregorianDate | Non-Gregorian dates are similar to AbsoluteDateTime, but use non-Gregorian calendars. | String | |
| islamicMonth | NlpSemanticParsingDatetimeNonGregorianDate | Non-Gregorian dates are similar to AbsoluteDateTime, but use non-Gregorian calendars. | String | |
| year | The year is relative to the calendar (e.g. 5777 for Hebrew calendar). | NlpSemanticParsingDatetimeNonGregorianDate | Non-Gregorian dates are similar to AbsoluteDateTime, but use non-Gregorian calendars. | integer |
| modifier | For internal use – DateTime subgrammar users should look at Duration.modifier. = MORE in [3 more days]. | NlpSemanticParsingDatetimeQuantity | String | |
| number | !ERROR! B7821 -> Formula Error: An unexpected error occurred | NlpSemanticParsingDatetimeQuantity | float | |
| numberSpan | This field keeps the span info of the number element in a quantity expression, which is useful for downstream components to obtain the number annotations inside a quantity when necessary. | NlpSemanticParsingDatetimeQuantity | NlpSemanticParsingAnnotationEvalData | |
| symbolicQuantity | Quantities are typically converted into milliseconds, regardless of the units the user used. Sometimes this loses crucial information, e.g., “5 days” vs “5 nights”. When quantities are converted to milliseconds, ‘symbolic_quantity’ will contain the sequence of units that the user actually supplied. This can be more than one element in cases like “one minute and 30 seconds”. In cases where ‘symbolic_quantity’ has more than one element, THERE IS NO GUARANTEED ORDER between elements. | NlpSemanticParsingDatetimeQuantity | list(NlpSemanticParsingDatetimeQuantity) | |
| unit | !ERROR! B7824 -> Formula Error: An unexpected error occurred | NlpSemanticParsingDatetimeQuantity | String | |
| begin | Deprecated fields. Do NOT use. | NlpSemanticParsingDatetimeRange | Range has 4 use cases: 1. with an explicit begin and an explicit end, e.g. “from Monday to Wednesday.” Both |begin| and |end| are filled in this case. 2. a point date/time expression is used as a range at a finer granularity. E.g., in “first Monday of this month”, “this month” is used as a range. In this case, only |begin| will be filled and the |end| will be filled during the grounding process. 3. a fuzzy date/time range such as “morning” or “evening.” 4. with a relative begin and a relative end, e.g. “from yesterday to next Monday.” Note: this may be used in a mixture of exact/relative begin and end. Next available ID: 14. | NlpSemanticParsingDatetimeAbsoluteDateTime |
| beginRelative | NlpSemanticParsingDatetimeRange | Range has 4 use cases: 1. with an explicit begin and an explicit end, e.g. “from Monday to Wednesday.” Both |begin| and |end| are filled in this case. 2. a point date/time expression is used as a range at a finer granularity. E.g., in “first Monday of this month”, “this month” is used as a range. In this case, only |begin| will be filled and the |end| will be filled during the grounding process. 3. a fuzzy date/time range such as “morning” or “evening.” 4. with a relative begin and a relative end, e.g. “from yesterday to next Monday.” Note: this may be used in a mixture of exact/relative begin and end. Next available ID: 14. | NlpSemanticParsingDatetimeRelativeDateTime | |
| duration | if |duration| is set, one field from start or finish must be populated, but not both. |exclusive| value is still relevant to decide if the endpoints of the range are included in the range (value defined in the start/finish fields as well as the datetime value resulting of offseting the duration over the given range endpoint). | NlpSemanticParsingDatetimeRange | Range has 4 use cases: 1. with an explicit begin and an explicit end, e.g. “from Monday to Wednesday.” Both |begin| and |end| are filled in this case. 2. a point date/time expression is used as a range at a finer granularity. E.g., in “first Monday of this month”, “this month” is used as a range. In this case, only |begin| will be filled and the |end| will be filled during the grounding process. 3. a fuzzy date/time range such as “morning” or “evening.” 4. with a relative begin and a relative end, e.g. “from yesterday to next Monday.” Note: this may be used in a mixture of exact/relative begin and end. Next available ID: 14. | NlpSemanticParsingDatetimeQuantity |
| end | NlpSemanticParsingDatetimeRange | Range has 4 use cases: 1. with an explicit begin and an explicit end, e.g. “from Monday to Wednesday.” Both |begin| and |end| are filled in this case. 2. a point date/time expression is used as a range at a finer granularity. E.g., in “first Monday of this month”, “this month” is used as a range. In this case, only |begin| will be filled and the |end| will be filled during the grounding process. 3. a fuzzy date/time range such as “morning” or “evening.” 4. with a relative begin and a relative end, e.g. “from yesterday to next Monday.” Note: this may be used in a mixture of exact/relative begin and end. Next available ID: 14. | NlpSemanticParsingDatetimeAbsoluteDateTime | |
| endRelative | NlpSemanticParsingDatetimeRange | Range has 4 use cases: 1. with an explicit begin and an explicit end, e.g. “from Monday to Wednesday.” Both |begin| and |end| are filled in this case. 2. a point date/time expression is used as a range at a finer granularity. E.g., in “first Monday of this month”, “this month” is used as a range. In this case, only |begin| will be filled and the |end| will be filled during the grounding process. 3. a fuzzy date/time range such as “morning” or “evening.” 4. with a relative begin and a relative end, e.g. “from yesterday to next Monday.” Note: this may be used in a mixture of exact/relative begin and end. Next available ID: 14. | NlpSemanticParsingDatetimeRelativeDateTime | |
| exclusive | NlpSemanticParsingDatetimeRange | Range has 4 use cases: 1. with an explicit begin and an explicit end, e.g. “from Monday to Wednesday.” Both |begin| and |end| are filled in this case. 2. a point date/time expression is used as a range at a finer granularity. E.g., in “first Monday of this month”, “this month” is used as a range. In this case, only |begin| will be filled and the |end| will be filled during the grounding process. 3. a fuzzy date/time range such as “morning” or “evening.” 4. with a relative begin and a relative end, e.g. “from yesterday to next Monday.” Note: this may be used in a mixture of exact/relative begin and end. Next available ID: 14. | boolean | |
| finish | NlpSemanticParsingDatetimeRange | Range has 4 use cases: 1. with an explicit begin and an explicit end, e.g. “from Monday to Wednesday.” Both |begin| and |end| are filled in this case. 2. a point date/time expression is used as a range at a finer granularity. E.g., in “first Monday of this month”, “this month” is used as a range. In this case, only |begin| will be filled and the |end| will be filled during the grounding process. 3. a fuzzy date/time range such as “morning” or “evening.” 4. with a relative begin and a relative end, e.g. “from yesterday to next Monday.” Note: this may be used in a mixture of exact/relative begin and end. Next available ID: 14. | NlpSemanticParsingDatetimeDateTime | |
| fuzzyRange | NlpSemanticParsingDatetimeRange | Range has 4 use cases: 1. with an explicit begin and an explicit end, e.g. “from Monday to Wednesday.” Both |begin| and |end| are filled in this case. 2. a point date/time expression is used as a range at a finer granularity. E.g., in “first Monday of this month”, “this month” is used as a range. In this case, only |begin| will be filled and the |end| will be filled during the grounding process. 3. a fuzzy date/time range such as “morning” or “evening.” 4. with a relative begin and a relative end, e.g. “from yesterday to next Monday.” Note: this may be used in a mixture of exact/relative begin and end. Next available ID: 14. | String | |
| metadata | NlpSemanticParsingDatetimeRange | Range has 4 use cases: 1. with an explicit begin and an explicit end, e.g. “from Monday to Wednesday.” Both |begin| and |end| are filled in this case. 2. a point date/time expression is used as a range at a finer granularity. E.g., in “first Monday of this month”, “this month” is used as a range. In this case, only |begin| will be filled and the |end| will be filled during the grounding process. 3. a fuzzy date/time range such as “morning” or “evening.” 4. with a relative begin and a relative end, e.g. “from yesterday to next Monday.” Note: this may be used in a mixture of exact/relative begin and end. Next available ID: 14. | String | |
| properties | NlpSemanticParsingDatetimeRange | Range has 4 use cases: 1. with an explicit begin and an explicit end, e.g. “from Monday to Wednesday.” Both |begin| and |end| are filled in this case. 2. a point date/time expression is used as a range at a finer granularity. E.g., in “first Monday of this month”, “this month” is used as a range. In this case, only |begin| will be filled and the |end| will be filled during the grounding process. 3. a fuzzy date/time range such as “morning” or “evening.” 4. with a relative begin and a relative end, e.g. “from yesterday to next Monday.” Note: this may be used in a mixture of exact/relative begin and end. Next available ID: 14. | NlpSemanticParsingDatetimeResolutionProperties | |
| rangeModifier | Modifier that return the appropriate subrange. For more information, see the description of RangeOfDateTimeModifier. Example: * *late* morning | NlpSemanticParsingDatetimeRange | Range has 4 use cases: 1. with an explicit begin and an explicit end, e.g. “from Monday to Wednesday.” Both |begin| and |end| are filled in this case. 2. a point date/time expression is used as a range at a finer granularity. E.g., in “first Monday of this month”, “this month” is used as a range. In this case, only |begin| will be filled and the |end| will be filled during the grounding process. 3. a fuzzy date/time range such as “morning” or “evening.” 4. with a relative begin and a relative end, e.g. “from yesterday to next Monday.” Note: this may be used in a mixture of exact/relative begin and end. Next available ID: 14. | String |
| start | |start| and |finish| are inclusive unless exclusive field is true. the values in start and finish can be an absolute point, a relative or another range. Recurrences and repeated values are not expected/allowed. | NlpSemanticParsingDatetimeRange | Range has 4 use cases: 1. with an explicit begin and an explicit end, e.g. “from Monday to Wednesday.” Both |begin| and |end| are filled in this case. 2. a point date/time expression is used as a range at a finer granularity. E.g., in “first Monday of this month”, “this month” is used as a range. In this case, only |begin| will be filled and the |end| will be filled during the grounding process. 3. a fuzzy date/time range such as “morning” or “evening.” 4. with a relative begin and a relative end, e.g. “from yesterday to next Monday.” Note: this may be used in a mixture of exact/relative begin and end. Next available ID: 14. | NlpSemanticParsingDatetimeDateTime |
| symbolicValue | The field is set if the range is the result of resolving/grounding a relative datetime expression referring to a part of the day. E.g. “morning”, “afternoon”, “evening”, “night”, “tonight”, etc. | NlpSemanticParsingDatetimeRange | Range has 4 use cases: 1. with an explicit begin and an explicit end, e.g. “from Monday to Wednesday.” Both |begin| and |end| are filled in this case. 2. a point date/time expression is used as a range at a finer granularity. E.g., in “first Monday of this month”, “this month” is used as a range. In this case, only |begin| will be filled and the |end| will be filled during the grounding process. 3. a fuzzy date/time range such as “morning” or “evening.” 4. with a relative begin and a relative end, e.g. “from yesterday to next Monday.” Note: this may be used in a mixture of exact/relative begin and end. Next available ID: 14. | String |
| countRestriction | How many times it repeats. | NlpSemanticParsingDatetimeRecurrent | expressions: “every Monday after December 1” “every morning starting from this Friday”. Note: if a recurrent DATE/TIME expression is bounded (limited by a finite interval or a finite count), e.g., “every monday in the next 3 months”, “… at 11:00am every Monday for 4 times” the grammar will resolve it to a finite number of |range|s. Next available ID: 17. | integer |
| exception | An arbitrary exception to the recurrence. This can be an absolute point, a relative, a range or a recurrent expression. Examples: * “every Tuesday except for July 13th 2021” * “every Tuesday except for July 13th and November 2nd” * “every second Monday except during the summer” * “everyday except Thursdays” * “every Friday, except from October 1st to October 22nd” | NlpSemanticParsingDatetimeRecurrent | expressions: “every Monday after December 1” “every morning starting from this Friday”. Note: if a recurrent DATE/TIME expression is bounded (limited by a finite interval or a finite count), e.g., “every monday in the next 3 months”, “… at 11:00am every Monday for 4 times” the grammar will resolve it to a finite number of |range|s. Next available ID: 17. | list(NlpSemanticParsingDatetimeDateTime) |
| frequency | |frequency| is used to represent the frequency of the recurrence over a given recurrent period. E.g. “twice a week”, “once a month”. An unknown frequency is represented with 0, as in just “repeating”. | NlpSemanticParsingDatetimeRecurrent | expressions: “every Monday after December 1” “every morning starting from this Friday”. Note: if a recurrent DATE/TIME expression is bounded (limited by a finite interval or a finite count), e.g., “every monday in the next 3 months”, “… at 11:00am every Monday for 4 times” the grammar will resolve it to a finite number of |range|s. Next available ID: 17. | integer |
| metadata | NlpSemanticParsingDatetimeRecurrent | expressions: “every Monday after December 1” “every morning starting from this Friday”. Note: if a recurrent DATE/TIME expression is bounded (limited by a finite interval or a finite count), e.g., “every monday in the next 3 months”, “… at 11:00am every Monday for 4 times” the grammar will resolve it to a finite number of |range|s. Next available ID: 17. | String | |
| period | |period| and |unit| specify how often |start_point| or |start_range| repeats. |period| should not be 0. | NlpSemanticParsingDatetimeRecurrent | expressions: “every Monday after December 1” “every morning starting from this Friday”. Note: if a recurrent DATE/TIME expression is bounded (limited by a finite interval or a finite count), e.g., “every monday in the next 3 months”, “… at 11:00am every Monday for 4 times” the grammar will resolve it to a finite number of |range|s. Next available ID: 17. | integer |
| rangeRestriction | NlpSemanticParsingDatetimeRecurrent | expressions: “every Monday after December 1” “every morning starting from this Friday”. Note: if a recurrent DATE/TIME expression is bounded (limited by a finite interval or a finite count), e.g., “every monday in the next 3 months”, “… at 11:00am every Monday for 4 times” the grammar will resolve it to a finite number of |range|s. Next available ID: 17. | NlpSemanticParsingDatetimeRange | |
| relativeRangeRestriction | NlpSemanticParsingDatetimeRecurrent | expressions: “every Monday after December 1” “every morning starting from this Friday”. Note: if a recurrent DATE/TIME expression is bounded (limited by a finite interval or a finite count), e.g., “every monday in the next 3 months”, “… at 11:00am every Monday for 4 times” the grammar will resolve it to a finite number of |range|s. Next available ID: 17. | NlpSemanticParsingDatetimeRelativeDateTime | |
| restriction | A recurrent expression can be restricted by either a datetime |restriction| or |count_restriction| below. The restriction datetime can be expressed as an explicit range a relative datetime expression, a datetime point or a recurrent datetime. E.g. “every monday [next month]”, “every second tuesday [this year]”, etc. If |period| is > 0 and |restriction| is not set, repeat indefinitely. Note that this can support recurrent expressions as |restriction| as well. For example in the expression “every monday on [every other month]” where [every other month] is a restriction expressed as a recurrent datetime. | NlpSemanticParsingDatetimeRecurrent | expressions: “every Monday after December 1” “every morning starting from this Friday”. Note: if a recurrent DATE/TIME expression is bounded (limited by a finite interval or a finite count), e.g., “every monday in the next 3 months”, “… at 11:00am every Monday for 4 times” the grammar will resolve it to a finite number of |range|s. Next available ID: 17. | NlpSemanticParsingDatetimeDateTime |
| start | |start| is used to represent the starting points, ranges or relative datetims in a recurrent expression, for example: “every morning”, (range) “everyday at 5 pm”, (point) “every second monday” (relative) |start| should never contain a recurrent element. | NlpSemanticParsingDatetimeRecurrent | expressions: “every Monday after December 1” “every morning starting from this Friday”. Note: if a recurrent DATE/TIME expression is bounded (limited by a finite interval or a finite count), e.g., “every monday in the next 3 months”, “… at 11:00am every Monday for 4 times” the grammar will resolve it to a finite number of |range|s. Next available ID: 17. | list(NlpSemanticParsingDatetimeDateTime) |
| startPoint | DO NOT USE: deprecated fields soon to be removed. | NlpSemanticParsingDatetimeRecurrent | expressions: “every Monday after December 1” “every morning starting from this Friday”. Note: if a recurrent DATE/TIME expression is bounded (limited by a finite interval or a finite count), e.g., “every monday in the next 3 months”, “… at 11:00am every Monday for 4 times” the grammar will resolve it to a finite number of |range|s. Next available ID: 17. | list(NlpSemanticParsingDatetimeAbsoluteDateTime) |
| startRange | NlpSemanticParsingDatetimeRecurrent | expressions: “every Monday after December 1” “every morning starting from this Friday”. Note: if a recurrent DATE/TIME expression is bounded (limited by a finite interval or a finite count), e.g., “every monday in the next 3 months”, “… at 11:00am every Monday for 4 times” the grammar will resolve it to a finite number of |range|s. Next available ID: 17. | list(NlpSemanticParsingDatetimeRange) | |
| startRelative | NlpSemanticParsingDatetimeRecurrent | expressions: “every Monday after December 1” “every morning starting from this Friday”. Note: if a recurrent DATE/TIME expression is bounded (limited by a finite interval or a finite count), e.g., “every monday in the next 3 months”, “… at 11:00am every Monday for 4 times” the grammar will resolve it to a finite number of |range|s. Next available ID: 17. | list(NlpSemanticParsingDatetimeRelativeDateTime) | |
| target | The target to be fetched. This could be a named day-of-week or month (e.g., “Monday”, “April”), or a date/time unit (e.g., “day”, “week”, “month”). | NlpSemanticParsingDatetimeRecurrent | expressions: “every Monday after December 1” “every morning starting from this Friday”. Note: if a recurrent DATE/TIME expression is bounded (limited by a finite interval or a finite count), e.g., “every monday in the next 3 months”, “… at 11:00am every Monday for 4 times” the grammar will resolve it to a finite number of |range|s. Next available ID: 17. | NlpSemanticParsingDatetimeTargetToFetch |
| timeInterval | |time_interval| is a time amount or duration, used to described the time interval between the instances of the recurrence. (e.g. “every 3 hours”, “every 35 minutes”, “every 2 months and 15 days”, etc) | NlpSemanticParsingDatetimeRecurrent | expressions: “every Monday after December 1” “every morning starting from this Friday”. Note: if a recurrent DATE/TIME expression is bounded (limited by a finite interval or a finite count), e.g., “every monday in the next 3 months”, “… at 11:00am every Monday for 4 times” the grammar will resolve it to a finite number of |range|s. Next available ID: 17. | NlpSemanticParsingDatetimeQuantity |
| unit | NlpSemanticParsingDatetimeRecurrent | expressions: “every Monday after December 1” “every morning starting from this Friday”. Note: if a recurrent DATE/TIME expression is bounded (limited by a finite interval or a finite count), e.g., “every monday in the next 3 months”, “… at 11:00am every Monday for 4 times” the grammar will resolve it to a finite number of |range|s. Next available ID: 17. | String | |
| fetched | NlpSemanticParsingDatetimeRelativeDateTime | This provides a semi-abstract description for relative datetime expressions. – ShiftedRelativeDateTime encodes datetimes that arise from before/after expressions (e.g. [three days ago], [2 days after March 1st]). – FetchedRelativeDateTime encodes expressions that are retrieval-type statements (e.g. [next weekend], [the last two Mondays]). Next field: 5 | NlpSemanticParsingDatetimeFetchedRelativeDateTime | |
| metadata | NlpSemanticParsingDatetimeRelativeDateTime | This provides a semi-abstract description for relative datetime expressions. – ShiftedRelativeDateTime encodes datetimes that arise from before/after expressions (e.g. [three days ago], [2 days after March 1st]). – FetchedRelativeDateTime encodes expressions that are retrieval-type statements (e.g. [next weekend], [the last two Mondays]). Next field: 5 | String | |
| modifier | When a relative datetime which resolves into a range is being used as the endpoint of a range (begin_relative/end_relative), its begin/end will be taken accordingly unless this modifier indicates the opposite: begin_relative with relative range and modifier == AFTER means that its end will be taken as the beginning of the resulting range. Similarly, end_relative with a relative range and modifier == BEFORE means that its begin will be taken as the end of the resulting range. E.g. “after next month” will be a range with a begin_relative that will take the end of “next month” as its starting point (exclusive). values other than AFTER and BEFORE in the specific conditions explained here will be ignored and have no effect in the resolution of RelativeDateTimes. | NlpSemanticParsingDatetimeRelativeDateTime | This provides a semi-abstract description for relative datetime expressions. – ShiftedRelativeDateTime encodes datetimes that arise from before/after expressions (e.g. [three days ago], [2 days after March 1st]). – FetchedRelativeDateTime encodes expressions that are retrieval-type statements (e.g. [next weekend], [the last two Mondays]). Next field: 5 | String |
| shifted | NlpSemanticParsingDatetimeRelativeDateTime | This provides a semi-abstract description for relative datetime expressions. – ShiftedRelativeDateTime encodes datetimes that arise from before/after expressions (e.g. [three days ago], [2 days after March 1st]). – FetchedRelativeDateTime encodes expressions that are retrieval-type statements (e.g. [next weekend], [the last two Mondays]). Next field: 5 | NlpSemanticParsingDatetimeShiftedRelativeDateTime | |
| meridiem | Simple enum container for exporting meridiem mentions. Note: this is marked as deprecated as we are moving to properly parse expressions with explicit meridiem information. | NlpSemanticParsingDatetimeResolutionProperties | Encapsulates metadata about the query span resolved here. | String |
| metadata | Encodes whether the datetime was phrased in a specific way, see enum above. | NlpSemanticParsingDatetimeResolutionProperties | Encapsulates metadata about the query span resolved here. | String |
| relative | Expresses the relative DateTime query that gave rise to these grounded semantics. | NlpSemanticParsingDatetimeResolutionProperties | Encapsulates metadata about the query span resolved here. | NlpSemanticParsingDatetimeRelativeDateTime |
| base | The base could be an absolute datetime point for example: “March 1”, a relative datetime point, for example: “2 days before March 1” or a symbolic base type, for example: CURRENT_DATETIME. This could also be used to combine EXPLICIT_PRONOUN with the actual value of that reference being setup as a datetime point in base or relative_base | NlpSemanticParsingDatetimeShiftedRelativeDateTime | NlpSemanticParsingDatetimeAbsoluteDateTime | |
| baseType | NlpSemanticParsingDatetimeShiftedRelativeDateTime | String | ||
| metadata | Can be used to tag relative datetime expressions with metadata information in the grammar. | NlpSemanticParsingDatetimeShiftedRelativeDateTime | String | |
| relativeBase | NlpSemanticParsingDatetimeShiftedRelativeDateTime | NlpSemanticParsingDatetimeResolutionProperties | ||
| shiftAmount | NlpSemanticParsingDatetimeShiftedRelativeDateTime | NlpSemanticParsingDatetimeQuantity | ||
| shiftPast | If true, shifting to the past; if false, shifting to the future. | NlpSemanticParsingDatetimeShiftedRelativeDateTime | boolean | |
| numBytes | NlpSemanticParsingDatetimeSpan | The byte offset and text of a span. | integer | |
| startByte | 0-based start byte offset of the span. | NlpSemanticParsingDatetimeSpan | The byte offset and text of a span. | integer |
| text | The text of the span: a substring of ParserInput’s canonical_input. | NlpSemanticParsingDatetimeSpan | The byte offset and text of a span. | String |
| event | NlpSemanticParsingDatetimeTargetToFetch | Next field: 9 | NlpSemanticParsingDatetimeEvent | |
| fuzzyRange | NlpSemanticParsingDatetimeTargetToFetch | Next field: 9 | String | |
| month | NlpSemanticParsingDatetimeTargetToFetch | Next field: 9 | String | |
| quarter | NlpSemanticParsingDatetimeTargetToFetch | Next field: 9 | String | |
| reference | NlpSemanticParsingDatetimeTargetToFetch | Next field: 9 | String | |
| season | NlpSemanticParsingDatetimeTargetToFetch | Next field: 9 | String | |
| unit | Unnamed target: “week”, “month” etc. E.g., “1st week of April”. | NlpSemanticParsingDatetimeTargetToFetch | Next field: 9 | String |
| weekday | Named target: only one of the following is expected. | NlpSemanticParsingDatetimeTargetToFetch | Next field: 9 | list(String) |
| timezone | NlpSemanticParsingDatetimeTimeZone | String | ||
| entitySources | Indicates backends from which parts of an entity were retrieved. | NlpSemanticParsingEntitySourceData | list(String) | |
| status | NlpSemanticParsingExpressionStatus | Status indicating whether the user has finished expressing their intended semantics during a streaming interaction. Semantics are partially expressed when later, unprompted user input is expected to modify the semantics. Future inputs are typically additional speech or continued modification of argument text in form field. These inputs can trigger modifications including adding arguments, changing the intent, or modifying existing arguments. Sensing this status can be done both directly and indirectly. Fluid Actions directly detects this status as the user moves between, or enters and leaves, argument form fields. Understanding indirectly detects this status by the pace of the user’s speech, the semantics of the language, and the user’s intonation. See go/streaming-nlu-fulfilment-protocol-v1 for details about how it is used in the Streaming NLU Fulfillment protocol. | String | |
| textCompletenessProbability | Completeness probability as calculated by the parser’s completeness layer. | NlpSemanticParsingExpressionStatus | Status indicating whether the user has finished expressing their intended semantics during a streaming interaction. Semantics are partially expressed when later, unprompted user input is expected to modify the semantics. Future inputs are typically additional speech or continued modification of argument text in form field. These inputs can trigger modifications including adding arguments, changing the intent, or modifying existing arguments. Sensing this status can be done both directly and indirectly. Fluid Actions directly detects this status as the user moves between, or enters and leaves, argument form fields. Understanding indirectly detects this status by the pace of the user’s speech, the semantics of the language, and the user’s intonation. See go/streaming-nlu-fulfilment-protocol-v1 for details about how it is used in the Streaming NLU Fulfillment protocol. | number |
| type | Applied amenity constraints. Nothing should be inferred about the ordering of the values in this field. | NlpSemanticParsingLocalAmenities | A list of amenity constraints. There is an implicit AND relationship between the different constraints. | list(String) |
| element | NlpSemanticParsingLocalBasicLocation | Conceptually this describes one location. Technically, this is a sequence of location elements with the intention that at least one element in the sequence is an actual location (rather than a modifier). | list(NlpSemanticParsingLocalLocationElement) | |
| bank | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| hardwareStore | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| hotel | Also youth hostels, guest houses, etc. | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean |
| busStop | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| telecom | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| vehicleType | All of the vehicle types serviced by this business or business category. e.g. VEHICLE_TYPE_RAIL and VEHICLE_TYPE__BUS for “transit stop”. This allows downstream to serve different result types for transit station categories in different languages. e.g. In en-US “train station” seeks both railway station and subway station results. But the equivalent word in French/Italian/German seeks only railway stations. | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | list(String) |
| venue | Stadiums, theaters, cinemas, etc. | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean |
| hospital | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| hairdresser | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| transitOperator | Operator of a transit line, e.g., “MTA”, “BART”, “CTA”, etc. | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean |
| transitLine | A particular line in a transit system, e.g., “3 train”, “Red Line”, “Cirle Line”, etc. | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean |
| university | Also colleges | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean |
| subwayStation | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| trainStation | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| cuisineGcid | If the element implies a cuisine type then we include the gcid string when available. Currently this happens for BUSINESS_CATEGORY type. The field is repeated to model categories like “mandarin buffet restaurant” with multiple cuisine gcid’s: mandarin_restaurant and buffet_restaurant. | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | list(String) |
| soupKitchen | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| shoppingCenter | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| toyStore | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| parking | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| drugDropOff | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| sportStore | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| petStore | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| emergency | This field is used to determine the emergency type of the element, which is specified by the grammar parse in (http://cs/file:googledata/localsearch/quality/grammar/local_patterns.asciipb). e.g. “coronavirus_treatment_locations” TODO(b/151330576) Deprecate the emergency field and replace with normal triggering. | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | String |
| restaurant | Also bars and cafes | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean |
| transitStation | The different types of transit station business types will be used to figure out which vehicle types to use when querying Tripfinder’s SearchStations service. The stations in that backend seem to be divided into HEAVY_RAIL, SUBWAY, and TRAM. There isn’t a very reliable division between intercity rail and commuter rail — Amtrak, LIRR, PATH, and NJ Transit are all classified as HEAVY_RAIL. That’s why in these types we make a distinction between train and subway, and not train and muni_rail, (unlike TransitMode in the TravelAction proto). | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean |
| electricVehicleChargingStation | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| groceryStore | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| departmentStore | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| gasStation | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| electronicStore | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| airport | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| airline | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| clothingStore | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| qrefTransitStation | This is used for transit stations annotated by QRef. The transit_station business_type above is only used for business categories, and therefore is used downstream to find nearby stations rather than a particular station, and so cannot be present in a Location that is a specific station from QRef. For these cases, this business_type is used instead. e.g. “grand central” “millbrae station” “union station” will have business_type qref_transit_station | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean |
| foodPantry | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| school | Pre-k to high school | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean |
| pharmacy | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| retail | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| bikeSharingStation | NlpSemanticParsingLocalBusinessType | A high-level categorization of business types. Used for location elements that are either BUSINESS_NAME or BUSINESS_CATEGORY. The business types roughly correspond to QRef collections and should be interpreted broadly. E.g., hotel also include motels, youth hostels, and guest houses; restaurants includes bars and cafes, etc. Business types can be populated by QRef collections; other population is done by grammar categories from local_categories.grammar. It is expected that some business organizations will match more than one business type. E.g., Safeway is both a grocery store and a pharmacy. Next ID: 43 NOTE(oksana): LocalCategoryReliable grammar over-rides a few business type queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange | boolean | |
| chainIds | Specifies which parent chain mids to filter by. | NlpSemanticParsingLocalChainMemberConstraint | ChainMemberConstraint for chain filtering enabled queries. | list(String) |
| joiner | NlpSemanticParsingLocalCompoundLocation | NlpSemanticParsingLocalJoiner | ||
| location1 | NlpSemanticParsingLocalCompoundLocation | NlpSemanticParsingLocalLocation | ||
| location2 | If location_2 is absent, it should likely be interpreted as an implicit “here”. For example, “nearest Starbucks” will be represented as a compound location with “Starbucks” as location_1, “nearest” as the joiner, and empty location_2. | NlpSemanticParsingLocalCompoundLocation | NlpSemanticParsingLocalLocation | |
| contact | Contact as a location. | NlpSemanticParsingLocalContactLocation | Contact information for the |contact_location| field in LocationElement. | NlpSemanticParsingModelsCommunicationRecipient |
| contactType | The type of contact address (home, work, etc). | NlpSemanticParsingLocalContactLocation | Contact information for the |contact_location| field in LocationElement. | NlpSemanticParsingModelsCommunicationPhoneType |
| cuisineGcid | NlpSemanticParsingLocalCuisineConstraint | Constraint for cuisine type, such as “chinese”, “italian”, “thai”, “burgers”, etc. | String | |
| connectorType | NlpSemanticParsingLocalEvChargingStationConnectorConstraint | String | ||
| paymentNetworkMid | NlpSemanticParsingLocalEvChargingStationPaymentConstraint | String | ||
| chargingSpeed | NlpSemanticParsingLocalEvChargingStationSpeedConstraint | There is an implicit AND relation if multiple EVCS constraint types are specified. | String | |
| nonSpecificValue | True for values like “a few”. | NlpSemanticParsingLocalExtent | boolean | |
| units | NlpSemanticParsingLocalExtent | String | ||
| unitsString | String representation, e.g., for debug. | NlpSemanticParsingLocalExtent | String | |
| value | For approximate values such as “a few” or “several”, we populate |value| with a specific numeric value which is a generous (i.e., high) interpretation of the text, and we set |non_specific_value| to true. | NlpSemanticParsingLocalExtent | float | |
| valueString | Can hold numbers as well as “a few”. | NlpSemanticParsingLocalExtent | String | |
| gcid | GCID – with the ‘gcid:’ prefix. | NlpSemanticParsingLocalGcidConstraint | String | |
| network | NlpSemanticParsingLocalHealthInsuranceConstraint | Constraint for the health insurance network of a provider. | String | |
| hotel | Basic accommodation types. | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean |
| seasideResort | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| extendedStayHotel | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| suite | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| vacationApartment | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| resort | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| guesthouse | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| villa | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| vacationHouse | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| beachResort | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| campsite | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| other | Any other lodging related type. | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean |
| japaneseInnWithHotSpring | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| cabin | Other accommodation types. | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean |
| ecoHotel | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| inn | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| skiResort | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| commonLodgingHouse | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| golfResort | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| loveHotel | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| capsuleHotel | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| chalet | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| hostel | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| castleHotel | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| bedAndBreakfast | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| motel | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| guestRanch | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| wellnessAndSpaAccommodation | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| vacationRental | Vacation rental accommodation types. | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean |
| safariLodge | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| houseboat | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| youthHostel | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| japaneseInn | Japanese accommodation types. | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean |
| lodging | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| businessHotel | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| cottage | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| servicedApartment | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| pension | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| gite | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| boutiqueHotel | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| condoHotel | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| conventionHotel | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| casinoAccommodation | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| lodge | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| allInclusiveResort | Basic accommodation types variations. | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean |
| farmstay | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| mountainHut | NlpSemanticParsingLocalHotelType | Hotel Type used by the hotels team to differentiate sub classes of accommodations. For any questions please contact hotel-search-quality@. Next ID: 48 | boolean | |
| commodityStrength | Whether a location is a commodity (distance is an important metric), neutral or non-commodity (distance is not important). Commodity locations are “atm”, “gas station”, etc. Non-commodity locations are “restaurant”, “hotel”, etc, and all others are neutral. The value is 1 for commodity queries, 0 for non-commodity queries, no-value for neutral queries (when the field doesn’t exist in the grammar). The reason it is a float is to prepare for future changes when we expand the signal value from discrete classes to a score, and the score will be in the range of [0,1]. | NlpSemanticParsingLocalHyperReliableData | Message containing information about hyper-reliable categories. go/local-hyper-reliable | number |
| gcidsynsOverride | NlpSemanticParsingLocalHyperReliableData | Message containing information about hyper-reliable categories. go/local-hyper-reliable | list(NlpSemanticParsingLocalHyperReliableDataGCIDSynsOverride) | |
| hyperReliable | NlpSemanticParsingLocalHyperReliableData | Message containing information about hyper-reliable categories. go/local-hyper-reliable | boolean | |
| retrievalGcids | Categories used for retrieval and used in Artemis diversity tiers as restricts. See https://ariane.googleplex.com/launch/190585 for details. | NlpSemanticParsingLocalHyperReliableData | Message containing information about hyper-reliable categories. go/local-hyper-reliable | list(String) |
| gcidScore | NlpSemanticParsingLocalHyperReliableDataGCIDSynsOverride | Set only when hyper_reliable is true. These are gcids and scores for hyper-reliable categories in ariane/182060. These are overridden for a few hyper-reliable categories, and may not be present everywhere. | number | |
| hyperReliableGcid | NlpSemanticParsingLocalHyperReliableDataGCIDSynsOverride | Set only when hyper_reliable is true. These are gcids and scores for hyper-reliable categories in ariane/182060. These are overridden for a few hyper-reliable categories, and may not be present everywhere. | String | |
| airport | NlpSemanticParsingLocalImplicitLocalCategory | Flags indiciating the specific implicit intent, e.g. dining, travel, etc. Next ID = 13 | boolean | |
| bank | NlpSemanticParsingLocalImplicitLocalCategory | Flags indiciating the specific implicit intent, e.g. dining, travel, etc. Next ID = 13 | boolean | |
| chargingStation | NlpSemanticParsingLocalImplicitLocalCategory | Flags indiciating the specific implicit intent, e.g. dining, travel, etc. Next ID = 13 | boolean | |
| gasStation | NlpSemanticParsingLocalImplicitLocalCategory | Flags indiciating the specific implicit intent, e.g. dining, travel, etc. Next ID = 13 | boolean | |
| gym | NlpSemanticParsingLocalImplicitLocalCategory | Flags indiciating the specific implicit intent, e.g. dining, travel, etc. Next ID = 13 | boolean | |
| hairSalon | NlpSemanticParsingLocalImplicitLocalCategory | Flags indiciating the specific implicit intent, e.g. dining, travel, etc. Next ID = 13 | boolean | |
| hospital | NlpSemanticParsingLocalImplicitLocalCategory | Flags indiciating the specific implicit intent, e.g. dining, travel, etc. Next ID = 13 | boolean | |
| hotel | NlpSemanticParsingLocalImplicitLocalCategory | Flags indiciating the specific implicit intent, e.g. dining, travel, etc. Next ID = 13 | boolean | |
| laundromat | NlpSemanticParsingLocalImplicitLocalCategory | Flags indiciating the specific implicit intent, e.g. dining, travel, etc. Next ID = 13 | boolean | |
| movieTheater | NlpSemanticParsingLocalImplicitLocalCategory | Flags indiciating the specific implicit intent, e.g. dining, travel, etc. Next ID = 13 | boolean | |
| postOffice | NlpSemanticParsingLocalImplicitLocalCategory | Flags indiciating the specific implicit intent, e.g. dining, travel, etc. Next ID = 13 | boolean | |
| spa | NlpSemanticParsingLocalImplicitLocalCategory | Flags indiciating the specific implicit intent, e.g. dining, travel, etc. Next ID = 13 | boolean | |
| numBytes | NlpSemanticParsingLocalJoiner | integer | ||
| numBytesForConversion | NlpSemanticParsingLocalJoiner | integer | ||
| startByte | The raw input span corresponding to this joiner. | NlpSemanticParsingLocalJoiner | integer | |
| startByteForConversion | Byte data added for conversion between this proto and IntentQuery in LooseParser. Must not be used for downstream triggering. | NlpSemanticParsingLocalJoiner | integer | |
| text | The original joiner string from the tokenized query. Particularly important if the type is OTHER. | NlpSemanticParsingLocalJoiner | String | |
| type | NlpSemanticParsingLocalJoiner | String | ||
| featureId | NlpSemanticParsingLocalLocalResultId | This message holds all info the local assistant team will need to lookup a LocalResult in search. | GeostoreFeatureIdProto | |
| geocodingAddress | The full address of the result. This should be a verbose address string that geocodes reliably. | NlpSemanticParsingLocalLocalResultId | This message holds all info the local assistant team will need to lookup a LocalResult in search. | String |
| kgMid | The knowledge graph reference of the result. | NlpSemanticParsingLocalLocalResultId | This message holds all info the local assistant team will need to lookup a LocalResult in search. | String |
| position | The position of the result. | NlpSemanticParsingLocalLocalResultId | This message holds all info the local assistant team will need to lookup a LocalResult in search. | GeostorePointProto |
| rect | The position of the result, if it can’t be expressed as a pointproto. | NlpSemanticParsingLocalLocalResultId | This message holds all info the local assistant team will need to lookup a LocalResult in search. | GeostoreRectProto |
| basicLocation | Exactly one of the location types should be populated. | NlpSemanticParsingLocalLocation | There are a few types of locations: – Basic locations are sequences of location elements which can be either actual locations or modifiers. E.g., “Mountain View CA 94040” may be the sequence “Mountain View” (an actual location), “CA” (an actual location, and “94040” (a numeric modifier). – Compound locations: these are two locations combined by a joiner. E.g., “Target in Mountain View CA 94040” has the joiner “in” and two basic locations (“Target”, and “Mountain View CA 94040”). Note that the definition is recursive, e.g., “Parking garage near Target in Mountain View”. – Vicinity location: indicates an area around a certain location. The area can be defined by time or space. E.g., “within 1 hour of Palo Alto”, “10 blocks from Union Square”, “a few miles from here”. Next ID: 14 LINT.IfChange() | NlpSemanticParsingLocalBasicLocation |
| compoundLocation | NlpSemanticParsingLocalLocation | There are a few types of locations: – Basic locations are sequences of location elements which can be either actual locations or modifiers. E.g., “Mountain View CA 94040” may be the sequence “Mountain View” (an actual location), “CA” (an actual location, and “94040” (a numeric modifier). – Compound locations: these are two locations combined by a joiner. E.g., “Target in Mountain View CA 94040” has the joiner “in” and two basic locations (“Target”, and “Mountain View CA 94040”). Note that the definition is recursive, e.g., “Parking garage near Target in Mountain View”. – Vicinity location: indicates an area around a certain location. The area can be defined by time or space. E.g., “within 1 hour of Palo Alto”, “10 blocks from Union Square”, “a few miles from here”. Next ID: 14 LINT.IfChange() | NlpSemanticParsingLocalCompoundLocation | |
| contactLocation | DEPRECATED. Instead, use LocationElement.contact_location. | NlpSemanticParsingLocalLocation | There are a few types of locations: – Basic locations are sequences of location elements which can be either actual locations or modifiers. E.g., “Mountain View CA 94040” may be the sequence “Mountain View” (an actual location), “CA” (an actual location, and “94040” (a numeric modifier). – Compound locations: these are two locations combined by a joiner. E.g., “Target in Mountain View CA 94040” has the joiner “in” and two basic locations (“Target”, and “Mountain View CA 94040”). Note that the definition is recursive, e.g., “Parking garage near Target in Mountain View”. – Vicinity location: indicates an area around a certain location. The area can be defined by time or space. E.g., “within 1 hour of Palo Alto”, “10 blocks from Union Square”, “a few miles from here”. Next ID: 14 LINT.IfChange() | NlpSemanticParsingLocalContactLocation |
| isMerged | True if the location is merged, for example by CombineLocationsFn. | NlpSemanticParsingLocalLocation | There are a few types of locations: – Basic locations are sequences of location elements which can be either actual locations or modifiers. E.g., “Mountain View CA 94040” may be the sequence “Mountain View” (an actual location), “CA” (an actual location, and “94040” (a numeric modifier). – Compound locations: these are two locations combined by a joiner. E.g., “Target in Mountain View CA 94040” has the joiner “in” and two basic locations (“Target”, and “Mountain View CA 94040”). Note that the definition is recursive, e.g., “Parking garage near Target in Mountain View”. – Vicinity location: indicates an area around a certain location. The area can be defined by time or space. E.g., “within 1 hour of Palo Alto”, “10 blocks from Union Square”, “a few miles from here”. Next ID: 14 LINT.IfChange() | boolean |
| locationConstraint | The constraint includes various constraints on the location such as amenities, price range, ratings, or attributes such as new, cheap, etc. These constraints are a part of the location but are not modeled as location elements and are not included in the location text. The (debatable) motivation is that they do not stand on their own and are not an intrinsic part of the location. Note on texts and spans. For a location such as “kid friendly hotels with an indoor pool” we expect to get a basic location with a single location element and two constraints: – For the location element: – Both text and span match “hotels” – For the first constraint: – Both text and span match “kid friendly” – For the second constraint: – Both text and span match “indoor pool” – For the full location: – text: “hotels” – span covers “kid friendly hotels with an indoor pool” | NlpSemanticParsingLocalLocation | There are a few types of locations: – Basic locations are sequences of location elements which can be either actual locations or modifiers. E.g., “Mountain View CA 94040” may be the sequence “Mountain View” (an actual location), “CA” (an actual location, and “94040” (a numeric modifier). – Compound locations: these are two locations combined by a joiner. E.g., “Target in Mountain View CA 94040” has the joiner “in” and two basic locations (“Target”, and “Mountain View CA 94040”). Note that the definition is recursive, e.g., “Parking garage near Target in Mountain View”. – Vicinity location: indicates an area around a certain location. The area can be defined by time or space. E.g., “within 1 hour of Palo Alto”, “10 blocks from Union Square”, “a few miles from here”. Next ID: 14 LINT.IfChange() | list(NlpSemanticParsingLocalLocationConstraint) |
| numBytes | NlpSemanticParsingLocalLocation | There are a few types of locations: – Basic locations are sequences of location elements which can be either actual locations or modifiers. E.g., “Mountain View CA 94040” may be the sequence “Mountain View” (an actual location), “CA” (an actual location, and “94040” (a numeric modifier). – Compound locations: these are two locations combined by a joiner. E.g., “Target in Mountain View CA 94040” has the joiner “in” and two basic locations (“Target”, and “Mountain View CA 94040”). Note that the definition is recursive, e.g., “Parking garage near Target in Mountain View”. – Vicinity location: indicates an area around a certain location. The area can be defined by time or space. E.g., “within 1 hour of Palo Alto”, “10 blocks from Union Square”, “a few miles from here”. Next ID: 14 LINT.IfChange() | integer | |
| resolvedLocalResult | A LocalResult corresponding to the location the user specified, populated by local dialog (generally following a search). This field will only be set if the location is unambiguous, possibly following a series of disambiguation turns of dialog. | NlpSemanticParsingLocalLocation | There are a few types of locations: – Basic locations are sequences of location elements which can be either actual locations or modifiers. E.g., “Mountain View CA 94040” may be the sequence “Mountain View” (an actual location), “CA” (an actual location, and “94040” (a numeric modifier). – Compound locations: these are two locations combined by a joiner. E.g., “Target in Mountain View CA 94040” has the joiner “in” and two basic locations (“Target”, and “Mountain View CA 94040”). Note that the definition is recursive, e.g., “Parking garage near Target in Mountain View”. – Vicinity location: indicates an area around a certain location. The area can be defined by time or space. E.g., “within 1 hour of Palo Alto”, “10 blocks from Union Square”, “a few miles from here”. Next ID: 14 LINT.IfChange() | QualityDialogManagerLocalResult |
| startByte | The span, in the raw input, which corresponds to this location, expressed as a byte offset and byte size. This allows the extraction of the location string as it appears in the raw text. | NlpSemanticParsingLocalLocation | There are a few types of locations: – Basic locations are sequences of location elements which can be either actual locations or modifiers. E.g., “Mountain View CA 94040” may be the sequence “Mountain View” (an actual location), “CA” (an actual location, and “94040” (a numeric modifier). – Compound locations: these are two locations combined by a joiner. E.g., “Target in Mountain View CA 94040” has the joiner “in” and two basic locations (“Target”, and “Mountain View CA 94040”). Note that the definition is recursive, e.g., “Parking garage near Target in Mountain View”. – Vicinity location: indicates an area around a certain location. The area can be defined by time or space. E.g., “within 1 hour of Palo Alto”, “10 blocks from Union Square”, “a few miles from here”. Next ID: 14 LINT.IfChange() | integer |
| text | A string representation of the location. Depending on the annotators and the location itself the string may represent the raw query, the pre-processed query, or something else. As a non-trivial example, for [target address mountain view] we will generate the text “target mountain view” without “address”. We make a best-effort to come up with a good string, but make no formal guarantees. You should never present this text directly to outside users. | NlpSemanticParsingLocalLocation | There are a few types of locations: – Basic locations are sequences of location elements which can be either actual locations or modifiers. E.g., “Mountain View CA 94040” may be the sequence “Mountain View” (an actual location), “CA” (an actual location, and “94040” (a numeric modifier). – Compound locations: these are two locations combined by a joiner. E.g., “Target in Mountain View CA 94040” has the joiner “in” and two basic locations (“Target”, and “Mountain View CA 94040”). Note that the definition is recursive, e.g., “Parking garage near Target in Mountain View”. – Vicinity location: indicates an area around a certain location. The area can be defined by time or space. E.g., “within 1 hour of Palo Alto”, “10 blocks from Union Square”, “a few miles from here”. Next ID: 14 LINT.IfChange() | String |
| userSpecifiedLocation | A location info including featureId and lat/lng that uniquely identifies the location the user specified. | NlpSemanticParsingLocalLocation | There are a few types of locations: – Basic locations are sequences of location elements which can be either actual locations or modifiers. E.g., “Mountain View CA 94040” may be the sequence “Mountain View” (an actual location), “CA” (an actual location, and “94040” (a numeric modifier). – Compound locations: these are two locations combined by a joiner. E.g., “Target in Mountain View CA 94040” has the joiner “in” and two basic locations (“Target”, and “Mountain View CA 94040”). Note that the definition is recursive, e.g., “Parking garage near Target in Mountain View”. – Vicinity location: indicates an area around a certain location. The area can be defined by time or space. E.g., “within 1 hour of Palo Alto”, “10 blocks from Union Square”, “a few miles from here”. Next ID: 14 LINT.IfChange() | KnowledgeVerticalsWeatherProtoUserSpecifiedLocation |
| vicinityLocation | NlpSemanticParsingLocalLocation | There are a few types of locations: – Basic locations are sequences of location elements which can be either actual locations or modifiers. E.g., “Mountain View CA 94040” may be the sequence “Mountain View” (an actual location), “CA” (an actual location, and “94040” (a numeric modifier). – Compound locations: these are two locations combined by a joiner. E.g., “Target in Mountain View CA 94040” has the joiner “in” and two basic locations (“Target”, and “Mountain View CA 94040”). Note that the definition is recursive, e.g., “Parking garage near Target in Mountain View”. – Vicinity location: indicates an area around a certain location. The area can be defined by time or space. E.g., “within 1 hour of Palo Alto”, “10 blocks from Union Square”, “a few miles from here”. Next ID: 14 LINT.IfChange() | NlpSemanticParsingLocalVicinityLocation | |
| amenities | LINT.IfChange | NlpSemanticParsingLocalLocationConstraint | All the possible location constraints. This message is associated with a location and can be nested accordingly. E.g., for a compound location the constraint may be associated with the entire location or with either of the two internal locations (loc_1 and loc_2). There is an implicit AND relation between the different constraints. Next ID: 26. | NlpSemanticParsingLocalAmenities |
| chainMember | NlpSemanticParsingLocalLocationConstraint | All the possible location constraints. This message is associated with a location and can be nested accordingly. E.g., for a compound location the constraint may be associated with the entire location or with either of the two internal locations (loc_1 and loc_2). There is an implicit AND relation between the different constraints. Next ID: 26. | NlpSemanticParsingLocalChainMemberConstraint | |
| cuisine | NlpSemanticParsingLocalLocationConstraint | All the possible location constraints. This message is associated with a location and can be nested accordingly. E.g., for a compound location the constraint may be associated with the entire location or with either of the two internal locations (loc_1 and loc_2). There is an implicit AND relation between the different constraints. Next ID: 26. | NlpSemanticParsingLocalCuisineConstraint | |
| evcsConnectorConstraint | Used for populating ElectricVehicleConnectorRefinement from QBF go/evcs-qbf-connector | NlpSemanticParsingLocalLocationConstraint | All the possible location constraints. This message is associated with a location and can be nested accordingly. E.g., for a compound location the constraint may be associated with the entire location or with either of the two internal locations (loc_1 and loc_2). There is an implicit AND relation between the different constraints. Next ID: 26. | NlpSemanticParsingLocalEvChargingStationConnectorConstraint |
| evcsPaymentConstraint | Used for populating ElectricVehiclePaymentRefinement from QBF go/evcs-qbf-payment | NlpSemanticParsingLocalLocationConstraint | All the possible location constraints. This message is associated with a location and can be nested accordingly. E.g., for a compound location the constraint may be associated with the entire location or with either of the two internal locations (loc_1 and loc_2). There is an implicit AND relation between the different constraints. Next ID: 26. | NlpSemanticParsingLocalEvChargingStationPaymentConstraint |
| evcsSpeedConstraint | NlpSemanticParsingLocalLocationConstraint | All the possible location constraints. This message is associated with a location and can be nested accordingly. E.g., for a compound location the constraint may be associated with the entire location or with either of the two internal locations (loc_1 and loc_2). There is an implicit AND relation between the different constraints. Next ID: 26. | NlpSemanticParsingLocalEvChargingStationSpeedConstraint | |
| gcidConstraint | Used for GCID filter. Unlike other grammar, for now this is populated in Superroot (currently based on QBLD classification, and an allowlist of GCID). | NlpSemanticParsingLocalLocationConstraint | All the possible location constraints. This message is associated with a location and can be nested accordingly. E.g., for a compound location the constraint may be associated with the entire location or with either of the two internal locations (loc_1 and loc_2). There is an implicit AND relation between the different constraints. Next ID: 26. | NlpSemanticParsingLocalGcidConstraint |
| healthInsurance | Used for health insurance filter populator. | NlpSemanticParsingLocalLocationConstraint | All the possible location constraints. This message is associated with a location and can be nested accordingly. E.g., for a compound location the constraint may be associated with the entire location or with either of the two internal locations (loc_1 and loc_2). There is an implicit AND relation between the different constraints. Next ID: 26. | NlpSemanticParsingLocalHealthInsuranceConstraint |
| hyperReliableData | Some constraints are also hyper-reliable, such as [brunch] and [coffee]. | NlpSemanticParsingLocalLocationConstraint | All the possible location constraints. This message is associated with a location and can be nested accordingly. E.g., for a compound location the constraint may be associated with the entire location or with either of the two internal locations (loc_1 and loc_2). There is an implicit AND relation between the different constraints. Next ID: 26. | NlpSemanticParsingLocalHyperReliableData |
| menuItem | NlpSemanticParsingLocalLocationConstraint | All the possible location constraints. This message is associated with a location and can be nested accordingly. E.g., for a compound location the constraint may be associated with the entire location or with either of the two internal locations (loc_1 and loc_2). There is an implicit AND relation between the different constraints. Next ID: 26. | NlpSemanticParsingLocalMenuItem | |
| new | NlpSemanticParsingLocalLocationConstraint | All the possible location constraints. This message is associated with a location and can be nested accordingly. E.g., for a compound location the constraint may be associated with the entire location or with either of the two internal locations (loc_1 and loc_2). There is an implicit AND relation between the different constraints. Next ID: 26. | boolean | |
| numBytes | NlpSemanticParsingLocalLocationConstraint | All the possible location constraints. This message is associated with a location and can be nested accordingly. E.g., for a compound location the constraint may be associated with the entire location or with either of the two internal locations (loc_1 and loc_2). There is an implicit AND relation between the different constraints. Next ID: 26. | integer | |
| open24Hours | NlpSemanticParsingLocalLocationConstraint | All the possible location constraints. This message is associated with a location and can be nested accordingly. E.g., for a compound location the constraint may be associated with the entire location or with either of the two internal locations (loc_1 and loc_2). There is an implicit AND relation between the different constraints. Next ID: 26. | boolean | |
| price | NlpSemanticParsingLocalLocationConstraint | All the possible location constraints. This message is associated with a location and can be nested accordingly. E.g., for a compound location the constraint may be associated with the entire location or with either of the two internal locations (loc_1 and loc_2). There is an implicit AND relation between the different constraints. Next ID: 26. | NlpSemanticParsingLocalPriceConstraint | |
| quality | NlpSemanticParsingLocalLocationConstraint | All the possible location constraints. This message is associated with a location and can be nested accordingly. E.g., for a compound location the constraint may be associated with the entire location or with either of the two internal locations (loc_1 and loc_2). There is an implicit AND relation between the different constraints. Next ID: 26. | NlpSemanticParsingLocalQualityConstraint | |
| rooms | NlpSemanticParsingLocalLocationConstraint | All the possible location constraints. This message is associated with a location and can be nested accordingly. E.g., for a compound location the constraint may be associated with the entire location or with either of the two internal locations (loc_1 and loc_2). There is an implicit AND relation between the different constraints. Next ID: 26. | NlpSemanticParsingLocalRoomConstraint | |
| scalableAttribute | NlpSemanticParsingLocalLocationConstraint | All the possible location constraints. This message is associated with a location and can be nested accordingly. E.g., for a compound location the constraint may be associated with the entire location or with either of the two internal locations (loc_1 and loc_2). There is an implicit AND relation between the different constraints. Next ID: 26. | NlpSemanticParsingLocalScalableAttribute | |
| service | NlpSemanticParsingLocalLocationConstraint | All the possible location constraints. This message is associated with a location and can be nested accordingly. E.g., for a compound location the constraint may be associated with the entire location or with either of the two internal locations (loc_1 and loc_2). There is an implicit AND relation between the different constraints. Next ID: 26. | NlpSemanticParsingLocalServiceConstraint | |
| startByte | The span, in the raw input, which corresponds to this constraint, expressed as a byte offset and byte size. | NlpSemanticParsingLocalLocationConstraint | All the possible location constraints. This message is associated with a location and can be nested accordingly. E.g., for a compound location the constraint may be associated with the entire location or with either of the two internal locations (loc_1 and loc_2). There is an implicit AND relation between the different constraints. Next ID: 26. | integer |
| text | NlpSemanticParsingLocalLocationConstraint | All the possible location constraints. This message is associated with a location and can be nested accordingly. E.g., for a compound location the constraint may be associated with the entire location or with either of the two internal locations (loc_1 and loc_2). There is an implicit AND relation between the different constraints. Next ID: 26. | String | |
| ungroundedConstraint | Experimental, may change. | NlpSemanticParsingLocalLocationConstraint | All the possible location constraints. This message is associated with a location and can be nested accordingly. E.g., for a compound location the constraint may be associated with the entire location or with either of the two internal locations (loc_1 and loc_2). There is an implicit AND relation between the different constraints. Next ID: 26. | boolean |
| unspecified | Used to remove all constraints, e.g. [forget all the filters] | NlpSemanticParsingLocalLocationConstraint | All the possible location constraints. This message is associated with a location and can be nested accordingly. E.g., for a compound location the constraint may be associated with the entire location or with either of the two internal locations (loc_1 and loc_2). There is an implicit AND relation between the different constraints. Next ID: 26. | boolean |
| vaccineType | Used for vaccine refinement: go/covid-vaccine-refinement. | NlpSemanticParsingLocalLocationConstraint | All the possible location constraints. This message is associated with a location and can be nested accordingly. E.g., for a compound location the constraint may be associated with the entire location or with either of the two internal locations (loc_1 and loc_2). There is an implicit AND relation between the different constraints. Next ID: 26. | String |
| visitHistory | NlpSemanticParsingLocalLocationConstraint | All the possible location constraints. This message is associated with a location and can be nested accordingly. E.g., for a compound location the constraint may be associated with the entire location or with either of the two internal locations (loc_1 and loc_2). There is an implicit AND relation between the different constraints. Next ID: 26. | NlpSemanticParsingLocalVisitHistoryConstraint | |
| aliasIcon | For elements with a NICKNAME alias location, this field will hold all matching alias icons, which are used in search to resolve the location. | NlpSemanticParsingLocalLocationElement | Next ID: 26 LINT.IfChange | list(PersonalizationMapsAliasIcon) |
| aliasLocation | The following fields (alias_location, qref_location, and saft_location) should have at most one non-empty value between them. | NlpSemanticParsingLocalLocationElement | Next ID: 26 LINT.IfChange | String |
| businessType | Set only when type is BUSINESS_NAME or BUSINESS_CATEGORY. | NlpSemanticParsingLocalLocationElement | Next ID: 26 LINT.IfChange | NlpSemanticParsingLocalBusinessType |
| contactLocation | NlpSemanticParsingLocalLocationElement | Next ID: 26 LINT.IfChange | NlpSemanticParsingLocalContactLocation | |
| dialogReferents | This will hold semantics from the dialog_referents subgrammar with offsets and indices relating to a list of results shown to the user. This field is repeated while in the future we could support multiple item list selection. i.e. [the starbucks] where multiple entries in the results will be indicated here | NlpSemanticParsingLocalLocationElement | Next ID: 26 LINT.IfChange | list(NlpSemanticParsingModelsDialogReferentsDialogReferents) |
| directionalModifier | Set only when type is DIRECTIONAL_MODIFIER. | NlpSemanticParsingLocalLocationElement | Next ID: 26 LINT.IfChange | String |
| genericLocation | DEPRECATED. See basic_location.element.type == LOCATION_REFERENT to determine this instead. Populated by a type VISITED local action, this field is used to indicate a location element is a general-case $PT_visited_location string. | NlpSemanticParsingLocalLocationElement | Next ID: 26 LINT.IfChange | boolean |
| hotelType | Set only when business_type is hotel. | NlpSemanticParsingLocalLocationElement | Next ID: 26 LINT.IfChange | NlpSemanticParsingLocalHotelType |
| hyperReliableData | NlpSemanticParsingLocalLocationElement | Next ID: 26 LINT.IfChange | NlpSemanticParsingLocalHyperReliableData | |
| implicitLocalCategory | NlpSemanticParsingLocalLocationElement | Next ID: 26 LINT.IfChange | NlpSemanticParsingLocalImplicitLocalCategory | |
| localResultId | A field used to store the ID of a specific location entity, especially one not extracted via QRef. For example, – a location selected by the users via a dialog follow-up query like [the second one]. Will only be populated in the LocalSemanticsServlet, not in the grammar. – a location resolved based on a full search, e.g., following the geocoding step for a directions query. This field is also used by NoramlizeLocationForFingerprinting as the canonical place to store FeatureIds. | NlpSemanticParsingLocalLocationElement | Next ID: 26 LINT.IfChange | NlpSemanticParsingLocalLocalResultId |
| numBytes | NlpSemanticParsingLocalLocationElement | Next ID: 26 LINT.IfChange | integer | |
| number | Represents zip codes, street numbers, etc. that were detected directly by the grammar (and not, e.g., by QRef). DEPRECATED. We ran into problems with zip codes having leading zeroes. Now we store numbers only in the text field. | NlpSemanticParsingLocalLocationElement | Next ID: 26 LINT.IfChange | integer |
| personalReferenceLocation | A collection of QRefAnnotations repesenting Reference and Resolution data for Personal References. See go/copley-local and go/copley-annotator. | NlpSemanticParsingLocalLocationElement | Next ID: 26 LINT.IfChange | NlpSemanticParsingPersonalReferenceAnnotation |
| qrefLocation | NlpSemanticParsingLocalLocationElement | Next ID: 26 LINT.IfChange | NlpSemanticParsingQRefAnnotation | |
| saftLocation | NlpSemanticParsingLocalLocationElement | Next ID: 26 LINT.IfChange | NlpSemanticParsingSaftMentionAnnotation | |
| source | NlpSemanticParsingLocalLocationElement | Next ID: 26 LINT.IfChange | String | |
| startByte | The byte span, in the raw query, which corresponds to this location element. | NlpSemanticParsingLocalLocationElement | Next ID: 26 LINT.IfChange | integer |
| text | A string representation of the location element. Typical, this field will be populated by the MakeLocationElementFn semantic function with the substring of the raw_query defined by start_byte and num_bytes. However, the field can also be populated explicitly in the grammar, in which case MakeLocationElementFn leaves it alone. | NlpSemanticParsingLocalLocationElement | Next ID: 26 LINT.IfChange | String |
| transitLineNumber | Train number associated with /collection/geo/transit_line. Populated when user requests specific instance of a transit line. For example, long distance trains in India have two numbers for each train, one for up direction and other for down. And user use these numbers in queries along with name to specify the specific trip of the train. More details in go/number-transit-line-queries. | NlpSemanticParsingLocalLocationElement | Next ID: 26 LINT.IfChange | String |
| type | NlpSemanticParsingLocalLocationElement | Next ID: 26 LINT.IfChange | String | |
| menuItemId | This ID corresponds to the name of the menu item in the query. For example [restaurants that serve thai curry] has menu_item_id = “thai curry”. | NlpSemanticParsingLocalMenuItem | Specifies intent that corresponds to a menu item which is used as a location constraint, e.g. [restaurants that serve thai curry] or as a standalone categorical element, e.g. [thai curry]. | String |
| cheap | NlpSemanticParsingLocalPriceConstraint | boolean | ||
| currencyCode | The currency codes are expected to be string from the list in i18n/identifiers/currencycode.* | NlpSemanticParsingLocalPriceConstraint | String | |
| expensive | NlpSemanticParsingLocalPriceConstraint | boolean | ||
| maxPrice | NlpSemanticParsingLocalPriceConstraint | float | ||
| minPrice | NlpSemanticParsingLocalPriceConstraint | float | ||
| moderatelyPriced | NlpSemanticParsingLocalPriceConstraint | boolean | ||
| unspecified | The user mentioned something about price, but didn’t mention a specific constraint. This is used to indicate an intent to remove all price constraints, in queries like [forget the price]. | NlpSemanticParsingLocalPriceConstraint | boolean | |
| best | NlpSemanticParsingLocalQualityConstraint | Quality constraints about the establishment. In the future we can add to this message Zagat ratings, user reviews, etc. Next ID: 6. | boolean | |
| highlyRated | NlpSemanticParsingLocalQualityConstraint | Quality constraints about the establishment. In the future we can add to this message Zagat ratings, user reviews, etc. Next ID: 6. | boolean | |
| starType | NlpSemanticParsingLocalQualityConstraint | Quality constraints about the establishment. In the future we can add to this message Zagat ratings, user reviews, etc. Next ID: 6. | String | |
| stars | NlpSemanticParsingLocalQualityConstraint | Quality constraints about the establishment. In the future we can add to this message Zagat ratings, user reviews, etc. Next ID: 6. | NlpSemanticParsingLocalStarRatings | |
| unspecified | The user mentioned something about quality, but didn’t mention a specific constraint. This is used to indicate an intent to remove all quality constraints, in queries like [forget the rating]. | NlpSemanticParsingLocalQualityConstraint | Quality constraints about the establishment. In the future we can add to this message Zagat ratings, user reviews, etc. Next ID: 6. | boolean |
| minNumBathrooms | It is possible to have fractional bathrooms. | NlpSemanticParsingLocalRoomConstraint | Constraints for the occupancy of a hotel or vacation rental. | float |
| minNumBedrooms | NlpSemanticParsingLocalRoomConstraint | Constraints for the occupancy of a hotel or vacation rental. | integer | |
| attributeId | NlpSemanticParsingLocalScalableAttribute | Specifies intent that corresponds to a scalable attribute. This may be used as a location constraint, e.g. [restaurants with outdoor seating] or as a standalone categorical element, e.g. [happy hour] or [happy hour ny]. See go/scalable-attributes for details about scalable attributes. NOTE(oksana): LocalCategoryReliable grammar over-rides a few scalable attribute queries to include hyper_reliable location element. If you change this, please make sure that LocalCategoryReliable grammar reflects this too. LINT.IfChange This ID corresponds to the id field in //geostore/attributes/proto/config.proto:AttributeConfigProto This field holds the human readable ID for the KG topic that represents the attribute. Example: “/geo/type/establishment_poi/serves_breakfast” | String | |
| serviceType | NlpSemanticParsingLocalServiceConstraint | String | ||
| five | NlpSemanticParsingLocalStarRatings | Star ratings constraints, mostly relevant for hotels. There is an implicit OR relation between these. E.g., for “three star or four star hotel” both three and four would be set to true. Next Available ID: 13. | boolean | |
| four | NlpSemanticParsingLocalStarRatings | Star ratings constraints, mostly relevant for hotels. There is an implicit OR relation between these. E.g., for “three star or four star hotel” both three and four would be set to true. Next Available ID: 13. | boolean | |
| fourAndAHalf | NlpSemanticParsingLocalStarRatings | Star ratings constraints, mostly relevant for hotels. There is an implicit OR relation between these. E.g., for “three star or four star hotel” both three and four would be set to true. Next Available ID: 13. | boolean | |
| one | NlpSemanticParsingLocalStarRatings | Star ratings constraints, mostly relevant for hotels. There is an implicit OR relation between these. E.g., for “three star or four star hotel” both three and four would be set to true. Next Available ID: 13. | boolean | |
| oneAndAHalf | NlpSemanticParsingLocalStarRatings | Star ratings constraints, mostly relevant for hotels. There is an implicit OR relation between these. E.g., for “three star or four star hotel” both three and four would be set to true. Next Available ID: 13. | boolean | |
| orFewer | NlpSemanticParsingLocalStarRatings | Star ratings constraints, mostly relevant for hotels. There is an implicit OR relation between these. E.g., for “three star or four star hotel” both three and four would be set to true. Next Available ID: 13. | boolean | |
| orMore | If this field is set, exactly one of the star classes above should be set, and the interpretation should be that at least that many stars should be present. | NlpSemanticParsingLocalStarRatings | Star ratings constraints, mostly relevant for hotels. There is an implicit OR relation between these. E.g., for “three star or four star hotel” both three and four would be set to true. Next Available ID: 13. | boolean |
| three | NlpSemanticParsingLocalStarRatings | Star ratings constraints, mostly relevant for hotels. There is an implicit OR relation between these. E.g., for “three star or four star hotel” both three and four would be set to true. Next Available ID: 13. | boolean | |
| threeAndAHalf | NlpSemanticParsingLocalStarRatings | Star ratings constraints, mostly relevant for hotels. There is an implicit OR relation between these. E.g., for “three star or four star hotel” both three and four would be set to true. Next Available ID: 13. | boolean | |
| two | NlpSemanticParsingLocalStarRatings | Star ratings constraints, mostly relevant for hotels. There is an implicit OR relation between these. E.g., for “three star or four star hotel” both three and four would be set to true. Next Available ID: 13. | boolean | |
| twoAndAHalf | NlpSemanticParsingLocalStarRatings | Star ratings constraints, mostly relevant for hotels. There is an implicit OR relation between these. E.g., for “three star or four star hotel” both three and four would be set to true. Next Available ID: 13. | boolean | |
| unspecified | NlpSemanticParsingLocalStarRatings | Star ratings constraints, mostly relevant for hotels. There is an implicit OR relation between these. E.g., for “three star or four star hotel” both three and four would be set to true. Next Available ID: 13. | boolean | |
| base | If the base is missing then clients should assume that it implicitly means “here”. E.g., “within five miles” really means “within five miles from here” | NlpSemanticParsingLocalVicinityLocation | NlpSemanticParsingLocalLocation | |
| connector | The text between the extent and the base, e.g., for “50 miles from here” the connector is “from”. | NlpSemanticParsingLocalVicinityLocation | String | |
| extent | NlpSemanticParsingLocalVicinityLocation | NlpSemanticParsingLocalExtent | ||
| visitedType | NlpSemanticParsingLocalVisitHistoryConstraint | Constraint for visited, as in if a location has been visited before. | String | |
| evalData | Required, but should only be used inside Aqua and must not be used by outside clients!! | NlpSemanticParsingModelsCommunicationPhoneType | The type of contact (mobile, home, work, etc). NOTE: Unfortunately the name of this message is a misnomer. Contact type would be a better name. | NlpSemanticParsingAnnotationEvalData |
| isAnnotatedFromText | Whether the annotation is from $Text. | NlpSemanticParsingModelsCommunicationPhoneType | The type of contact (mobile, home, work, etc). NOTE: Unfortunately the name of this message is a misnomer. Contact type would be a better name. | boolean |
| normalizedText | Normalized (canonicalized) text, e.g. “mobile”. | NlpSemanticParsingModelsCommunicationPhoneType | The type of contact (mobile, home, work, etc). NOTE: Unfortunately the name of this message is a misnomer. Contact type would be a better name. | String |
| originalText | Original text in query, e.g. “cell”. | NlpSemanticParsingModelsCommunicationPhoneType | The type of contact (mobile, home, work, etc). NOTE: Unfortunately the name of this message is a misnomer. Contact type would be a better name. | String |
| rawText | DEPRECATED. Used original_text instead. | NlpSemanticParsingModelsCommunicationPhoneType | The type of contact (mobile, home, work, etc). NOTE: Unfortunately the name of this message is a misnomer. Contact type would be a better name. | String |
| calendarEvent | NlpSemanticParsingModelsCommunicationRecipient | It can be a contact (person name), a business name, an email address or a phone number. NOTE: Unfortunately the name of this message is not generic enough. Contact would be a better name. | AssistantApiCoreTypesCalendarEvent | |
| calendarEventWrapper | NlpSemanticParsingModelsCommunicationRecipient | It can be a contact (person name), a business name, an email address or a phone number. NOTE: Unfortunately the name of this message is not generic enough. Contact would be a better name. | AssistantApiCoreTypesCalendarEventWrapper | |
| contact | Contact details (e.g. gaia_id, phone, etc). Replaces ‘focus_name’ above. | NlpSemanticParsingModelsCommunicationRecipient | It can be a contact (person name), a business name, an email address or a phone number. NOTE: Unfortunately the name of this message is not generic enough. Contact would be a better name. | NlpSemanticParsingModelsPersonPerson |
| evalData | Required, but should only be used inside Aqua and must not be used by outside clients!! | NlpSemanticParsingModelsCommunicationRecipient | It can be a contact (person name), a business name, an email address or a phone number. NOTE: Unfortunately the name of this message is not generic enough. Contact would be a better name. | NlpSemanticParsingAnnotationEvalData |
| isAnnotatedFromText | NlpSemanticParsingModelsCommunicationRecipient | It can be a contact (person name), a business name, an email address or a phone number. NOTE: Unfortunately the name of this message is not generic enough. Contact would be a better name. | boolean | |
| nameAnnotationSource | Deprecated in favor of recipient.contact.name_annotation_source. | NlpSemanticParsingModelsCommunicationRecipient | It can be a contact (person name), a business name, an email address or a phone number. NOTE: Unfortunately the name of this message is not generic enough. Contact would be a better name. | String |
| numberAnnotationSource | NlpSemanticParsingModelsCommunicationRecipient | It can be a contact (person name), a business name, an email address or a phone number. NOTE: Unfortunately the name of this message is not generic enough. Contact would be a better name. | String | |
| rawText | NOTE: for CONTACT recipient, this is *NOT* the real raw text of the recipient span of historical reasons. Major differences includes: – stripping possessive suffix, e.g. “John’s” -> “John” – stripping prefix/suffix/title, e.g. “Mr. John” -> “John” – uninflect name for languages like Russian, e.g. “Андрею” -> “Андрей” Currently this is the same as .contact.name, and is used as the string shown to the user on clientside UI. If you’re looking for real raw text, use .contact.raw_text | NlpSemanticParsingModelsCommunicationRecipient | It can be a contact (person name), a business name, an email address or a phone number. NOTE: Unfortunately the name of this message is not generic enough. Contact would be a better name. | String |
| recipientType | NlpSemanticParsingModelsCommunicationRecipient | It can be a contact (person name), a business name, an email address or a phone number. NOTE: Unfortunately the name of this message is not generic enough. Contact would be a better name. | String | |
| relationship | A reference to a person by relationship name. eg. my father. | NlpSemanticParsingModelsCommunicationRecipient | It can be a contact (person name), a business name, an email address or a phone number. NOTE: Unfortunately the name of this message is not generic enough. Contact would be a better name. | NlpSemanticParsingModelsCommunicationRelationshipArgument |
| sensitiveNumBytes | NlpSemanticParsingModelsCommunicationRecipient | It can be a contact (person name), a business name, an email address or a phone number. NOTE: Unfortunately the name of this message is not generic enough. Contact would be a better name. | integer | |
| sensitiveStartByte | The beginning and end of the recipient name that should be removed before logging. | NlpSemanticParsingModelsCommunicationRecipient | It can be a contact (person name), a business name, an email address or a phone number. NOTE: Unfortunately the name of this message is not generic enough. Contact would be a better name. | integer |
| alias | The alias of the relationship in the query, e.g. “mom”. | NlpSemanticParsingModelsCommunicationRelationshipArgument | A relationship contact. | String |
| canonical | The canonical format of the relationship, e.g. “Mother”. | NlpSemanticParsingModelsCommunicationRelationshipArgument | A relationship contact. | String |
| canonicalLexicalMid | Mid for an entity that has lexical data (a LexiconEntry). See https://g3doc.corp.google.com/nlp/generation/g3doc/lexical_data.md for for more information about lexical data. This is the canonical mid for this entity (eg. it would be /m/0lbxz for “mother” in EN even if user referred to “mom”). | NlpSemanticParsingModelsCommunicationRelationshipArgument | A relationship contact. | String |
| deviceName | The name of the device (Nexus 5, Nexus 10, etc). | NlpSemanticParsingModelsDevice | The device to perform an action. Both device_type and device_name are optional and they can coexist: [on my phone]: device_type = PHONE [on my nexus 4]: device_name = “nexus 4” [on my nexus phone]: device_type = PHONE, device_name = “nexus” | NlpSemanticParsingModelsDeviceName |
| deviceType | The type of the device (phone, tablet, watch, etc). | NlpSemanticParsingModelsDevice | The device to perform an action. Both device_type and device_name are optional and they can coexist: [on my phone]: device_type = PHONE [on my nexus 4]: device_name = “nexus 4” [on my nexus phone]: device_type = PHONE, device_name = “nexus” | String |
| evalData | Required, but should only be used inside Aqua and must not be used by outside clients!! | NlpSemanticParsingModelsDeviceName | The name of the device (Nexus 5, Nexus 10, etc). | NlpSemanticParsingAnnotationEvalData |
| rawText | NlpSemanticParsingModelsDeviceName | The name of the device (Nexus 5, Nexus 10, etc). | String | |
| evalData | NlpSemanticParsingModelsDialogReferentsDialogReferents | Will be used by dialog_referent subgrammar to emit types annotations from DialogReferentsAnnotator and $DialogReferentOrdinal rules. | NlpSemanticParsingAnnotationEvalData | |
| field | The field mentioned in the user’s utterance, if any. | NlpSemanticParsingModelsDialogReferentsDialogReferents | Will be used by dialog_referent subgrammar to emit types annotations from DialogReferentsAnnotator and $DialogReferentOrdinal rules. | NlpSemanticParsingModelsDialogReferentsListSelection |
| index | Used for a grammar mention of an index. | NlpSemanticParsingModelsDialogReferentsDialogReferents | Will be used by dialog_referent subgrammar to emit types annotations from DialogReferentsAnnotator and $DialogReferentOrdinal rules. | integer |
| next | Represents a tied referent in a different field of the same label | NlpSemanticParsingModelsDialogReferentsDialogReferents | Will be used by dialog_referent subgrammar to emit types annotations from DialogReferentsAnnotator and $DialogReferentOrdinal rules. | NlpSemanticParsingModelsDialogReferentsDialogReferents |
| selection | The requested value(s) for selection from a list of alternatives. | NlpSemanticParsingModelsDialogReferentsDialogReferents | Will be used by dialog_referent subgrammar to emit types annotations from DialogReferentsAnnotator and $DialogReferentOrdinal rules. | list(NlpSemanticParsingModelsDialogReferentsListSelection) |
| taskMention | Set when the user’s utterance refers to the (an) overall task/goal of the dialog (e.g. “the meeting starts at 10 am” mentions the goal, “meeting”). The field is repeated in case the user ambiguously identifies a task (two tasks named ‘meeting’). | NlpSemanticParsingModelsDialogReferentsDialogReferents | Will be used by dialog_referent subgrammar to emit types annotations from DialogReferentsAnnotator and $DialogReferentOrdinal rules. | list(NlpSemanticParsingModelsDialogReferentsListSelection) |
| evalData | NlpSemanticParsingModelsDialogReferentsListSelection | Represents the user’s selection from a list of alternatives. | NlpSemanticParsingAnnotationEvalData | |
| id | A unique identifier that is the canonical value for the chosen list item. If we are selecting among fields, this is the field_id specified in the corresponding DialogField. | NlpSemanticParsingModelsDialogReferentsListSelection | Represents the user’s selection from a list of alternatives. | String |
| looseOffsetRestriction | If true, semantic function should look at watch actions in the following display entity if the first one is not playable. This is useful for “Play it” on entity page. | NlpSemanticParsingModelsDialogReferentsListSelection | Represents the user’s selection from a list of alternatives. | boolean |
| offset | The offset within the list, if know. If the list of values wasn’t known (e.g. from the discourse context) then the offset is a zero-based mapping of the ordinal value of the selection (“first one” maps to zero; “last one” to minus one). | NlpSemanticParsingModelsDialogReferentsListSelection | Represents the user’s selection from a list of alternatives. | integer |
| rawText | When the user selects a list value by name then this is the matched text from the utterance. Note that, if the list of values is known, then the aqua annotator should have mapped it to an offset. | NlpSemanticParsingModelsDialogReferentsListSelection | Represents the user’s selection from a list of alternatives. | String |
| annotationList | Annotations from custom media annotator. | NlpSemanticParsingModelsMediaAlbumTitle | Example: “The White Album” | NlpSemanticParsingModelsMediaMediaAnnotationList |
| evalData | Required, but should only be used inside Aqua and must not be used by outside clients!! | NlpSemanticParsingModelsMediaAlbumTitle | Example: “The White Album” | NlpSemanticParsingAnnotationEvalData |
| favorite | If true, indicates the user wants their favorite album. Like [play my favorite album my Eminem] | NlpSemanticParsingModelsMediaAlbumTitle | Example: “The White Album” | boolean |
| first | If true, indicates the user wants the first album. Like [play adele’s first album] | NlpSemanticParsingModelsMediaAlbumTitle | Example: “The White Album” | boolean |
| isFromFastPath | Is annotated by Nimble for the media Fast Path. | NlpSemanticParsingModelsMediaAlbumTitle | Example: “The White Album” | boolean |
| latest | If true, indicates the user wants the latest album. Like, [play adele’s latest album] | NlpSemanticParsingModelsMediaAlbumTitle | Example: “The White Album” | boolean |
| playMore | More from this album. | NlpSemanticParsingModelsMediaAlbumTitle | Example: “The White Album” | boolean |
| qref | NlpSemanticParsingModelsMediaAlbumTitle | Example: “The White Album” | NlpSemanticParsingQRefAnnotation | |
| rawText | Required, corresponds to the raw text, like “The White Album.” | NlpSemanticParsingModelsMediaAlbumTitle | Example: “The White Album” | String |
| album | NlpSemanticParsingModelsMediaAudio | Represents a music recording (usually a song). Each populated field can be thought of as additional constraint about the song’s identity. For instance, if no fields are set, then this represents “some song.” If only the music_artist is set, then it represents “some song by the specified music_artist.” Inspired (but not strictly adhered to) http://schema.org/MusicRecording Next ID: 22 | NlpSemanticParsingModelsMediaAlbumTitle | |
| artist | NlpSemanticParsingModelsMediaAudio | Represents a music recording (usually a song). Each populated field can be thought of as additional constraint about the song’s identity. For instance, if no fields are set, then this represents “some song.” If only the music_artist is set, then it represents “some song by the specified music_artist.” Inspired (but not strictly adhered to) http://schema.org/MusicRecording Next ID: 22 | NlpSemanticParsingModelsMediaMusicArtist | |
| book | Like an audio book. “Listen to (moby dick) audiobook” | NlpSemanticParsingModelsMediaAudio | Represents a music recording (usually a song). Each populated field can be thought of as additional constraint about the song’s identity. For instance, if no fields are set, then this represents “some song.” If only the music_artist is set, then it represents “some song by the specified music_artist.” Inspired (but not strictly adhered to) http://schema.org/MusicRecording Next ID: 22 | NlpSemanticParsingModelsMediaBook |
| dateTime | A date time constraint for audio entity, for example, “jazz station 1980”. | NlpSemanticParsingModelsMediaAudio | Represents a music recording (usually a song). Each populated field can be thought of as additional constraint about the song’s identity. For instance, if no fields are set, then this represents “some song.” If only the music_artist is set, then it represents “some song by the specified music_artist.” Inspired (but not strictly adhered to) http://schema.org/MusicRecording Next ID: 22 | NlpSemanticParsingDatetimeDateTime |
| episodeConstraint | Constraining the query to some detail about the episode. Example: “listen to episode (13) of this american life with (mike birbiglia)” would have the 2 constraints in parens. | NlpSemanticParsingModelsMediaAudio | Represents a music recording (usually a song). Each populated field can be thought of as additional constraint about the song’s identity. For instance, if no fields are set, then this represents “some song.” If only the music_artist is set, then it represents “some song by the specified music_artist.” Inspired (but not strictly adhered to) http://schema.org/MusicRecording Next ID: 22 | list(NlpSemanticParsingModelsMediaEpisodeConstraint) |
| game | Soundtrack or theme song (see score_type param that indicates whether the user refers to a soundtrack or a theme song) of the game. “Play soundtrack from (Deus Ex Human Revolution)”. | NlpSemanticParsingModelsMediaAudio | Represents a music recording (usually a song). Each populated field can be thought of as additional constraint about the song’s identity. For instance, if no fields are set, then this represents “some song.” If only the music_artist is set, then it represents “some song by the specified music_artist.” Inspired (but not strictly adhered to) http://schema.org/MusicRecording Next ID: 22 | NlpSemanticParsingModelsMediaGame |
| genericMusic | NlpSemanticParsingModelsMediaAudio | Represents a music recording (usually a song). Each populated field can be thought of as additional constraint about the song’s identity. For instance, if no fields are set, then this represents “some song.” If only the music_artist is set, then it represents “some song by the specified music_artist.” Inspired (but not strictly adhered to) http://schema.org/MusicRecording Next ID: 22 | NlpSemanticParsingModelsMediaGenericMusic | |
| genre | NlpSemanticParsingModelsMediaAudio | Represents a music recording (usually a song). Each populated field can be thought of as additional constraint about the song’s identity. For instance, if no fields are set, then this represents “some song.” If only the music_artist is set, then it represents “some song by the specified music_artist.” Inspired (but not strictly adhered to) http://schema.org/MusicRecording Next ID: 22 | NlpSemanticParsingModelsMediaMusicGenre | |
| movie | Soundtrack or theme song (see score_type param that indicates whether the user refers to a soundtrack or a theme song) of the movie. E.g. “Play (Let It Go) from (Disney’s Frozen)” | NlpSemanticParsingModelsMediaAudio | Represents a music recording (usually a song). Each populated field can be thought of as additional constraint about the song’s identity. For instance, if no fields are set, then this represents “some song.” If only the music_artist is set, then it represents “some song by the specified music_artist.” Inspired (but not strictly adhered to) http://schema.org/MusicRecording Next ID: 22 | NlpSemanticParsingModelsMediaMovie |
| newsTopic | News topic. “Listen to news about (Ukraine)” | NlpSemanticParsingModelsMediaAudio | Represents a music recording (usually a song). Each populated field can be thought of as additional constraint about the song’s identity. For instance, if no fields are set, then this represents “some song.” If only the music_artist is set, then it represents “some song by the specified music_artist.” Inspired (but not strictly adhered to) http://schema.org/MusicRecording Next ID: 22 | NlpSemanticParsingModelsMediaNewsTopic |
| noExplicitAudio | True when the query does not contains an explict audio name. E.g. When user says “play” or “listen to”. | NlpSemanticParsingModelsMediaAudio | Represents a music recording (usually a song). Each populated field can be thought of as additional constraint about the song’s identity. For instance, if no fields are set, then this represents “some song.” If only the music_artist is set, then it represents “some song by the specified music_artist.” Inspired (but not strictly adhered to) http://schema.org/MusicRecording Next ID: 22 | boolean |
| playlist | NlpSemanticParsingModelsMediaAudio | Represents a music recording (usually a song). Each populated field can be thought of as additional constraint about the song’s identity. For instance, if no fields are set, then this represents “some song.” If only the music_artist is set, then it represents “some song by the specified music_artist.” Inspired (but not strictly adhered to) http://schema.org/MusicRecording Next ID: 22 | NlpSemanticParsingModelsMediaMusicPlaylist | |
| podcast | Podcast feeds. “Listen to (This American Life)” | NlpSemanticParsingModelsMediaAudio | Represents a music recording (usually a song). Each populated field can be thought of as additional constraint about the song’s identity. For instance, if no fields are set, then this represents “some song.” If only the music_artist is set, then it represents “some song by the specified music_artist.” Inspired (but not strictly adhered to) http://schema.org/MusicRecording Next ID: 22 | NlpSemanticParsingModelsMediaPodcast |
| radio | NlpSemanticParsingModelsMediaAudio | Represents a music recording (usually a song). Each populated field can be thought of as additional constraint about the song’s identity. For instance, if no fields are set, then this represents “some song.” If only the music_artist is set, then it represents “some song by the specified music_artist.” Inspired (but not strictly adhered to) http://schema.org/MusicRecording Next ID: 22 | NlpSemanticParsingModelsMediaRadio | |
| radioNetwork | E.g. “play NPR radio”, “Play BBC radio”. | NlpSemanticParsingModelsMediaAudio | Represents a music recording (usually a song). Each populated field can be thought of as additional constraint about the song’s identity. For instance, if no fields are set, then this represents “some song.” If only the music_artist is set, then it represents “some song by the specified music_artist.” Inspired (but not strictly adhered to) http://schema.org/MusicRecording Next ID: 22 | NlpSemanticParsingModelsMediaRadioNetwork |
| rawText | The query for backends to use in search. e.g. for an user query of “play kids song video on tv” from assistant, this field would be “kids song”. Note: there is no guarantee this field is populated; when it is not, backends should fall back to “raw_text” fields in song, artist, album etc. | NlpSemanticParsingModelsMediaAudio | Represents a music recording (usually a song). Each populated field can be thought of as additional constraint about the song’s identity. For instance, if no fields are set, then this represents “some song.” If only the music_artist is set, then it represents “some song by the specified music_artist.” Inspired (but not strictly adhered to) http://schema.org/MusicRecording Next ID: 22 | String |
| scoreType | If any of movie, game or tv show fields is populated this field indicates specific score type requested in the query. E.g. for [play soundtrack from frozen] this field is SOUNDTRACK, for [play frozen song] this field is THEME_SONG. | NlpSemanticParsingModelsMediaAudio | Represents a music recording (usually a song). Each populated field can be thought of as additional constraint about the song’s identity. For instance, if no fields are set, then this represents “some song.” If only the music_artist is set, then it represents “some song by the specified music_artist.” Inspired (but not strictly adhered to) http://schema.org/MusicRecording Next ID: 22 | String |
| seasonConstraint | Constraining the query to some detail about the season. Example: “listen to season 2 of serial” | NlpSemanticParsingModelsMediaAudio | Represents a music recording (usually a song). Each populated field can be thought of as additional constraint about the song’s identity. For instance, if no fields are set, then this represents “some song.” If only the music_artist is set, then it represents “some song by the specified music_artist.” Inspired (but not strictly adhered to) http://schema.org/MusicRecording Next ID: 22 | NlpSemanticParsingModelsMediaSeasonConstraint |
| song | NlpSemanticParsingModelsMediaAudio | Represents a music recording (usually a song). Each populated field can be thought of as additional constraint about the song’s identity. For instance, if no fields are set, then this represents “some song.” If only the music_artist is set, then it represents “some song by the specified music_artist.” Inspired (but not strictly adhered to) http://schema.org/MusicRecording Next ID: 22 | NlpSemanticParsingModelsMediaSong | |
| tag | Optional tags associated with how the media entity should be played. For example, this can be set to SEED_RADIO to signify that the user wants to play a radio station seeded by the entity. | NlpSemanticParsingModelsMediaAudio | Represents a music recording (usually a song). Each populated field can be thought of as additional constraint about the song’s identity. For instance, if no fields are set, then this represents “some song.” If only the music_artist is set, then it represents “some song by the specified music_artist.” Inspired (but not strictly adhered to) http://schema.org/MusicRecording Next ID: 22 | list(String) |
| tvShow | Soundtrack or theme song (see score_type param that indicates whether the user refers to a soundtrack or a theme song) of the tv show. E.g. “Play soundtrack from (Friends)”. | NlpSemanticParsingModelsMediaAudio | Represents a music recording (usually a song). Each populated field can be thought of as additional constraint about the song’s identity. For instance, if no fields are set, then this represents “some song.” If only the music_artist is set, then it represents “some song by the specified music_artist.” Inspired (but not strictly adhered to) http://schema.org/MusicRecording Next ID: 22 | NlpSemanticParsingModelsMediaTVShow |
| audiobookMid | The MID of the audiobook entity (/book/book_edition). | NlpSemanticParsingModelsMediaAudiobookInfo | Metadata for an audiobook. | String |
| authors | NlpSemanticParsingModelsMediaAudiobookInfo | Metadata for an audiobook. | list(String) | |
| bookMid | The MID of the book entity (/book/book) which this audiobook is associated with. | NlpSemanticParsingModelsMediaAudiobookInfo | Metadata for an audiobook. | String |
| narrators | NlpSemanticParsingModelsMediaAudiobookInfo | Metadata for an audiobook. | list(String) | |
| annotationList | Annotations from custom media annotator. | NlpSemanticParsingModelsMediaBook | Example: “East of Eden” | NlpSemanticParsingModelsMediaMediaAnnotationList |
| evalData | Required, but should only be used inside Aqua and must not be used by outside clients!! | NlpSemanticParsingModelsMediaBook | Example: “East of Eden” | NlpSemanticParsingAnnotationEvalData |
| isAnnotatedFromText | Annotation comes from a text annotator. Needed to boost recall. Typically need to be verified in superroot, and have separate scoring. | NlpSemanticParsingModelsMediaBook | Example: “East of Eden” | boolean |
| latest | If true, indicates the user wants the latest book. Like, [play Dan Brown’s latest book] | NlpSemanticParsingModelsMediaBook | Example: “East of Eden” | boolean |
| qref | NlpSemanticParsingModelsMediaBook | Example: “East of Eden” | NlpSemanticParsingQRefAnnotation | |
| rawText | Required, corresponds to the raw text, like “East of Eden” | NlpSemanticParsingModelsMediaBook | Example: “East of Eden” | String |
| castDeviceSource | NlpSemanticParsingModelsMediaCastDeviceAnnotation | Media device. Like, Chromecast, TV or Chirp. When emitted from the cast_device domain, you should expect it to be one of 3 different forms: 1) Personal Device: The annotation comes from a device we found in the user’s home. device_id and name should be set, cast_device_type is set if device type is mentioned in query. e.g. “Dima’s Pineapple Chirp” device_id: FOOBAR name: “Dima’s Pineapple” cast_device_type: CHIRP 2) Common Device Name: The annotation comes from a model of the common names of user’s device. name and cast_device_type should be set but device_id will not be. cast_device_type can be UNKNOWN. e.g. “John’s Living Room” name: “John’s Living Room” cast_device_type: UNKNOWN 3) Device Type: The annotation comes from a model of common cast device types. Only cast_device_type will be set. e.g. “TV” or “chromecast” cast_device_type: CHROMECAST Next ID: 9 | String | |
| castDeviceType | This field is populated when the user says [play X on $cast_device] and we know the type of $cast_device but cannot identify the exact device. | NlpSemanticParsingModelsMediaCastDeviceAnnotation | Media device. Like, Chromecast, TV or Chirp. When emitted from the cast_device domain, you should expect it to be one of 3 different forms: 1) Personal Device: The annotation comes from a device we found in the user’s home. device_id and name should be set, cast_device_type is set if device type is mentioned in query. e.g. “Dima’s Pineapple Chirp” device_id: FOOBAR name: “Dima’s Pineapple” cast_device_type: CHIRP 2) Common Device Name: The annotation comes from a model of the common names of user’s device. name and cast_device_type should be set but device_id will not be. cast_device_type can be UNKNOWN. e.g. “John’s Living Room” name: “John’s Living Room” cast_device_type: UNKNOWN 3) Device Type: The annotation comes from a model of common cast device types. Only cast_device_type will be set. e.g. “TV” or “chromecast” cast_device_type: CHROMECAST Next ID: 9 | String |
| creationTimestampMs | The timestamp that the device is linked with the user in milliseconds. This is inherited from the corresponding assistant DeviceSettings as is. | NlpSemanticParsingModelsMediaCastDeviceAnnotation | Media device. Like, Chromecast, TV or Chirp. When emitted from the cast_device domain, you should expect it to be one of 3 different forms: 1) Personal Device: The annotation comes from a device we found in the user’s home. device_id and name should be set, cast_device_type is set if device type is mentioned in query. e.g. “Dima’s Pineapple Chirp” device_id: FOOBAR name: “Dima’s Pineapple” cast_device_type: CHIRP 2) Common Device Name: The annotation comes from a model of the common names of user’s device. name and cast_device_type should be set but device_id will not be. cast_device_type can be UNKNOWN. e.g. “John’s Living Room” name: “John’s Living Room” cast_device_type: UNKNOWN 3) Device Type: The annotation comes from a model of common cast device types. Only cast_device_type will be set. e.g. “TV” or “chromecast” cast_device_type: CHROMECAST Next ID: 9 | String |
| deviceId | DEPRECATED: Please use device_identifier instead. | NlpSemanticParsingModelsMediaCastDeviceAnnotation | Media device. Like, Chromecast, TV or Chirp. When emitted from the cast_device domain, you should expect it to be one of 3 different forms: 1) Personal Device: The annotation comes from a device we found in the user’s home. device_id and name should be set, cast_device_type is set if device type is mentioned in query. e.g. “Dima’s Pineapple Chirp” device_id: FOOBAR name: “Dima’s Pineapple” cast_device_type: CHIRP 2) Common Device Name: The annotation comes from a model of the common names of user’s device. name and cast_device_type should be set but device_id will not be. cast_device_type can be UNKNOWN. e.g. “John’s Living Room” name: “John’s Living Room” cast_device_type: UNKNOWN 3) Device Type: The annotation comes from a model of common cast device types. Only cast_device_type will be set. e.g. “TV” or “chromecast” cast_device_type: CHROMECAST Next ID: 9 | String |
| deviceIdentifier | The identification of the device. This field is populated when the user says [play X on $device_name] and $device_name matches one of the devices linked to user’s account. } oneof Media Device | NlpSemanticParsingModelsMediaCastDeviceAnnotation | Media device. Like, Chromecast, TV or Chirp. When emitted from the cast_device domain, you should expect it to be one of 3 different forms: 1) Personal Device: The annotation comes from a device we found in the user’s home. device_id and name should be set, cast_device_type is set if device type is mentioned in query. e.g. “Dima’s Pineapple Chirp” device_id: FOOBAR name: “Dima’s Pineapple” cast_device_type: CHIRP 2) Common Device Name: The annotation comes from a model of the common names of user’s device. name and cast_device_type should be set but device_id will not be. cast_device_type can be UNKNOWN. e.g. “John’s Living Room” name: “John’s Living Room” cast_device_type: UNKNOWN 3) Device Type: The annotation comes from a model of common cast device types. Only cast_device_type will be set. e.g. “TV” or “chromecast” cast_device_type: CHROMECAST Next ID: 9 | AssistantApiCoreTypesDeviceId |
| name | NlpSemanticParsingModelsMediaCastDeviceAnnotation | Media device. Like, Chromecast, TV or Chirp. When emitted from the cast_device domain, you should expect it to be one of 3 different forms: 1) Personal Device: The annotation comes from a device we found in the user’s home. device_id and name should be set, cast_device_type is set if device type is mentioned in query. e.g. “Dima’s Pineapple Chirp” device_id: FOOBAR name: “Dima’s Pineapple” cast_device_type: CHIRP 2) Common Device Name: The annotation comes from a model of the common names of user’s device. name and cast_device_type should be set but device_id will not be. cast_device_type can be UNKNOWN. e.g. “John’s Living Room” name: “John’s Living Room” cast_device_type: UNKNOWN 3) Device Type: The annotation comes from a model of common cast device types. Only cast_device_type will be set. e.g. “TV” or “chromecast” cast_device_type: CHROMECAST Next ID: 9 | String | |
| quantification | This field is populated when the user metioned quantification in the query. E.g., “2” or “all”. | NlpSemanticParsingModelsMediaCastDeviceAnnotation | Media device. Like, Chromecast, TV or Chirp. When emitted from the cast_device domain, you should expect it to be one of 3 different forms: 1) Personal Device: The annotation comes from a device we found in the user’s home. device_id and name should be set, cast_device_type is set if device type is mentioned in query. e.g. “Dima’s Pineapple Chirp” device_id: FOOBAR name: “Dima’s Pineapple” cast_device_type: CHIRP 2) Common Device Name: The annotation comes from a model of the common names of user’s device. name and cast_device_type should be set but device_id will not be. cast_device_type can be UNKNOWN. e.g. “John’s Living Room” name: “John’s Living Room” cast_device_type: UNKNOWN 3) Device Type: The annotation comes from a model of common cast device types. Only cast_device_type will be set. e.g. “TV” or “chromecast” cast_device_type: CHROMECAST Next ID: 9 | NlpSemanticParsingModelsMediaQuantification |
| currencyCode | Contains the standard code for the given type of currency. The value must represent a valid i18n_identifiers::CurrencyCode. | NlpSemanticParsingModelsMediaCost | Represents a localized price. Next ID: 3 | String |
| price | Contains the price in a particular currency. | NlpSemanticParsingModelsMediaCost | Represents a localized price. Next ID: 3 | float |
| actionType | The type of the deeplink. Sometimes the deeplink is not only used for playing media, but also used for other actions. For example, the deeplink could be for playing a movie trailer from YouTube or recording a movie from YouTube TV. | NlpSemanticParsingModelsMediaDeeplinkInfo | Provider deeplink and associated metadata, in particular restrictions on platform and user’s subscription. Next ID: 18 | String |
| blacklistedCountry | The upper-case, III country code, e.g., “US”, in which the deeplink cannot play. For possible values, see: google3/i18n/identifiers/regioncode.h google3/java/com/google/i18n/identifiers/RegionCode.java For details on converting to and from ISO country codes, see http://iii-howto#GettingCanonRegionCodes. | NlpSemanticParsingModelsMediaDeeplinkInfo | Provider deeplink and associated metadata, in particular restrictions on platform and user’s subscription. Next ID: 18 | list(String) |
| country | The upper-case, III country code, e.g., “US”, in which the deeplink can play. If unset or has “earth” (b/72566951), means the deeplink can be used world-wide except in |blacklisted_country| list. For possible values, see: google3/i18n/identifiers/regioncode.h google3/java/com/google/i18n/identifiers/RegionCode.java For details on converting to and from ISO country codes, see http://iii-howto#GettingCanonRegionCodes. | NlpSemanticParsingModelsMediaDeeplinkInfo | Provider deeplink and associated metadata, in particular restrictions on platform and user’s subscription. Next ID: 18 | list(String) |
| deeplink | Deeplink to the media. This deeplink is meant to be send to the provider app on available platforms without any modifications. Required. | NlpSemanticParsingModelsMediaDeeplinkInfo | Provider deeplink and associated metadata, in particular restrictions on platform and user’s subscription. Next ID: 18 | String |
| deeplinkForExecution | Some providers give us an opaque, unstable deeplink to use at execution-time. E.g. see http://go/collab-ranking-nl-uri#heading=h.ndmdfw388tk3 Such a deeplink is not useful for logging, caching, comparing to other candidate deeplinks, etc. So most fulfillment code will want the traditional, stable deeplink that can be interpreted, parsed, cached, etc (found in the “deeplink” field, above). But this opaque, unstable deeplink (if non-empty) must be included in the music initiation clientop. | NlpSemanticParsingModelsMediaDeeplinkInfo | Provider deeplink and associated metadata, in particular restrictions on platform and user’s subscription. Next ID: 18 | String |
| incompatibleWithCredentials | Indicate whether the deeplink is compatible with credentials. If true, CCS will not send the credentials to cast app. Currently this field is only used for voice-follow on cases on smart displays. | NlpSemanticParsingModelsMediaDeeplinkInfo | Provider deeplink and associated metadata, in particular restrictions on platform and user’s subscription. Next ID: 18 | boolean |
| offer | List of offers that allow user to access the deeplink, that is if the list contains PREMIUM_SUBSCRIPTION and BASIC_SUBSCRIPTION users that have either premium or basic subscription can use the deeplink. If the list is empty it means that there are no subscription restrictions. | NlpSemanticParsingModelsMediaDeeplinkInfo | Provider deeplink and associated metadata, in particular restrictions on platform and user’s subscription. Next ID: 18 | list(String) |
| paidOfferDetail | This field is only used when “offer” includes a PAY_PER_USE. When “offer” includes a PAY_PER_USE, paid_offer_detail will contain offers for BUY and RENT offer_types with associated cost info. | NlpSemanticParsingModelsMediaDeeplinkInfo | Provider deeplink and associated metadata, in particular restrictions on platform and user’s subscription. Next ID: 18 | list(NlpSemanticParsingModelsMediaPaidOfferDetail) |
| platform | List of platforms that support the deeplink. If the list is empty it means that there are no platform restrictions. | NlpSemanticParsingModelsMediaDeeplinkInfo | Provider deeplink and associated metadata, in particular restrictions on platform and user’s subscription. Next ID: 18 | list(String) |
| score | Document scores which are used for ranking action links. Document scores might come from CDOC in Raffia or other indexing systems. For example, for web pages, the score shows how likely the web page (composite doc) which generated this link refers to the given entity or how close a particular entity is with the given composite doc. For the larger design, please see go/ma_dedup. For PACIFIC_COLLAB_RANKING deeplink, the score is the normalized confidence score returned by partner for fulfillment candidate. For pivot candidates, the score is calculated with the index of the alternative results. | NlpSemanticParsingModelsMediaDeeplinkInfo | Provider deeplink and associated metadata, in particular restrictions on platform and user’s subscription. Next ID: 18 | float |
| subscriptionPackageName | Name of subscription packages which are granted access to this deeplink. This is to match exactly the end users authentication system. This is to be used if the offer is BASIC_SUBSCRIPTION or PREMIUM_SUBSCRIPTION. There can be multiple packages — the user needs only to authenticate with a single package. For more information please see: go/subscription-package | NlpSemanticParsingModelsMediaDeeplinkInfo | Provider deeplink and associated metadata, in particular restrictions on platform and user’s subscription. Next ID: 18 | list(String) |
| tag | Tags associated with the content played by this deeplink. In the common case, the deeplink is supposed to specify a music entity within the provider’s inventory, and the provider app should decide the actual content based on the user’s account profile (e.g., for a deeplink to an artist, playing tracks from the artist or similar artists, and for a song, playing the official album recording of the song). But in some cases, the deeplink belong to special content. For example, for an artist a seed radio based on the artist, and a live or karaoke version of a song. We use this field to mark such special content types. | NlpSemanticParsingModelsMediaDeeplinkInfo | Provider deeplink and associated metadata, in particular restrictions on platform and user’s subscription. Next ID: 18 | list(String) |
| validTimeWindow | A time window in which the deeplink is valid. If not set, the deeplink is considered valid. | NlpSemanticParsingModelsMediaDeeplinkInfo | Provider deeplink and associated metadata, in particular restrictions on platform and user’s subscription. Next ID: 18 | NlpSemanticParsingModelsMediaDeeplinkInfoTimeWindow |
| vuiId | DEPRECATED: This field is ignored by understanding and fulfillment. | NlpSemanticParsingModelsMediaDeeplinkInfo | Provider deeplink and associated metadata, in particular restrictions on platform and user’s subscription. Next ID: 18 | String |
| youtubeDeeplinkInfo | Additional info specific to YouTube Deeplink (if applicable). | NlpSemanticParsingModelsMediaDeeplinkInfo | Provider deeplink and associated metadata, in particular restrictions on platform and user’s subscription. Next ID: 18 | NlpSemanticParsingModelsMediaYouTubeDeeplinkInfo |
| endTimestamp | Time in seconds since epoch. | NlpSemanticParsingModelsMediaDeeplinkInfoTimeWindow | Represents a time window expressed as a time range. | String |
| startTimestamp | Time in seconds since epoch. | NlpSemanticParsingModelsMediaDeeplinkInfoTimeWindow | Represents a time window expressed as a time range. | String |
| evalData | Required, but should only be used inside Aqua and must not be used by outside clients!! | NlpSemanticParsingModelsMediaDescription | Example: “the episode with all of the comedians”. A free-form text description of a media. | NlpSemanticParsingAnnotationEvalData |
| rawText | NlpSemanticParsingModelsMediaDescription | Example: “the episode with all of the comedians”. A free-form text description of a media. | String | |
| absoluteIndex | The absolute index of the episode. 1 is the first element and -1 is the last element in the sequence, -2 is the second-to-last element, and so on. Examples: “first episode” => 1 “3rd episode” => 3 “last episode” => -1 | NlpSemanticParsingModelsMediaEpisodeConstraint | Example: “latest” would constrain the episode to a certain ordinal. | integer |
| dateTime | Date/time of the message. This could be an absolute date/time (e.g. find my message from monday) or a date/time range (e.g. find my message in the past four hours). This constrains *when* the episode came out. | NlpSemanticParsingModelsMediaEpisodeConstraint | Example: “latest” would constrain the episode to a certain ordinal. | NlpSemanticParsingDatetimeDateTime |
| description | A description of the episode. Example: For the query: [listen to this american life about cars] the description would be “cars” | NlpSemanticParsingModelsMediaEpisodeConstraint | Example: “latest” would constrain the episode to a certain ordinal. | NlpSemanticParsingModelsMediaDescription |
| evalData | Required, but should only be used inside Aqua and must not be used by outside clients!! | NlpSemanticParsingModelsMediaEpisodeConstraint | Example: “latest” would constrain the episode to a certain ordinal. | NlpSemanticParsingAnnotationEvalData |
| rawText | NlpSemanticParsingModelsMediaEpisodeConstraint | Example: “latest” would constrain the episode to a certain ordinal. | String | |
| relativeIndex | The relative index of the episode. Examples: “previous episode” => -1 “current episode” => 0 “next episode” => 1 | NlpSemanticParsingModelsMediaEpisodeConstraint | Example: “latest” would constrain the episode to a certain ordinal. | integer |
| band | The broadcast band used by the radio station. | NlpSemanticParsingModelsMediaFrequency | Defines a frequency for a terrestrial radio station. For instance, 99.1 FM, 730 AM, etc. Next ID: 4 | String |
| value | Frequency in MHz (for FM) and KHz (for AM). | NlpSemanticParsingModelsMediaFrequency | Defines a frequency for a terrestrial radio station. For instance, 99.1 FM, 730 AM, etc. Next ID: 4 | float |
| evalData | Required, but should only be used inside Aqua and must not be used by outside clients!! | NlpSemanticParsingModelsMediaGame | Example: “Deus Ex Human Revolution” | NlpSemanticParsingAnnotationEvalData |
| isAnnotatedFromText | Annotation comes from a text annotator. Needed to boost recall. Typically need to be verified in superroot, and have separate scoring. | NlpSemanticParsingModelsMediaGame | Example: “Deus Ex Human Revolution” | boolean |
| qref | NlpSemanticParsingModelsMediaGame | Example: “Deus Ex Human Revolution” | NlpSemanticParsingQRefAnnotation | |
| rawText | Required, corresponds to the raw text, like “Deus Ex Human Revolution” | NlpSemanticParsingModelsMediaGame | Example: “Deus Ex Human Revolution” | String |
| annotationList | Annotations from custom media annotator. Deprecated – generic music deeplinks should be added to the Provider config, not to the grammar. | NlpSemanticParsingModelsMediaGenericMusic | Example: “my library”, “some music”. | NlpSemanticParsingModelsMediaMediaAnnotationList |
| evalData | Required, but should only be used inside Aqua and must not be used by outside clients!! | NlpSemanticParsingModelsMediaGenericMusic | Example: “my library”, “some music”. | NlpSemanticParsingAnnotationEvalData |
| newMusic | New music. | NlpSemanticParsingModelsMediaGenericMusic | Example: “my library”, “some music”. | boolean |
| rawText | Required, corresponds to the raw text, like “my tracks” | NlpSemanticParsingModelsMediaGenericMusic | Example: “my library”, “some music”. | String |
| type | NlpSemanticParsingModelsMediaGenericMusic | Example: “my library”, “some music”. | String | |
| latitude | The latitude in degrees. It must be in the range [-90.0, +90.0]. | NlpSemanticParsingModelsMediaLatLng | An object representing a latitude/longitude pair. More info in https://cs.corp.google.com/piper///depot/google3/google/type/latlng.proto | float |
| longitude | The longitude in degrees. It must be in the range [-180.0, +180.0]. | NlpSemanticParsingModelsMediaLatLng | An object representing a latitude/longitude pair. More info in https://cs.corp.google.com/piper///depot/google3/google/type/latlng.proto | float |
| artistName | Name of the artist (if applicable). Used for songs and albums. | NlpSemanticParsingModelsMediaMediaAnnotation | Annotation for media entities. Next ID: 17 | String |
| audiobookInfo | Additional info specific to an audiobook (if applicable). | NlpSemanticParsingModelsMediaMediaAnnotation | Annotation for media entities. Next ID: 17 | NlpSemanticParsingModelsMediaAudiobookInfo |
| contentType | Type of the media content. This field is not always populated, but only when this annotation is used to represent an individual media item, e.g., when it is the value of an intent argument storing a media object to play. | NlpSemanticParsingModelsMediaMediaAnnotation | Annotation for media entities. Next ID: 17 | String |
| image | Images of the media. | NlpSemanticParsingModelsMediaMediaAnnotation | Annotation for media entities. Next ID: 17 | list(AssistantApiCoreTypesImage) |
| name | Name of the media. Required. | NlpSemanticParsingModelsMediaMediaAnnotation | Annotation for media entities. Next ID: 17 | String |
| newsInfo | Additional info specific to a news audio/video stream (if applicable). | NlpSemanticParsingModelsMediaMediaAnnotation | Annotation for media entities. Next ID: 17 | NlpSemanticParsingModelsMediaNewsInfo |
| personalDataIngestionEngine | The personal ingestion engine. | NlpSemanticParsingModelsMediaMediaAnnotation | Annotation for media entities. Next ID: 17 | String |
| playlistVisibility | Visibility setting of the retrieved playlist. | NlpSemanticParsingModelsMediaMediaAnnotation | Annotation for media entities. Next ID: 17 | String |
| podcastInfo | Additional info specific to podcast stream (if applicable). | NlpSemanticParsingModelsMediaMediaAnnotation | Annotation for media entities. Next ID: 17 | NlpSemanticParsingModelsMediaPodcastInfo |
| primaryEntityMid | NlpSemanticParsingModelsMediaMediaAnnotation | Annotation for media entities. Next ID: 17 | String | |
| providerInfo | List of providers and their deeplinks. | NlpSemanticParsingModelsMediaMediaAnnotation | Annotation for media entities. Next ID: 17 | list(NlpSemanticParsingModelsMediaMediaProviderInfo) |
| purchaseInfo | Purchase info for purchased or preordered movies, episodes, seasons, tv shows. | NlpSemanticParsingModelsMediaMediaAnnotation | Annotation for media entities. Next ID: 17 | NlpSemanticParsingModelsMediaPurchaseInfo |
| radioInfo | Only one of these fields should be set depending on the type of the content. oneof content_specific_info { Additional info specific to a radio station (if applicable). | NlpSemanticParsingModelsMediaMediaAnnotation | Annotation for media entities. Next ID: 17 | NlpSemanticParsingModelsMediaRadioInfo |
| rentalInfo | Rental info for rented movies. | NlpSemanticParsingModelsMediaMediaAnnotation | Annotation for media entities. Next ID: 17 | NlpSemanticParsingModelsMediaRentalInfo |
| source | NlpSemanticParsingModelsMediaMediaAnnotation | Annotation for media entities. Next ID: 17 | String | |
| youtubePlaylistInfo | Additional info specific to YouTube playlist (if applicable). | NlpSemanticParsingModelsMediaMediaAnnotation | Annotation for media entities. Next ID: 17 | NlpSemanticParsingModelsMediaYouTubePlaylistInfo |
| annotation | NlpSemanticParsingModelsMediaMediaAnnotationList | List of MediaAnnotation. Media annotators should use the MediaAnnotationList to annotate spans instead of MediaAnnotation. This prevents exponential explosion of interpretations (consider [play $song by $artist on $device]) and allows us to have simpler tests for grammar. | list(NlpSemanticParsingModelsMediaMediaAnnotation) | |
| deeplinkInfo | Deeplinks provided by the provider. If empty it indicates that the media is unavailable with the provider, e.g. due to country restrictions or limited catalog. | NlpSemanticParsingModelsMediaMediaProviderInfo | A media provider and the deeplinks provided by the provider. MediaProviderInfo is an abstraction for topics of multiple media related KG types under /base/mediaasset domain and /media_common. It’s often eligible for topics of media related KG types like /broadcast/radio_station, /film/film, /music/artist, /music/album, /music/recording_cluster, /music/recording, /tv/tv_program, etc. See go/media-pq for design details. Next ID: 6 | list(NlpSemanticParsingModelsMediaDeeplinkInfo) |
| kgProviderKey | The unique and reverse unique provider enumerator in KG (e.g., “ORANGE_SPAIN” for /g/11h6nkfyrm). It is more stable than the KG mid. See go/kema-api#keys. Some mids cannot have the enumerator property due to historical reason (e.g., multiple media providers were created for iTunes and only “”/g/11fhyxjwt5” has provider enumerator as “ITUNES_NEW” in KG). These entities need to have hard-coded key (e.g., “/m/019g58” has key “ITUNES”) kept outside of KG. | NlpSemanticParsingModelsMediaMediaProviderInfo | A media provider and the deeplinks provided by the provider. MediaProviderInfo is an abstraction for topics of multiple media related KG types under /base/mediaasset domain and /media_common. It’s often eligible for topics of media related KG types like /broadcast/radio_station, /film/film, /music/artist, /music/album, /music/recording_cluster, /music/recording, /tv/tv_program, etc. See go/media-pq for design details. Next ID: 6 | String |
| mediaId | Media ID of a MediaItem in a MediaBrowseTree (MBT). This field is used to play a specific media item from MBT using playFromMediaId API. | NlpSemanticParsingModelsMediaMediaProviderInfo | A media provider and the deeplinks provided by the provider. MediaProviderInfo is an abstraction for topics of multiple media related KG types under /base/mediaasset domain and /media_common. It’s often eligible for topics of media related KG types like /broadcast/radio_station, /film/film, /music/artist, /music/album, /music/recording_cluster, /music/recording, /tv/tv_program, etc. See go/media-pq for design details. Next ID: 6 | String |
| providerMid | The machine ID (MID) of the media provider. | NlpSemanticParsingModelsMediaMediaProviderInfo | A media provider and the deeplinks provided by the provider. MediaProviderInfo is an abstraction for topics of multiple media related KG types under /base/mediaasset domain and /media_common. It’s often eligible for topics of media related KG types like /broadcast/radio_station, /film/film, /music/artist, /music/album, /music/recording_cluster, /music/recording, /tv/tv_program, etc. See go/media-pq for design details. Next ID: 6 | String |
| providerName | The name of the media provider. | NlpSemanticParsingModelsMediaMediaProviderInfo | A media provider and the deeplinks provided by the provider. MediaProviderInfo is an abstraction for topics of multiple media related KG types under /base/mediaasset domain and /media_common. It’s often eligible for topics of media related KG types like /broadcast/radio_station, /film/film, /music/artist, /music/album, /music/recording_cluster, /music/recording, /tv/tv_program, etc. See go/media-pq for design details. Next ID: 6 | String |
| annotationList | Annotations from custom media annotator. | NlpSemanticParsingModelsMediaMovie | Example: “Casablanca” | NlpSemanticParsingModelsMediaMediaAnnotationList |
| evalData | Required, but should only be used inside Aqua and must not be used by outside clients!! | NlpSemanticParsingModelsMediaMovie | Example: “Casablanca” | NlpSemanticParsingAnnotationEvalData |
| isAnnotatedFromText | Annotation comes from a text annotator. Needed to boost recall. Typically need to be verified in superroot, and have separate scoring. | NlpSemanticParsingModelsMediaMovie | Example: “Casablanca” | boolean |
| isFromFastPath | Is annotated by Nimble for the media Fast Path. | NlpSemanticParsingModelsMediaMovie | Example: “Casablanca” | boolean |
| providerMetadata | NlpSemanticParsingModelsMediaMovie | Example: “Casablanca” | list(NlpSemanticParsingModelsMediaProviderMetadata) | |
| qref | NlpSemanticParsingModelsMediaMovie | Example: “Casablanca” | NlpSemanticParsingQRefAnnotation | |
| rawText | Required, corresponds to the raw text, like “Casablanca” | NlpSemanticParsingModelsMediaMovie | Example: “Casablanca” | String |
| annotationList | Annotations from custom media annotator. | NlpSemanticParsingModelsMediaMusicArtist | Example: “The Beatles” | NlpSemanticParsingModelsMediaMediaAnnotationList |
| evalData | Required, but should only be used inside Aqua and must not be used by outside clients!! | NlpSemanticParsingModelsMediaMusicArtist | Example: “The Beatles” | NlpSemanticParsingAnnotationEvalData |
| favorite | If true, indicates the user wants their favorite album. Like [play my favorite album my Eminem] | NlpSemanticParsingModelsMediaMusicArtist | Example: “The Beatles” | boolean |
| isFromFastPath | Is annotated by Nimble for the media Fast Path. | NlpSemanticParsingModelsMediaMusicArtist | Example: “The Beatles” | boolean |
| playMore | More from this artist. | NlpSemanticParsingModelsMediaMusicArtist | Example: “The Beatles” | boolean |
| qref | NlpSemanticParsingModelsMediaMusicArtist | Example: “The Beatles” | NlpSemanticParsingQRefAnnotation | |
| rawText | Required, corresponds to the raw text, like “The Beatles” | NlpSemanticParsingModelsMediaMusicArtist | Example: “The Beatles” | String |
| annotationList | Annotations from custom media annotator. | NlpSemanticParsingModelsMediaMusicGenre | Example: “British Invasion” | NlpSemanticParsingModelsMediaMediaAnnotationList |
| evalData | Required, but should only be used inside Aqua and must not be used by outside clients!! | NlpSemanticParsingModelsMediaMusicGenre | Example: “British Invasion” | NlpSemanticParsingAnnotationEvalData |
| playMore | More from this genre. | NlpSemanticParsingModelsMediaMusicGenre | Example: “British Invasion” | boolean |
| qref | NlpSemanticParsingModelsMediaMusicGenre | Example: “British Invasion” | NlpSemanticParsingQRefAnnotation | |
| rawText | Required, corresponds to the raw text, like “British Invasion” | NlpSemanticParsingModelsMediaMusicGenre | Example: “British Invasion” | String |
| annotationList | Annotations from custom media annotator. | NlpSemanticParsingModelsMediaMusicPlaylist | Example: “gym playlist” | NlpSemanticParsingModelsMediaMediaAnnotationList |
| evalData | Required, but should only be used inside Aqua and must not be used by outside clients!! | NlpSemanticParsingModelsMediaMusicPlaylist | Example: “gym playlist” | NlpSemanticParsingAnnotationEvalData |
| isAnnotatedFromText | Annotation comes from a text annotator. Needed to boost recall. Typically need to be verified in superroot, and have separate scoring. | NlpSemanticParsingModelsMediaMusicPlaylist | Example: “gym playlist” | boolean |
| longtailMood | If the model is confident that this is a bizarre long-tail mood-based playlist, it can send a signal to downstream systems (that might do things like generate random music) Example: * [play music for brushing my teeth with the lights off on tuesday] This is pretty much an ‘easter egg’ — it is not critical. | NlpSemanticParsingModelsMediaMusicPlaylist | Example: “gym playlist” | boolean |
| normalizedText | Optional, some canonical name for the playlist. | NlpSemanticParsingModelsMediaMusicPlaylist | Example: “gym playlist” | String |
| qref | Needed for proto conformance in Semantic Parsing. | NlpSemanticParsingModelsMediaMusicPlaylist | Example: “gym playlist” | NlpSemanticParsingQRefAnnotation |
| rawText | Required, corresponds to the raw text, like “80s remix” (tokenized) | NlpSemanticParsingModelsMediaMusicPlaylist | Example: “gym playlist” | String |
| special | NlpSemanticParsingModelsMediaMusicPlaylist | Example: “gym playlist” | String | |
| docid | The docid of the news result from News360 backend. | NlpSemanticParsingModelsMediaNewsInfo | String | |
| newsContentType | Indicates how the type of the news result. | NlpSemanticParsingModelsMediaNewsInfo | String | |
| publicationTime | Publication time of the news, in seconds (unix epoch). | NlpSemanticParsingModelsMediaNewsInfo | AssistantApiTimestamp | |
| publisher | The publisher of the news. | NlpSemanticParsingModelsMediaNewsInfo | String | |
| evalData | Required, but should only be used inside Aqua and must not be used by outside clients!! | NlpSemanticParsingModelsMediaNewsTopic | Example: “ukraine” in a query like “read me news about Ukraine” | NlpSemanticParsingAnnotationEvalData |
| rawText | NlpSemanticParsingModelsMediaNewsTopic | Example: “ukraine” in a query like “read me news about Ukraine” | String | |
| cost | Represents the price of this offer according to the locale and region. | NlpSemanticParsingModelsMediaPaidOfferDetail | Represents BUY and RENT offers and associated cost info. Next ID: 3 | list(NlpSemanticParsingModelsMediaCost) |
| paidOfferType | Specifies the type of offer. | NlpSemanticParsingModelsMediaPaidOfferDetail | Represents BUY and RENT offers and associated cost info. Next ID: 3 | String |
| evalData | Required, but should only be used inside Aqua and must not be used by outside clients!! | NlpSemanticParsingModelsMediaPodcast | Example: “This American Life” | NlpSemanticParsingAnnotationEvalData |
| isAnnotatedFromText | Annotation comes from a text annotator. Needed to boost recall. Typically need to be verified in superroot, and have separate scoring. | NlpSemanticParsingModelsMediaPodcast | Example: “This American Life” | boolean |
| normalizedText | Optional, some canonical name for the playlist. | NlpSemanticParsingModelsMediaPodcast | Example: “This American Life” | String |
| qref | NlpSemanticParsingModelsMediaPodcast | Example: “This American Life” | NlpSemanticParsingQRefAnnotation | |
| rawText | Required, corresponds to the raw text, like “this american life” | NlpSemanticParsingModelsMediaPodcast | Example: “This American Life” | String |
| clusterId | An internal identifier for the wernicke database that identifies a cluster of multiple sources for a particular podcast. | NlpSemanticParsingModelsMediaPodcastInfo | String | |
| episodeGuid | GUID of the given podcast episode. | NlpSemanticParsingModelsMediaPodcastInfo | String | |
| feedUrl | The url for the rss feed providing this podcast. | NlpSemanticParsingModelsMediaPodcastInfo | String | |
| podcastRecsFeatures | Podcast recommendations features. These features are used to train models for reranking podcast recommendations. Full list of features: http://shortn/_bg6NvzYs6F This won’t be sent to clients. It will only be annotated for crust results | NlpSemanticParsingModelsMediaPodcastInfo | SuperrootPodcastsRecommendationsPodcastRecsFeatures | |
| title | NlpSemanticParsingModelsMediaPodcastInfo | String | ||
| deeplinkUrl | URL like https://www.netflix.com/title/70305883 — this is used as a deeplink to play the video. | NlpSemanticParsingModelsMediaProviderMetadata | Provider metadata associated with video. | String |
| providerMid | Provider MID. | NlpSemanticParsingModelsMediaProviderMetadata | Provider metadata associated with video. | String |
| orderType | NlpSemanticParsingModelsMediaPurchaseInfo | String | ||
| purchaseTimestampSec | The time at which the item is purchased. | NlpSemanticParsingModelsMediaPurchaseInfo | String | |
| lexical | NlpSemanticParsingModelsMediaQuantification | The quantification of device(s) in the query. For example, “three speakers”, “all TVs”, etc. Usually, we should have either lexical field or number field. However, there are some special words which we will set both fields. For example, “all 3” will have the semantic: {lexical=ALL, number=3}. Note that “both” is simply modeled as {lexical=ALL}. | String | |
| number | Numerical quantification. E.g., “three speakers”. | NlpSemanticParsingModelsMediaQuantification | The quantification of device(s) in the query. For example, “three speakers”, “all TVs”, etc. Usually, we should have either lexical field or number field. However, there are some special words which we will set both fields. For example, “all 3” will have the semantic: {lexical=ALL, number=3}. Note that “both” is simply modeled as {lexical=ALL}. | integer |
| annotationList | Annotations from custom media annotator. | NlpSemanticParsingModelsMediaRadio | Example: “107.7 the bone” | NlpSemanticParsingModelsMediaMediaAnnotationList |
| evalData | Required, but should only be used inside Aqua and must not be used by outside clients!! | NlpSemanticParsingModelsMediaRadio | Example: “107.7 the bone” | NlpSemanticParsingAnnotationEvalData |
| favorite | If true, indicates the user wants their favorite radio station to be played. Ex: [play my favorites on radio] | NlpSemanticParsingModelsMediaRadio | Example: “107.7 the bone” | boolean |
| frequency | This proto may only be partially filled depending on the query. ## Some examples (all of them have open_intent): ## | Query |radio.raw_text|radio.frequency.band|radio.frequency.value| |[play kqed fm]| [kqed fm] | [fm] | N/A | |[play 88.5 fm]| [88.5 fm] | [fm] | 88.5 | | [play 88.5 | [88.5] | N/A | 88.5 | ## | [play fm] | [fm] | [fm] | N/A | | NlpSemanticParsingModelsMediaRadio | Example: “107.7 the bone” | NlpSemanticParsingModelsMediaFrequency |
| isAnnotatedFromText | Annotation comes from a text annotator. Needed to boost recall. Typically need to be verified in superroot, and have separate scoring. | NlpSemanticParsingModelsMediaRadio | Example: “107.7 the bone” | boolean |
| isFromFastPath | Is annotated by Nimble for the media Fast Path. | NlpSemanticParsingModelsMediaRadio | Example: “107.7 the bone” | boolean |
| qref | NlpSemanticParsingModelsMediaRadio | Example: “107.7 the bone” | NlpSemanticParsingQRefAnnotation | |
| rawText | Required, corresponds to the raw text, like “107.7” | NlpSemanticParsingModelsMediaRadio | Example: “107.7 the bone” | String |
| frequency | Frequency of the terrestrial radio station. | NlpSemanticParsingModelsMediaRadioInfo | Metadata for a radio station (both terrestrial and internet). Next ID: 4 | NlpSemanticParsingModelsMediaFrequency |
| location | Location of the radio station. | NlpSemanticParsingModelsMediaRadioInfo | Metadata for a radio station (both terrestrial and internet). Next ID: 4 | NlpSemanticParsingModelsMediaLatLng |
| popularity | Popularity of the radio station. This will be used in ranking of the radio stations. This value should be between 0 (least popular) and 5 (most popular). | NlpSemanticParsingModelsMediaRadioInfo | Metadata for a radio station (both terrestrial and internet). Next ID: 4 | float |
| annotationList | Annotations from custom media annotator. | NlpSemanticParsingModelsMediaRadioNetwork | Example: “npr”, “bbc”, etc. | NlpSemanticParsingModelsMediaMediaAnnotationList |
| evalData | Required, but should only be used inside Aqua and must not be used by outside clients!! | NlpSemanticParsingModelsMediaRadioNetwork | Example: “npr”, “bbc”, etc. | NlpSemanticParsingAnnotationEvalData |
| qref | NlpSemanticParsingModelsMediaRadioNetwork | Example: “npr”, “bbc”, etc. | NlpSemanticParsingQRefAnnotation | |
| rawText | Required, corresponds to the raw text, like “npr” | NlpSemanticParsingModelsMediaRadioNetwork | Example: “npr”, “bbc”, etc. | String |
| activatePeriodSec | Time period for users to continue watching. | NlpSemanticParsingModelsMediaRentalInfo | String | |
| grantPeriodSec | Time period for users to begin watching. | NlpSemanticParsingModelsMediaRentalInfo | String | |
| purchaseTimestampSec | The time at which the item is purchased. | NlpSemanticParsingModelsMediaRentalInfo | String | |
| validUntilTimestampSec | Time until which ownership is granted | NlpSemanticParsingModelsMediaRentalInfo | String | |
| absoluteIndex | The absolute index of the season. 1 is the first element and -1 is the last element in the sequence, -2 is the second-to-last element, and so on. Examples: “first season” => 1 “3rd season” => 3 “last season” => -1 | NlpSemanticParsingModelsMediaSeasonConstraint | Example: “season 2” of serial | integer |
| evalData | Required, but should only be used inside Aqua and must not be used by outside clients!! | NlpSemanticParsingModelsMediaSeasonConstraint | Example: “season 2” of serial | NlpSemanticParsingAnnotationEvalData |
| rawText | NlpSemanticParsingModelsMediaSeasonConstraint | Example: “season 2” of serial | String | |
| relativeIndex | The relative index of the season. Examples: “previous season” => -1 “current season” => 0 “next season” => 1 | NlpSemanticParsingModelsMediaSeasonConstraint | Example: “season 2” of serial | integer |
| annotationList | Annotations from custom media annotator. | NlpSemanticParsingModelsMediaSong | Example: “Hey Jude” | NlpSemanticParsingModelsMediaMediaAnnotationList |
| evalData | Required, but should only be used inside Aqua and must not be used by outside clients!! | NlpSemanticParsingModelsMediaSong | Example: “Hey Jude” | NlpSemanticParsingAnnotationEvalData |
| favorite | If true, indicates the user wants their favorite album. Like [play my favorite song] | NlpSemanticParsingModelsMediaSong | Example: “Hey Jude” | boolean |
| first | If true, indicates the user wants the first song. Like [play adele’s first song] | NlpSemanticParsingModelsMediaSong | Example: “Hey Jude” | boolean |
| isAnnotatedFromText | Annotation comes from a text annotator. Needed to boost recall. Typically need to be verified in superroot, and have separate scoring. | NlpSemanticParsingModelsMediaSong | Example: “Hey Jude” | boolean |
| isFromFastPath | Is annotated by Nimble for the media Fast Path. | NlpSemanticParsingModelsMediaSong | Example: “Hey Jude” | boolean |
| latest | If true, indicates the user wants the latest song. Like, [play adele’s latest song] | NlpSemanticParsingModelsMediaSong | Example: “Hey Jude” | boolean |
| qref | Optional, indicates this reference came from QRef. | NlpSemanticParsingModelsMediaSong | Example: “Hey Jude” | NlpSemanticParsingQRefAnnotation |
| rawText | Required, corresponds to the raw text, like “Hey Jude.” | NlpSemanticParsingModelsMediaSong | Example: “Hey Jude” | String |
| annotationList | Annotations from custom media annotator. | NlpSemanticParsingModelsMediaTVShow | Example: “Breaking Bad” | NlpSemanticParsingModelsMediaMediaAnnotationList |
| evalData | Required, but should only be used inside Aqua and must not be used by outside clients!! | NlpSemanticParsingModelsMediaTVShow | Example: “Breaking Bad” | NlpSemanticParsingAnnotationEvalData |
| isFromFastPath | Is annotated by Nimble for the media Fast Path. | NlpSemanticParsingModelsMediaTVShow | Example: “Breaking Bad” | boolean |
| providerMetadata | NlpSemanticParsingModelsMediaTVShow | Example: “Breaking Bad” | list(NlpSemanticParsingModelsMediaProviderMetadata) | |
| qref | NlpSemanticParsingModelsMediaTVShow | Example: “Breaking Bad” | NlpSemanticParsingQRefAnnotation | |
| rawText | Required, corresponds to the raw text, like “Breaking Bad” | NlpSemanticParsingModelsMediaTVShow | Example: “Breaking Bad” | String |
| clickTrackingId | See go/yt-clicktracking. Serialized youtube.api.innertube.InnerTubeClickTrackingProto. | NlpSemanticParsingModelsMediaYouTubeDeeplinkInfo | Provide the deeplink information specific to YouTube PMAs. Next ID: 3 | String |
| uploaderChannelId | For YouTube Channels, by default the deeplink is set to be the playlist of all uploads from the channel. This field is used for YouTube in-app browse when we need the YouTube channel’s main page url. We will use the uploader_channel_id to construct the needed channel deeplink. | NlpSemanticParsingModelsMediaYouTubeDeeplinkInfo | Provide the deeplink information specific to YouTube PMAs. Next ID: 3 | String |
| numVidsPlayableInWoodstock | Count of videos in the YouTube playlist that are playable in WoodStock. For performance reasons the maximum value this field can reach is capped, see: kMaxVideosPerPlaylistForSearchMetadata. | NlpSemanticParsingModelsMediaYouTubePlaylistInfo | String | |
| videoCount | Total number of videos present in the retrieved playlist. | NlpSemanticParsingModelsMediaYouTubePlaylistInfo | integer | |
| freebaseMid | KG Currency mid | NlpSemanticParsingModelsMoneyCurrency | String | |
| amount | NlpSemanticParsingModelsMoneyMoney | Represent a money quantity | NlpSemanticParsingNumberNumber | |
| currency | NlpSemanticParsingModelsMoneyMoney | Represent a money quantity | NlpSemanticParsingModelsMoneyCurrency | |
| data | Annotation data for the provider. | NlpSemanticParsingModelsNarrativeNewsNewsProvider | Corresponds to an entry in our hand-curated Nimble table of providers. | QualityActionsNewsProviderAnnotationData |
| evalData | Required, but should only be used inside Aqua and must not be used by outside clients!! | NlpSemanticParsingModelsNarrativeNewsNewsProvider | Corresponds to an entry in our hand-curated Nimble table of providers. | NlpSemanticParsingAnnotationEvalData |
| rawText | NlpSemanticParsingModelsNarrativeNewsNewsProvider | Corresponds to an entry in our hand-curated Nimble table of providers. | String | |
| device | The device(s) to perform an action. | NlpSemanticParsingModelsOnDevice | OnDevice describes the device(s) to perform an action. This message type can be imported in action messages as an argument. | list(NlpSemanticParsingModelsDevice) |
| alternativeNameInfo | Alternative names like “John” for “Joan”, with info such as RecognitionAlternateSource indicating where is it from. | NlpSemanticParsingModelsPersonPerson | list(QualityQrewriteAlternativeNameInfo) | |
| alternativeNames | Alternative names, e.g., names with similar pronunciation, Kathy and Cathy. | NlpSemanticParsingModelsPersonPerson | list(String) | |
| annotationSource | NlpSemanticParsingModelsPersonPerson | list(String) | ||
| contactData | Contact metadata. Only available for personal contact. | NlpSemanticParsingModelsPersonPerson | list(QualityQrewritePersonalContactData) | |
| evalData | Required, but should only be used inside Aqua. Must not be used by outside clients!! | NlpSemanticParsingModelsPersonPerson | NlpSemanticParsingAnnotationEvalData | |
| isPersonGroupReference | Indicates whether $Person is used for person-group reference. If true, then the PersonalContactData in repeated contact_data field probably correspond to a group of different persons, where $Person is used to represent family, kids, parents, etc. | NlpSemanticParsingModelsPersonPerson | boolean | |
| isPersonalContact | Whether the person is from personal contacts (e.g. Focus contacts or device contacts) or the person is constructed from a Gaia profile visible to the user (e.g. via Family Service). | NlpSemanticParsingModelsPersonPerson | boolean | |
| name | The name of the person without normalizations, preserves casing of the raw text, but removes possible prefix/suffix. For example: raw_text: “Mr. John” normalized_text: “john” name: “John” raw_text: “Tüll” normalized_text: “tuell” name: “Tüll” | NlpSemanticParsingModelsPersonPerson | String | |
| normalizedText | Normalized text produced by annotator. Some annotators generate a normalized version to help better match with contact list. | NlpSemanticParsingModelsPersonPerson | String | |
| pkgSemantics | Contains information about a Copley Person reference (go/copley-people). Note that this contains no information about the resolved people (e.g. names, phone numbers) but only about the user’s reference. Resolution metadata is stored in contact_data.pkg_person. | NlpSemanticParsingModelsPersonPerson | NlpSemanticParsingQRefAnnotation | |
| rawText | NlpSemanticParsingModelsPersonPerson | String | ||
| dailyPattern | Optional. Specifies when in the day the task should occur. Applies to all frequencies DAILY and greater. If absent, the repeating tasks are considered “all day” type. | NlpSemanticParsingModelsRecurrence | Recurrence rule for specifying date- and time-based repetition for tasks. Next id: 12. | NlpSemanticParsingModelsRecurrenceDailyPattern |
| evalData | This field of the Recurrence message should not in general be used by outside clients of the grammar. It is intended to be used internally in Aqua for evaluation purposes. The rationale is that token counts depend on the particular tokenization used in Aqua which may be different from the one used by the client and may change from time to time. Outside clients should not create a dependency on the current tokenization used in Aqua. | NlpSemanticParsingModelsRecurrence | Recurrence rule for specifying date- and time-based repetition for tasks. Next id: 12. | NlpSemanticParsingAnnotationEvalData |
| every | Multiplier on the frequency of the recurrence. Use this to specify patterns that recur every X days, months, years, etc. Example: [remind me to call mom every 2nd week]. Default is 1 (every day, every month, every year). Floating point numbers are understood and rounded to the nearest integer. E.g. “every 2.8 months” => (every 3) | NlpSemanticParsingModelsRecurrence | Recurrence rule for specifying date- and time-based repetition for tasks. Next id: 12. | integer |
| frequency | Required. The high-level frequency of the recurrence. | NlpSemanticParsingModelsRecurrence | Recurrence rule for specifying date- and time-based repetition for tasks. Next id: 12. | String |
| monthlyPattern | Specify a monthly recurrence. Valid and required for MONTHLY frequencies only. | NlpSemanticParsingModelsRecurrence | Recurrence rule for specifying date- and time-based repetition for tasks. Next id: 12. | NlpSemanticParsingModelsRecurrenceMonthlyPattern |
| numInstancesInFrequency | How many times the task should be repeated within the frequency interval. Floating point numbers are understood and rounded to the nearest integer. E.g. “3.8 times per week” => (num_instances_in_frequency 4) | NlpSemanticParsingModelsRecurrence | Recurrence rule for specifying date- and time-based repetition for tasks. Next id: 12. | integer |
| recurrenceEnd | Required. The end condition for the recurrence. | NlpSemanticParsingModelsRecurrence | Recurrence rule for specifying date- and time-based repetition for tasks. Next id: 12. | NlpSemanticParsingModelsRecurrenceRecurrenceEnd |
| recurrenceStart | Required. The start of the recurrence. | NlpSemanticParsingModelsRecurrence | Recurrence rule for specifying date- and time-based repetition for tasks. Next id: 12. | NlpSemanticParsingModelsRecurrenceRecurrenceStart |
| time | Optional time included with some types of recurrence phrases, such as “every morning”. | NlpSemanticParsingModelsRecurrence | Recurrence rule for specifying date- and time-based repetition for tasks. Next id: 12. | NlpSemanticParsingDatetimeDateTime |
| weeklyPattern | Specify a weekly recurrence. Valid and required for WEEKLY frequencies only. | NlpSemanticParsingModelsRecurrence | Recurrence rule for specifying date- and time-based repetition for tasks. Next id: 12. | NlpSemanticParsingModelsRecurrenceWeeklyPattern |
| yearlyPattern | Specify a yearly recurrence. Valid only for YEARLY frequencies. | NlpSemanticParsingModelsRecurrence | Recurrence rule for specifying date- and time-based repetition for tasks. Next id: 12. | NlpSemanticParsingModelsRecurrenceYearlyPattern |
| dayPeriod | NlpSemanticParsingModelsRecurrenceDailyPattern | Pattern for when in the day the repeating task should trigger. Applies to all frequencies greater than or equal to DAILY. Exactly one of the containing fields should be set (i.e. a specific time or period). | NlpSemanticParsingDateTimeAnnotation | |
| timeOfDay | NlpSemanticParsingModelsRecurrenceDailyPattern | Pattern for when in the day the repeating task should trigger. Applies to all frequencies greater than or equal to DAILY. Exactly one of the containing fields should be set (i.e. a specific time or period). | NlpSemanticParsingDateTimeAnnotation | |
| lastDay | Special flag to indicate the last day of the month, equivalent to setting month_day to -1. Deprecated, use month_day=-1 instead. | NlpSemanticParsingModelsRecurrenceMonthlyPattern | Pattern for a MONTHLY recurrence. A MONTHLY recurrence may be specified in four different ways. These fields should be set in a mutually exclusive way, i.e.: ((month_day OR last_day) XOR (week_day AND (week_day_number OR last_week))) 1. Absolute days of the month (i.e. the 1st and 15th) or relative day from the end of the month (i.e. -1 for last day, -2 for second-to-last day). Set month_day. 2. [Deprecated] Relative last day of the month. Represented as a boolean since the last absolute day number is dependent on the month. This is just a short-cut for month_day=-1 and is deprecated. Set last_day=true. 3. The nth (or nth-last) specific weekday of the month. For example, the 3rd Wednesday of the month. This represents the 3rd instance of a Wednesday of the month, regardless of what weekday the month started on. It does not necessarily mean the Wednesday on the 3rd week of the month. 4. [Deprecated] The last specific weekday of the month. For example, the last Thursday of the month. This is a short-cut for week_day_number=-1. | boolean |
| lastWeek | Special flag to indicate a week_day in the last week of the month, as this cannot be captured by week_day_number. Deprecated, use week_day_number=-1 instead. | NlpSemanticParsingModelsRecurrenceMonthlyPattern | Pattern for a MONTHLY recurrence. A MONTHLY recurrence may be specified in four different ways. These fields should be set in a mutually exclusive way, i.e.: ((month_day OR last_day) XOR (week_day AND (week_day_number OR last_week))) 1. Absolute days of the month (i.e. the 1st and 15th) or relative day from the end of the month (i.e. -1 for last day, -2 for second-to-last day). Set month_day. 2. [Deprecated] Relative last day of the month. Represented as a boolean since the last absolute day number is dependent on the month. This is just a short-cut for month_day=-1 and is deprecated. Set last_day=true. 3. The nth (or nth-last) specific weekday of the month. For example, the 3rd Wednesday of the month. This represents the 3rd instance of a Wednesday of the month, regardless of what weekday the month started on. It does not necessarily mean the Wednesday on the 3rd week of the month. 4. [Deprecated] The last specific weekday of the month. For example, the last Thursday of the month. This is a short-cut for week_day_number=-1. | boolean |
| monthDay | Absolute day of the month (if positive) or relative day from the end of the month (if negative). Example: 2nd and 20th of the month [2, 20]. Example: Last day of the month [-1]. Positive values should correspond to actual calendar day number (indexing starts at 1). | NlpSemanticParsingModelsRecurrenceMonthlyPattern | Pattern for a MONTHLY recurrence. A MONTHLY recurrence may be specified in four different ways. These fields should be set in a mutually exclusive way, i.e.: ((month_day OR last_day) XOR (week_day AND (week_day_number OR last_week))) 1. Absolute days of the month (i.e. the 1st and 15th) or relative day from the end of the month (i.e. -1 for last day, -2 for second-to-last day). Set month_day. 2. [Deprecated] Relative last day of the month. Represented as a boolean since the last absolute day number is dependent on the month. This is just a short-cut for month_day=-1 and is deprecated. Set last_day=true. 3. The nth (or nth-last) specific weekday of the month. For example, the 3rd Wednesday of the month. This represents the 3rd instance of a Wednesday of the month, regardless of what weekday the month started on. It does not necessarily mean the Wednesday on the 3rd week of the month. 4. [Deprecated] The last specific weekday of the month. For example, the last Thursday of the month. This is a short-cut for week_day_number=-1. | list(integer) |
| weekDay | For capturing the nth weekday of the month. Use together with week_day_number or last_week to specify n. | NlpSemanticParsingModelsRecurrenceMonthlyPattern | Pattern for a MONTHLY recurrence. A MONTHLY recurrence may be specified in four different ways. These fields should be set in a mutually exclusive way, i.e.: ((month_day OR last_day) XOR (week_day AND (week_day_number OR last_week))) 1. Absolute days of the month (i.e. the 1st and 15th) or relative day from the end of the month (i.e. -1 for last day, -2 for second-to-last day). Set month_day. 2. [Deprecated] Relative last day of the month. Represented as a boolean since the last absolute day number is dependent on the month. This is just a short-cut for month_day=-1 and is deprecated. Set last_day=true. 3. The nth (or nth-last) specific weekday of the month. For example, the 3rd Wednesday of the month. This represents the 3rd instance of a Wednesday of the month, regardless of what weekday the month started on. It does not necessarily mean the Wednesday on the 3rd week of the month. 4. [Deprecated] The last specific weekday of the month. For example, the last Thursday of the month. This is a short-cut for week_day_number=-1. | String |
| weekDayNumber | The nth occurrence of week_day to match. I.e. For 3rd Wednesday of the month, week_day = WEDNESDAY and week_day_number = 3. Values beyond the end of the month are skipped. If negative, this is interpreted as the nth-to-last occurrence of the week day in the month. I.e. for last Thursday of the month, week_day = THURSDAY and week_day_number = -1. | NlpSemanticParsingModelsRecurrenceMonthlyPattern | Pattern for a MONTHLY recurrence. A MONTHLY recurrence may be specified in four different ways. These fields should be set in a mutually exclusive way, i.e.: ((month_day OR last_day) XOR (week_day AND (week_day_number OR last_week))) 1. Absolute days of the month (i.e. the 1st and 15th) or relative day from the end of the month (i.e. -1 for last day, -2 for second-to-last day). Set month_day. 2. [Deprecated] Relative last day of the month. Represented as a boolean since the last absolute day number is dependent on the month. This is just a short-cut for month_day=-1 and is deprecated. Set last_day=true. 3. The nth (or nth-last) specific weekday of the month. For example, the 3rd Wednesday of the month. This represents the 3rd instance of a Wednesday of the month, regardless of what weekday the month started on. It does not necessarily mean the Wednesday on the 3rd week of the month. 4. [Deprecated] The last specific weekday of the month. For example, the last Thursday of the month. This is a short-cut for week_day_number=-1. | integer |
| autoRenew | Should be used in cases where the size of the recurrence is infinite (no end date specified), in which case we rely on an offline process to extend. Set by server only, setting it on a new recurrence will throw an exception. | NlpSemanticParsingModelsRecurrenceRecurrenceEnd | The end of the recurrence can be represented in one of three ways. 1. An abstract DateTime. (inclusive) 2. An absolute timestamp, in milliseconds from UTC epoch. 3. A number of occurrences. Exactly one of the fields [end_date_time, end_millis, num_occurrences] in this message must be set. Repeating tasks for which the user did not specify an end date are automatically given a reasonable end conditions by the system and auto_renew will be set to true. Similarly, if the user- provided end date is too far in the future to reasonably create all instances, the server will set an auto_renew_until end condition. | boolean |
| autoRenewUntil | Used in cases where the recurrence is too large to create in a single transaction. In this case we create a manageable number of instances initially and rely on an offline process to continually extend the recurrence until this date. Set by server only, setting it on a new recurrence will throw an exception. | NlpSemanticParsingModelsRecurrenceRecurrenceEnd | The end of the recurrence can be represented in one of three ways. 1. An abstract DateTime. (inclusive) 2. An absolute timestamp, in milliseconds from UTC epoch. 3. A number of occurrences. Exactly one of the fields [end_date_time, end_millis, num_occurrences] in this message must be set. Repeating tasks for which the user did not specify an end date are automatically given a reasonable end conditions by the system and auto_renew will be set to true. Similarly, if the user- provided end date is too far in the future to reasonably create all instances, the server will set an auto_renew_until end condition. | NlpSemanticParsingDateTimeAnnotation |
| endDateTime | NlpSemanticParsingModelsRecurrenceRecurrenceEnd | The end of the recurrence can be represented in one of three ways. 1. An abstract DateTime. (inclusive) 2. An absolute timestamp, in milliseconds from UTC epoch. 3. A number of occurrences. Exactly one of the fields [end_date_time, end_millis, num_occurrences] in this message must be set. Repeating tasks for which the user did not specify an end date are automatically given a reasonable end conditions by the system and auto_renew will be set to true. Similarly, if the user- provided end date is too far in the future to reasonably create all instances, the server will set an auto_renew_until end condition. | NlpSemanticParsingDateTimeAnnotation | |
| endMillis | Deprecated – prefer end_date_time.absolute_time_ms. | NlpSemanticParsingModelsRecurrenceRecurrenceEnd | The end of the recurrence can be represented in one of three ways. 1. An abstract DateTime. (inclusive) 2. An absolute timestamp, in milliseconds from UTC epoch. 3. A number of occurrences. Exactly one of the fields [end_date_time, end_millis, num_occurrences] in this message must be set. Repeating tasks for which the user did not specify an end date are automatically given a reasonable end conditions by the system and auto_renew will be set to true. Similarly, if the user- provided end date is too far in the future to reasonably create all instances, the server will set an auto_renew_until end condition. | String |
| numOccurrences | Note that auto-renewing is not supported in conjunction with num_occurrences. Therefore we impose a hard limit of 1000 when using this field. | NlpSemanticParsingModelsRecurrenceRecurrenceEnd | The end of the recurrence can be represented in one of three ways. 1. An abstract DateTime. (inclusive) 2. An absolute timestamp, in milliseconds from UTC epoch. 3. A number of occurrences. Exactly one of the fields [end_date_time, end_millis, num_occurrences] in this message must be set. Repeating tasks for which the user did not specify an end date are automatically given a reasonable end conditions by the system and auto_renew will be set to true. Similarly, if the user- provided end date is too far in the future to reasonably create all instances, the server will set an auto_renew_until end condition. | integer |
| startDateTime | Only the year/month/day portion are used to find the start date of the recurrence. To specify a time or period of each instance, use DailyPattern. | NlpSemanticParsingModelsRecurrenceRecurrenceStart | The start of the recurrence can be represented either as a DateTime or a timestamp in milliseconds from UTC epoch. Exactly one of the fields of this message must be set. | NlpSemanticParsingDateTimeAnnotation |
| startMillis | Deprecated – prefer start_date_time.absolute_time_ms. | NlpSemanticParsingModelsRecurrenceRecurrenceStart | The start of the recurrence can be represented either as a DateTime or a timestamp in milliseconds from UTC epoch. Exactly one of the fields of this message must be set. | String |
| weekDay | Set of weekdays the recurrence applies to. | NlpSemanticParsingModelsRecurrenceWeeklyPattern | Pattern for a WEEKLY recurrence. You must specify at least one week_day. | list(String) |
| weeklyPatternEnd | NlpSemanticParsingModelsRecurrenceWeeklyPattern | Pattern for a WEEKLY recurrence. You must specify at least one week_day. | String | |
| weeklyPatternStart | NlpSemanticParsingModelsRecurrenceWeeklyPattern | Pattern for a WEEKLY recurrence. You must specify at least one week_day. | String | |
| monthlyPattern | The monthly pattern to recur. | NlpSemanticParsingModelsRecurrenceYearlyPattern | Pattern for a YEARLY recurrence. A YEARLY recurrence is specified using a monthly pattern and a set of months the pattern applies to. Some examples: “Every January 16” : monthly_pattern { month_day = 16; } year_month = JANUARY; “Last day of every April and August” : monthly_pattern { last_day = true; } year_month = APRIL, AUGUST | NlpSemanticParsingModelsRecurrenceMonthlyPattern |
| yearMonth | The months of the year to apply the pattern. | NlpSemanticParsingModelsRecurrenceYearlyPattern | Pattern for a YEARLY recurrence. A YEARLY recurrence is specified using a monthly pattern and a set of months the pattern applies to. Some examples: “Every January 16” : monthly_pattern { month_day = 16; } year_month = JANUARY; “Last day of every April and August” : monthly_pattern { last_day = true; } year_month = APRIL, AUGUST | list(String) |
| mid | NlpSemanticParsingModelsShoppingAssistantBrandPhrase | A brand can be any combination of text or mid. | String | |
| rawText | NlpSemanticParsingModelsShoppingAssistantBrandPhrase | A brand can be any combination of text or mid. | String | |
| evalData | This field should not be used by clients of the grammar. It is intended to be used internally in Aqua for metric and regression tests. | NlpSemanticParsingModelsShoppingAssistantMerchant | A merchant that sells products. | NlpSemanticParsingAnnotationEvalData |
| localMerchantId | Merchant Center identifier for LIA merchants. | NlpSemanticParsingModelsShoppingAssistantMerchant | A merchant that sells products. | String |
| mcid | NlpSemanticParsingModelsShoppingAssistantMerchant | A merchant that sells products. | list(NlpSemanticParsingModelsShoppingAssistantMerchantMerchantCenterId) | |
| merchantId | Merchant Center identifier for GSX merchants. Deprecated: use MerchantCenterId. | NlpSemanticParsingModelsShoppingAssistantMerchant | A merchant that sells products. | list(String) |
| mid | Optional. Knowledge Graph identifier for the merchant. | NlpSemanticParsingModelsShoppingAssistantMerchant | A merchant that sells products. | String |
| name | A name for the merchant. Example: Walmart | NlpSemanticParsingModelsShoppingAssistantMerchant | A merchant that sells products. | String |
| id | NlpSemanticParsingModelsShoppingAssistantMerchantMerchantCenterId | Note: A merchant may have multiple merchant center ids, and each one can have multiple purposes. The existing fields merchant_id, local_merchant_id fields are not enough to capture this. Instead we will have a repeated field name mcid with this structure. | String | |
| isGsx | NlpSemanticParsingModelsShoppingAssistantMerchantMerchantCenterId | Note: A merchant may have multiple merchant center ids, and each one can have multiple purposes. The existing fields merchant_id, local_merchant_id fields are not enough to capture this. Instead we will have a repeated field name mcid with this structure. | boolean | |
| isLocal | NlpSemanticParsingModelsShoppingAssistantMerchantMerchantCenterId | Note: A merchant may have multiple merchant center ids, and each one can have multiple purposes. The existing fields merchant_id, local_merchant_id fields are not enough to capture this. Instead we will have a repeated field name mcid with this structure. | boolean | |
| isPla | NlpSemanticParsingModelsShoppingAssistantMerchantMerchantCenterId | Note: A merchant may have multiple merchant center ids, and each one can have multiple purposes. The existing fields merchant_id, local_merchant_id fields are not enough to capture this. Instead we will have a repeated field name mcid with this structure. | boolean | |
| docid | The offer document id as used in Shopping’s metadata. | NlpSemanticParsingModelsShoppingAssistantOffer | A product for sale from a particular merchant, possibly available at a specific store. | String |
| merchant | The merchant selling the product. | NlpSemanticParsingModelsShoppingAssistantOffer | A product for sale from a particular merchant, possibly available at a specific store. | NlpSemanticParsingModelsShoppingAssistantMerchant |
| price | The price of the product sold by the merchant. | NlpSemanticParsingModelsShoppingAssistantOffer | A product for sale from a particular merchant, possibly available at a specific store. | NlpSemanticParsingModelsMoneyMoney |
| product | The product for sale. | NlpSemanticParsingModelsShoppingAssistantOffer | A product for sale from a particular merchant, possibly available at a specific store. | NlpSemanticParsingModelsShoppingAssistantProduct |
| store | Optional. The physical store where the product can be purchased. | NlpSemanticParsingModelsShoppingAssistantOffer | A product for sale from a particular merchant, possibly available at a specific store. | NlpSemanticParsingModelsShoppingAssistantStore |
| brand | NlpSemanticParsingModelsShoppingAssistantPhrase | A phrase parsed from a user query. | NlpSemanticParsingModelsShoppingAssistantBrandPhrase | |
| offer | NlpSemanticParsingModelsShoppingAssistantPhrase | A phrase parsed from a user query. | NlpSemanticParsingModelsShoppingAssistantOffer | |
| product | NlpSemanticParsingModelsShoppingAssistantPhrase | A phrase parsed from a user query. | NlpSemanticParsingModelsShoppingAssistantProductPhrase | |
| unrecognized | NlpSemanticParsingModelsShoppingAssistantPhrase | A phrase parsed from a user query. | NlpSemanticParsingModelsShoppingAssistantUnrecognizedPhrase | |
| catalogId | The shopping catalog identifier. | NlpSemanticParsingModelsShoppingAssistantProduct | A product that can be purchased. | String |
| maxPrice | The highes price this product is available for. | NlpSemanticParsingModelsShoppingAssistantProduct | A product that can be purchased. | NlpSemanticParsingModelsMoneyMoney |
| mediaProduct | TODO(ppoudyal) Add logging for media_product. | NlpSemanticParsingModelsShoppingAssistantProduct | A product that can be purchased. | NlpSemanticParsingModelsShoppingAssistantProductMediaProduct |
| mid | Optional. Knowledge Graph identifier for the product. | NlpSemanticParsingModelsShoppingAssistantProduct | A product that can be purchased. | String |
| minPrice | The lowest price this product is available for. | NlpSemanticParsingModelsShoppingAssistantProduct | A product that can be purchased. | NlpSemanticParsingModelsMoneyMoney |
| title | Title of the product. Example: Moto X Blue 64GB Note: This refers to only the catalog title not user specified phrase | NlpSemanticParsingModelsShoppingAssistantProduct | A product that can be purchased. | String |
| bookConfidence | TODO(ppoudyal) Expand confidence to cases where the product phrase might be a book/movie/video_game but isn’t just a title The score (between 0 – 1) measuring the confidence that product | NlpSemanticParsingModelsShoppingAssistantProductClassification | Whether the product being described fits into specific categories (e.g., “video games”). | number |
| isVideoGame | TODO(ppoudyal) Deprecate is_video_game once the score covers all cases covered by $VideoGameProductPhrase The product phrase contains a video game title. | NlpSemanticParsingModelsShoppingAssistantProductClassification | Whether the product being described fits into specific categories (e.g., “video games”). | boolean |
| movieConfidence | phrase mentions a book title The score (between 0 – 1) measuring the confidence that product | NlpSemanticParsingModelsShoppingAssistantProductClassification | Whether the product being described fits into specific categories (e.g., “video games”). | number |
| videoGameConfidence | phrase mentions a movie title The score (between 0 – 1) measuring the confidence that product | NlpSemanticParsingModelsShoppingAssistantProductClassification | Whether the product being described fits into specific categories (e.g., “video games”). | number |
| evalData | This field should not be used by clients of the grammar. It is intended to be used internally in Aqua for metric and regression tests. | NlpSemanticParsingModelsShoppingAssistantProductExpression | An expression parsed from a user query that describes a product or set of products. | NlpSemanticParsingAnnotationEvalData |
| grammaticalGender | NlpSemanticParsingModelsShoppingAssistantProductExpression | An expression parsed from a user query that describes a product or set of products. | String | |
| grammaticalNumber | NlpSemanticParsingModelsShoppingAssistantProductExpression | An expression parsed from a user query that describes a product or set of products. | String | |
| phrases | Ordered list of phrases that the user used to describe a product. | NlpSemanticParsingModelsShoppingAssistantProductExpression | An expression parsed from a user query that describes a product or set of products. | list(NlpSemanticParsingModelsShoppingAssistantPhrase) |
| productClassification | NlpSemanticParsingModelsShoppingAssistantProductExpression | An expression parsed from a user query that describes a product or set of products. | NlpSemanticParsingModelsShoppingAssistantProductClassification | |
| shoppingListItemInfo | Associated shopping list item info. Only set when the product is come from a shopping list item. | NlpSemanticParsingModelsShoppingAssistantProductExpression | An expression parsed from a user query that describes a product or set of products. | NlpSemanticParsingModelsShoppingAssistantShoppingListItemInfo |
| author | The author of the media | NlpSemanticParsingModelsShoppingAssistantProductMediaProduct | A media product that can be purchased | NlpSemanticParsingModelsShoppingAssistantProductMediaProductMediaAttributeValue |
| genre | The genre of the media | NlpSemanticParsingModelsShoppingAssistantProductMediaProduct | A media product that can be purchased | NlpSemanticParsingModelsShoppingAssistantProductMediaProductMediaAttributeValue |
| mediaTitle | The title of the media Example: The assasin’s creed | NlpSemanticParsingModelsShoppingAssistantProductMediaProduct | A media product that can be purchased | NlpSemanticParsingModelsShoppingAssistantProductMediaProductMediaAttributeValue |
| orderInSeries | Order in media series (series title is given by the product title) | NlpSemanticParsingModelsShoppingAssistantProductMediaProduct | A media product that can be purchased | NlpSemanticParsingModelsShoppingAssistantProductMediaProductMediaAttributeValue |
| topic | The topic of the media | NlpSemanticParsingModelsShoppingAssistantProductMediaProduct | A media product that can be purchased | NlpSemanticParsingModelsShoppingAssistantProductMediaProductMediaAttributeValue |
| mid | The knowledge graph identifier for the attribute | NlpSemanticParsingModelsShoppingAssistantProductMediaProductMediaAttributeValue | String | |
| rawText | Raw text of the media attribute (eg. author) | NlpSemanticParsingModelsShoppingAssistantProductMediaProductMediaAttributeValue | String | |
| metadata | NlpSemanticParsingModelsShoppingAssistantProductPhrase | A product can be any combination of raw_text and metadata (including mid, shopping product catalog title/id, and media attributes). A product phrase refers to a product at the catalog entry level and/or a media product. Media product contains information about author and media title TODO(ppoudyal) Add genre and order_in_series to MediaProduct | NlpSemanticParsingModelsShoppingAssistantProduct | |
| rawText | NlpSemanticParsingModelsShoppingAssistantProductPhrase | A product can be any combination of raw_text and metadata (including mid, shopping product catalog title/id, and media attributes). A product phrase refers to a product at the catalog entry level and/or a media product. Media product contains information about author and media title TODO(ppoudyal) Add genre and order_in_series to MediaProduct | String | |
| itemId | NlpSemanticParsingModelsShoppingAssistantShoppingListItemInfo | String | ||
| listId | NlpSemanticParsingModelsShoppingAssistantShoppingListItemInfo | String | ||
| id | Local store identifier. | NlpSemanticParsingModelsShoppingAssistantStore | A merchant’s physical store. | String |
| location | The location of the store. | NlpSemanticParsingModelsShoppingAssistantStore | A merchant’s physical store. | NlpSemanticParsingLocalLocation |
| name | A name for the store. Example: Walmart – Cranberry | NlpSemanticParsingModelsShoppingAssistantStore | A merchant’s physical store. | String |
| rawText | NlpSemanticParsingModelsShoppingAssistantUnrecognizedPhrase | A span in a user query that could not be identified as any other type of `Phrase`. | String | |
| denominator | NlpSemanticParsingNumberFractionNumber | NlpSemanticParsingNumberSimpleNumber | ||
| numerator | Fields for fraction numbers | NlpSemanticParsingNumberFractionNumber | NlpSemanticParsingNumberSimpleNumber | |
| precision | This field is used to indicate the number of digits after the decimal point in the normalized_value field in number.proto, which contains the floating point representation of the fraction | NlpSemanticParsingNumberFractionNumber | integer | |
| wholeNumber | This field is set only for mixed fraction | NlpSemanticParsingNumberFractionNumber | NlpSemanticParsingNumberSimpleNumber | |
| evalData | Span info of the annotation – mostly used for evaluation purpose. Note: this data must never be used outside Aqua because it relies on the internal tokenization used in Aqua that could change over time. | NlpSemanticParsingNumberNumber | Next ID: 9 | NlpSemanticParsingAnnotationEvalData |
| fractionNumber | NlpSemanticParsingNumberNumber | Next ID: 9 | NlpSemanticParsingNumberFractionNumber | |
| isSpelledOut | An optional field that holds whether the number_type number is a normalized spelled-out number or not. This field will not be set in cases when this information is not available. | NlpSemanticParsingNumberNumber | Next ID: 9 | boolean |
| modifier | NumberModifier is used to capture when the expression is not an absolute number, but a number expression to represent an increase/decrease/comparison. E.g. [10 more percent], [5 less]. | NlpSemanticParsingNumberNumber | Next ID: 9 | String |
| normalizedValue | Contains a normalized string representation of the numeric value that has: * No digit grouping delimiter (e.g. “,” in english). * Decimal mark (if present) as “.” (dot). For fraction_number, this contains the floating point representation of the fraction. The number of digits after the decimal point is defined in the precision field of fraction_number.proto. | NlpSemanticParsingNumberNumber | Next ID: 9 | String |
| rawText | The raw text of the annotation. | NlpSemanticParsingNumberNumber | Next ID: 9 | String |
| simpleNumber | NlpSemanticParsingNumberNumber | Next ID: 9 | NlpSemanticParsingNumberSimpleNumber | |
| spelledOutType | We expect this field to be set only when is_spelled_out is true. | NlpSemanticParsingNumberNumber | Next ID: 9 | String |
| decimalMark | The type of decimal mark that was present before normalization. Note: different locales may use different decimal marks. | NlpSemanticParsingNumberSimpleNumber | Next ID: 8 | String |
| groupingDelimiter | The type of digit grouping delimiter that was present before normalization. Note: different locales may use different digit grouping delimiters. | NlpSemanticParsingNumberSimpleNumber | Next ID: 8 | String |
| groupingSystem | We expect this field to be set only when grouping_delimiter is set. | NlpSemanticParsingNumberSimpleNumber | Next ID: 8 | String |
| normalizedValue | Contains a normalized string representation of the numeric value that has: * No digit grouping delimiter (e.g. “,” in english). * Decimal mark (if present) as “.” (dot). This field is kept for backward compatibility. The field is also available in number.proto | NlpSemanticParsingNumberSimpleNumber | Next ID: 8 | String |
| prefix | Stores prefix output by the GRM number grammar (http://b/28623478). | NlpSemanticParsingNumberSimpleNumber | Next ID: 8 | String |
| suffix | Stores suffix output | NlpSemanticParsingNumberSimpleNumber | Next ID: 8 | String |
| type | NlpSemanticParsingNumberSimpleNumber | Next ID: 8 | String | |
| airlineConfig | Used if the entity is an airline with an airline annotation. | NlpSemanticParsingPersonalIntelligenceEntity | This message should be wire-equivalent to the Entity proto defined in nlp/semantic_parsing/models/personal_intelligence.proto. The message is cloned here to allow legacy intents to extract entities to slots; trying to add Entity to knowledge_answers::intent_query::ArgumentValue creates a BUILD dependency loop. For the proto used for GwsLogs, see logs/proto/knowledge/interpretation/personal_intelligence.proto. | TravelFlightsAirlineConfig |
| evalData | Required, but should only be used inside Aqua. Must not be used by outside clients!! | NlpSemanticParsingPersonalIntelligenceEntity | This message should be wire-equivalent to the Entity proto defined in nlp/semantic_parsing/models/personal_intelligence.proto. The message is cloned here to allow legacy intents to extract entities to slots; trying to add Entity to knowledge_answers::intent_query::ArgumentValue creates a BUILD dependency loop. For the proto used for GwsLogs, see logs/proto/knowledge/interpretation/personal_intelligence.proto. | NlpSemanticParsingAnnotationEvalData |
| name | raw string representation | NlpSemanticParsingPersonalIntelligenceEntity | This message should be wire-equivalent to the Entity proto defined in nlp/semantic_parsing/models/personal_intelligence.proto. The message is cloned here to allow legacy intents to extract entities to slots; trying to add Entity to knowledge_answers::intent_query::ArgumentValue creates a BUILD dependency loop. For the proto used for GwsLogs, see logs/proto/knowledge/interpretation/personal_intelligence.proto. | String |
| qrefAnnotation | NlpSemanticParsingPersonalIntelligenceEntity | This message should be wire-equivalent to the Entity proto defined in nlp/semantic_parsing/models/personal_intelligence.proto. The message is cloned here to allow legacy intents to extract entities to slots; trying to add Entity to knowledge_answers::intent_query::ArgumentValue creates a BUILD dependency loop. For the proto used for GwsLogs, see logs/proto/knowledge/interpretation/personal_intelligence.proto. | NlpSemanticParsingQRefAnnotation | |
| reference | A Copley Personal Reference represents a user’s reference to a something that could be personal entity, e.g. “my hotel”, “mom”, “brunch”. | NlpSemanticParsingPersonalReferenceAnnotation | A collection of any number of QRefAnnotations that designate a Copley Personal Reference and its Resolutions. This is used to handle personalized intents such as “navigate to my hotel” or “when is my mom’s anniversary”. See go/copley. This Annotation may contain only a reference with no resolutions for the failure case (go/copley-punts). TODO(bhorst) Rename this to remove the Copley codename. | NlpSemanticParsingQRefAnnotation |
| resolutions | A Copley Personal Resolution represents the resolution of a Reference, e.g. if the user has a reservation at The Kendall Hotel, the reference “my hotel” could be resolved to The Kendall Hotel, and there would be a QRefAnnotation containing the mid and other data. It is possible for there to be zero resolutions for a given reference. | NlpSemanticParsingPersonalReferenceAnnotation | A collection of any number of QRefAnnotations that designate a Copley Personal Reference and its Resolutions. This is used to handle personalized intents such as “navigate to my hotel” or “when is my mom’s anniversary”. See go/copley. This Annotation may contain only a reference with no resolutions for the failure case (go/copley-punts). TODO(bhorst) Rename this to remove the Copley codename. | list(NlpSemanticParsingQRefAnnotation) |
| entityId | ID of the entity of this slot. | NlpSemanticParsingProtoActionsOnGoogleAogSlot | In simple cases, each NLU slot will contain one or multiple possible values. But in the case of a composite entity – slots can have a complex tree structure. Each slot can represent a List parameter. List parameters are only allowed at the top level, i.e. lists can’t ne nested in maps. Next Id: 9 LINT.IfChange | String |
| numBytes | Number of bytes of this slot in resolved query. | NlpSemanticParsingProtoActionsOnGoogleAogSlot | In simple cases, each NLU slot will contain one or multiple possible values. But in the case of a composite entity – slots can have a complex tree structure. Each slot can represent a List parameter. List parameters are only allowed at the top level, i.e. lists can’t ne nested in maps. Next Id: 9 LINT.IfChange | integer |
| original | Part of input text, matched by that slot. In the case of composite slots, each slot should have its own original. | NlpSemanticParsingProtoActionsOnGoogleAogSlot | In simple cases, each NLU slot will contain one or multiple possible values. But in the case of a composite entity – slots can have a complex tree structure. Each slot can represent a List parameter. List parameters are only allowed at the top level, i.e. lists can’t ne nested in maps. Next Id: 9 LINT.IfChange | String |
| parameterName | Name of parameter of this slot. | NlpSemanticParsingProtoActionsOnGoogleAogSlot | In simple cases, each NLU slot will contain one or multiple possible values. But in the case of a composite entity – slots can have a complex tree structure. Each slot can represent a List parameter. List parameters are only allowed at the top level, i.e. lists can’t ne nested in maps. Next Id: 9 LINT.IfChange | String |
| slotList | Represents a “list parameter”. Each parameter may be declared as a list and have multiple slot values, referenced by a single alias. Each slot value in a list may contain multiple possible values. For example: aqua return 3 dates if the year is not specified in a query – one for the current year, one for the past year, and one for the following year. If user defines a list parameter with type @sys.date, and the query contains multiple dates – we should return a list of possible values for each date from the query, i.e. it will be a list of list of dates. | NlpSemanticParsingProtoActionsOnGoogleAogSlot | In simple cases, each NLU slot will contain one or multiple possible values. But in the case of a composite entity – slots can have a complex tree structure. Each slot can represent a List parameter. List parameters are only allowed at the top level, i.e. lists can’t ne nested in maps. Next Id: 9 LINT.IfChange | NlpSemanticParsingProtoActionsOnGoogleSlotList |
| slotMap | Represents a structured value. Used in composite entities. Composite entities can have arbitrary structure. | NlpSemanticParsingProtoActionsOnGoogleAogSlot | In simple cases, each NLU slot will contain one or multiple possible values. But in the case of a composite entity – slots can have a complex tree structure. Each slot can represent a List parameter. List parameters are only allowed at the top level, i.e. lists can’t ne nested in maps. Next Id: 9 LINT.IfChange | NlpSemanticParsingProtoActionsOnGoogleSlotMap |
| startByte | Start byte position of this slot in resolved query. | NlpSemanticParsingProtoActionsOnGoogleAogSlot | In simple cases, each NLU slot will contain one or multiple possible values. But in the case of a composite entity – slots can have a complex tree structure. Each slot can represent a List parameter. List parameters are only allowed at the top level, i.e. lists can’t ne nested in maps. Next Id: 9 LINT.IfChange | integer |
| value | One or more possible values. This field does not represent a list parameter. | NlpSemanticParsingProtoActionsOnGoogleAogSlot | In simple cases, each NLU slot will contain one or multiple possible values. But in the case of a composite entity – slots can have a complex tree structure. Each slot can represent a List parameter. List parameters are only allowed at the top level, i.e. lists can’t ne nested in maps. Next Id: 9 LINT.IfChange | NlpSemanticParsingProtoActionsOnGoogleSlotValue |
| date | Date value. Note, that month and day are 1 based. If this DateTime is a PARTIAL datetime, then fields have value -1, which means these fields are inferred rather than derived directly from query. | NlpSemanticParsingProtoActionsOnGoogleDateTime | Represents datetime. It can be @sys.date, @sys.time or, in some cases, @sys.date-time. Our platform doesn’t track seconds, so this field is omitted. Number of seconds should be considered 0. Hour and minute can be 0 in case of dates. In case of time and dateTime, hours and minutes will represent actual time, even if both of them are 0. | GoogleTypeDate |
| property | Property of this DateTime value that can be used to match user specification of parameters, e.g. date.recent. | NlpSemanticParsingProtoActionsOnGoogleDateTime | Represents datetime. It can be @sys.date, @sys.time or, in some cases, @sys.date-time. Our platform doesn’t track seconds, so this field is omitted. Number of seconds should be considered 0. Hour and minute can be 0 in case of dates. In case of time and dateTime, hours and minutes will represent actual time, even if both of them are 0. | NlpSemanticParsingProtoActionsOnGoogleDateTimeProperty |
| time | Time value. Only hours and minutes are used. Hours are in 24h format. | NlpSemanticParsingProtoActionsOnGoogleDateTime | Represents datetime. It can be @sys.date, @sys.time or, in some cases, @sys.date-time. Our platform doesn’t track seconds, so this field is omitted. Number of seconds should be considered 0. Hour and minute can be 0 in case of dates. In case of time and dateTime, hours and minutes will represent actual time, even if both of them are 0. | GoogleTypeTimeOfDay |
| timeZone | Timezone field specified only if this DateTime has type TIME or DATETIME. | NlpSemanticParsingProtoActionsOnGoogleDateTime | Represents datetime. It can be @sys.date, @sys.time or, in some cases, @sys.date-time. Our platform doesn’t track seconds, so this field is omitted. Number of seconds should be considered 0. Hour and minute can be 0 in case of dates. In case of time and dateTime, hours and minutes will represent actual time, even if both of them are 0. | GoogleTypeTimeZone |
| datetimeType | Since datetime is a superset of date, time and date&time, this field is used to indicate which type the associated DateTime object belongs to. | NlpSemanticParsingProtoActionsOnGoogleDateTimeProperty | Represents properties about a matched DateTime value. Will only be populated for @sys.date-time, @sys.date and @sys.time. | String |
| relativeDatetimeType | The relative relationship between this DateTime value and DateTime&Timezone info provided in ClassifyRequest. | NlpSemanticParsingProtoActionsOnGoogleDateTimeProperty | Represents properties about a matched DateTime value. Will only be populated for @sys.date-time, @sys.date and @sys.time. | String |
| slots | NlpSemanticParsingProtoActionsOnGoogleSlotList | Oneof doesn’t allow list, this message is used to inject list as a possible value into Slot. | list(NlpSemanticParsingProtoActionsOnGoogleAogSlot) | |
| values | NlpSemanticParsingProtoActionsOnGoogleSlotValue | Contains one or more possible values. | list(NlpSemanticParsingProtoActionsOnGoogleSlotValueSingleValue) | |
| dateTimeValue | Represents date or time. | NlpSemanticParsingProtoActionsOnGoogleSlotValueSingleValue | Represents an actual value. | NlpSemanticParsingProtoActionsOnGoogleDateTime |
| stringValue | Represents a string value. | NlpSemanticParsingProtoActionsOnGoogleSlotValueSingleValue | Represents an actual value. | String |
| typeValue | This field is only populated by on-device Heron. This field should not be populated by any other service. | NlpSemanticParsingProtoActionsOnGoogleSlotValueSingleValue | Represents an actual value. | NlpSemanticParsingProtoActionsOnGoogleTypedValue |
| boolValue | Represents a boolean value. | NlpSemanticParsingProtoActionsOnGoogleTypedValue | Used by on-device Heron. Contains information about the type of slot value returned. | boolean |
| dateTimeValue | Represents date or time. | NlpSemanticParsingProtoActionsOnGoogleTypedValue | Used by on-device Heron. Contains information about the type of slot value returned. | NlpSemanticParsingProtoActionsOnGoogleDateTime |
| numberValue | Represents number value. In accordance to ParamValue fields(https://source.corp.google.com/piper///depot/google3/third_party/java_src/appactions/proto/app_actions_data.proto;rcl=431529042;l=12) | NlpSemanticParsingProtoActionsOnGoogleTypedValue | Used by on-device Heron. Contains information about the type of slot value returned. | float |
| stringValue | Represents a string value. | NlpSemanticParsingProtoActionsOnGoogleTypedValue | Used by on-device Heron. Contains information about the type of slot value returned. | String |
| globalProductClusterId | The shopping global product cluster id(s) of the annotated entity (in KG, the key(s) of type /business/variant_cluster). | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | list(String) |
| gaiaId | The Gaia ID for this entity. This is populated generally for people and businesses. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | String |
| sourceTypeList | If the annotation was created by using personal data, we record the provenance for that data here. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | CopleySourceTypeList |
| confidenceScore | The confidence (in [0, 1]) of the entity being correctly annotated. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | float |
| subCluster | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | list(NlpSemanticParsingQRefAnnotationSubCluster) | |
| referenceScore | The confidence (in [0, 1]) that the annotation is reference that implies another entity. (eg “my hotel” in “navigate to my hotel” is reference to explicit hotel from user hotel reservation). | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | number |
| displayName | Copy the display info. This can be used by annotators to give grammars a canonical name for an entity. For instance, the media grammar could use it to output the same canonical name for “rock music” and “rock”. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | String |
| entitySourceData | Holds information about the backends which contributed to this entity. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | NlpSemanticParsingEntitySourceData |
| mdvcVerticals | The set of verticals this summary node belongs to. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | list(String) |
| deprecatedEquivalentMids | DEPRECATED: Equivalent ids (e.g. de-duped mids) for this entity. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | list(String) |
| clusterId | The ID of the cluster (set entity) this entity belongs to. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | String |
| deprecatedMdvcSupportingMid | DEPRECATED: Higher level id’s that support the given id. This field has been deprecated in favor of related_entity. b/27363861 | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | list(String) |
| productLineId | The shopping product line id(s) of the annotated /business/shopping_product_line entity. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | list(String) |
| locationType | The location type of the entity, as an int32 representing a TypeCategory enum value. For example, this could be TYPE_LOCALITY (37) or TYPE_COUNTRY (33). We store this type as an int because including FeatureProto would cause java/com/google/ads/adh/pipeline/bigquery:ProtoCatalog to become too large, resulting in OOM errors. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | integer |
| mergedImpliedEntity | A list of any implied entities merged into this annotation during parsing. Order is derivation-dependent. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | list(NlpSemanticParsingQRefAnnotation) |
| isMdvcDimension | True if this entity is an mdvc dimension of some other annotated entity. Only included if the QRefAnnotator is initialised with include_annotated_relationships. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | boolean |
| clusterSiblingMid | The set of mids that are members of the same cluster. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | list(String) |
| relatedEntity | Mids related to the given entity | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | list(NlpSemanticParsingRelatedEntity) |
| lowConfidence | Whether this entity is low confidence. Not used. Currently whitelisted entities below min_confidence threshold are marked as low confidence and maybe not trusted by downstreams. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | boolean |
| addedByCloseAnswers | Whether this qref annotation was created by CloseAnswers on Postref. Annotations of this type don’t correspond to a particular mention of the entity on the query but rather to an interpretation of the full query. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | boolean |
| location | The center point of this location. This is either directly provided by the FeatureProto.center field or the centroid using the points of the polygon in the FeatureProto. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | GeostorePointProto |
| collectionMembership | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | list(NlpSemanticParsingQRefAnnotationCollectionMembership) | |
| otherMetadata | Metadata to be passed through from the AnnotationContext API. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | Proto2BridgeMessageSet |
| merlotCategory | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | list(NlpSemanticParsingQRefAnnotationMerlotCategoryData) | |
| resolutionScore | The confidence (in [0, 1]) that the annotation was created on an implicit mention (eg my hotel) as opposed to an explicit mention (eg: the westin copley square) | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | number |
| isNimbleAnnotation | Whether this annotation originates from nimble. (go/nimble-annotator) | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | boolean |
| entityNumber | The index of the entity from which this annotation is obtained, within the WebrefEntities message in the interpretation defined by interpretation_number, above. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | integer |
| personalSummaryNodeChild | Personal summary nodes are compound entities made up of entities and their attributes, where the entities can be compound too. E.g., “my father’s mother” can have a summary node annotation of “Mother(Father(Myself))”. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | list(NlpSemanticParsingQRefAnnotation) |
| mdvcChild | Nested annotations that represent subparts of the given mdvc full annotation. An MDVC full annotation is outputted as the summary node as the root node, and all the children of it as leaves (mdvc_child). QRef outputs a graph of relationships between the mdvc enties, and for mdvc full the aquatator nests the relevant children inside the summary node’s proto. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | list(NlpSemanticParsingQRefAnnotation) |
| entityRelationship | The relationship information from QRef. Only included if the QRefAnnotator is initialised with include_annotated_relationships. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | list(NlpSemanticParsingQRefAnnotationEntityRelationship) |
| annotatedSpan | A copy of the span of canonical (raw) parser input text corresponding to this annotation. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | String |
| interpretationNumber | The index of the QueryJoin interpretation from which this annotation was obtained. This field is not used for entities coming from low-confidence annotations, since such entities are not included in any interpretation. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | integer |
| freebaseMid | The mid of the entity in freebase associated with this span. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | String |
| attributeId | Attribute ID of a personal_summary_node_child. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | String |
| clusterSetScore | Cluster set qref confidence score. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | float |
| oysterId | The geo oyster_id of the entity, relevant only for locations. Only included if the QRefAnnotator is initialised with include_oyster_id. | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | GeostoreFeatureIdProto |
| matchedLightweightToken | NlpSemanticParsingQRefAnnotation | The QRefAnnotator annotates spans of input with freebase-ids and collection-information. NEXT ID TO USE: 41 | list(RepositoryWebrefLightweightTokensMatchedLightweightToken) | |
| collectionId | Identifier of the collection. Usually something like “/collection/us_states”. | NlpSemanticParsingQRefAnnotationCollectionMembership | String | |
| collectionScore | A value in [0, 1] indicating the relevance of the collection given this entity. NOTE: This field is deprecated and will stop being populated soon. In the meantime, it will always be populated with 1.0. | NlpSemanticParsingQRefAnnotationCollectionMembership | float | |
| entityIndex | The index of the other entity in the relationship. | NlpSemanticParsingQRefAnnotationEntityRelationship | integer | |
| impliedBy | True if this entity is implied by the other (includes geo contains). | NlpSemanticParsingQRefAnnotationEntityRelationship | boolean | |
| implies | True if this entity implies the other (includes geo contained by). | NlpSemanticParsingQRefAnnotationEntityRelationship | boolean | |
| linkPropertyName | Names of the relationship links. | NlpSemanticParsingQRefAnnotationEntityRelationship | list(String) | |
| categoryId | NlpSemanticParsingQRefAnnotationMerlotCategoryData | Merlot category information. As of Sep2015, this is derived from collection membership, but as that information is planned for deprecation and may need to be replaced as a source for this data, it is extracted separately. | integer | |
| confidence | NlpSemanticParsingQRefAnnotationMerlotCategoryData | Merlot category information. As of Sep2015, this is derived from collection membership, but as that information is planned for deprecation and may need to be replaced as a source for this data, it is extracted separately. | float | |
| clusterId | NlpSemanticParsingQRefAnnotationSubCluster | Keeps track of any individual clusters this mid is a member of. Cluster_id and cluster_sibling_mid stores the cluster all together, while the subcluster keeps track of each individual cluster information separately. | String | |
| clusterSetScore | NlpSemanticParsingQRefAnnotationSubCluster | Keeps track of any individual clusters this mid is a member of. Cluster_id and cluster_sibling_mid stores the cluster all together, while the subcluster keeps track of each individual cluster information separately. | float | |
| clusterSiblingMid | NlpSemanticParsingQRefAnnotationSubCluster | Keeps track of any individual clusters this mid is a member of. Cluster_id and cluster_sibling_mid stores the cluster all together, while the subcluster keeps track of each individual cluster information separately. | list(String) | |
| clusterSupportTransferRelation | Denotes whether or not the related entity is derived from cluster support transfer. | NlpSemanticParsingRelatedEntity | A message that stores relations between this annotation and another entity. Stores the mid and the kind of relationship. These links may be consumed downstream for various purposes, including support transfer and other business logic. An example is for the Honda Civic entity. It may have an mdvc_relation that is a generalization_of the 2015 Honda Civic entity. So the Honda Civic would have the following: RelatedEntity { mid = 2015 Honda Civic Mid mdvc_relation = GENERALIZATION_OF } It has no equivalent_relation because it is by default NO_EQUIVALENT. The Honda Civic entity might then have a separate relation to the Old Honda Civic entity, as they are considered the same entity, or the following relation: RelatedEntity { mid = Old Honda Civic Mid equivalent_relation = EQUIVALENT } | String |
| composedFromRelation | Denotes whether or not the related entity composes a compound entity together with other related entities. | NlpSemanticParsingRelatedEntity | A message that stores relations between this annotation and another entity. Stores the mid and the kind of relationship. These links may be consumed downstream for various purposes, including support transfer and other business logic. An example is for the Honda Civic entity. It may have an mdvc_relation that is a generalization_of the 2015 Honda Civic entity. So the Honda Civic would have the following: RelatedEntity { mid = 2015 Honda Civic Mid mdvc_relation = GENERALIZATION_OF } It has no equivalent_relation because it is by default NO_EQUIVALENT. The Honda Civic entity might then have a separate relation to the Old Honda Civic entity, as they are considered the same entity, or the following relation: RelatedEntity { mid = Old Honda Civic Mid equivalent_relation = EQUIVALENT } | String |
| equivalentRelation | Whether or not the given mid is related to the other mid. Equivalent mids are usually mutually exclusive with other kinds of relations. | NlpSemanticParsingRelatedEntity | A message that stores relations between this annotation and another entity. Stores the mid and the kind of relationship. These links may be consumed downstream for various purposes, including support transfer and other business logic. An example is for the Honda Civic entity. It may have an mdvc_relation that is a generalization_of the 2015 Honda Civic entity. So the Honda Civic would have the following: RelatedEntity { mid = 2015 Honda Civic Mid mdvc_relation = GENERALIZATION_OF } It has no equivalent_relation because it is by default NO_EQUIVALENT. The Honda Civic entity might then have a separate relation to the Old Honda Civic entity, as they are considered the same entity, or the following relation: RelatedEntity { mid = Old Honda Civic Mid equivalent_relation = EQUIVALENT } | String |
| mdvcRelation | The mdvc relation with the related mid. | NlpSemanticParsingRelatedEntity | A message that stores relations between this annotation and another entity. Stores the mid and the kind of relationship. These links may be consumed downstream for various purposes, including support transfer and other business logic. An example is for the Honda Civic entity. It may have an mdvc_relation that is a generalization_of the 2015 Honda Civic entity. So the Honda Civic would have the following: RelatedEntity { mid = 2015 Honda Civic Mid mdvc_relation = GENERALIZATION_OF } It has no equivalent_relation because it is by default NO_EQUIVALENT. The Honda Civic entity might then have a separate relation to the Old Honda Civic entity, as they are considered the same entity, or the following relation: RelatedEntity { mid = Old Honda Civic Mid equivalent_relation = EQUIVALENT } | String |
| mid | Mid that is related. | NlpSemanticParsingRelatedEntity | A message that stores relations between this annotation and another entity. Stores the mid and the kind of relationship. These links may be consumed downstream for various purposes, including support transfer and other business logic. An example is for the Honda Civic entity. It may have an mdvc_relation that is a generalization_of the 2015 Honda Civic entity. So the Honda Civic would have the following: RelatedEntity { mid = 2015 Honda Civic Mid mdvc_relation = GENERALIZATION_OF } It has no equivalent_relation because it is by default NO_EQUIVALENT. The Honda Civic entity might then have a separate relation to the Old Honda Civic entity, as they are considered the same entity, or the following relation: RelatedEntity { mid = Old Honda Civic Mid equivalent_relation = EQUIVALENT } | String |
| supportTransferRelation | Denotes whether or not there was support transfer between the two entities. | NlpSemanticParsingRelatedEntity | A message that stores relations between this annotation and another entity. Stores the mid and the kind of relationship. These links may be consumed downstream for various purposes, including support transfer and other business logic. An example is for the Honda Civic entity. It may have an mdvc_relation that is a generalization_of the 2015 Honda Civic entity. So the Honda Civic would have the following: RelatedEntity { mid = 2015 Honda Civic Mid mdvc_relation = GENERALIZATION_OF } It has no equivalent_relation because it is by default NO_EQUIVALENT. The Honda Civic entity might then have a separate relation to the Old Honda Civic entity, as they are considered the same entity, or the following relation: RelatedEntity { mid = Old Honda Civic Mid equivalent_relation = EQUIVALENT } | String |
| targetIsStbrSource | Set if the related entity is the source of an STBR rule and the target is not this one. | NlpSemanticParsingRelatedEntity | A message that stores relations between this annotation and another entity. Stores the mid and the kind of relationship. These links may be consumed downstream for various purposes, including support transfer and other business logic. An example is for the Honda Civic entity. It may have an mdvc_relation that is a generalization_of the 2015 Honda Civic entity. So the Honda Civic would have the following: RelatedEntity { mid = 2015 Honda Civic Mid mdvc_relation = GENERALIZATION_OF } It has no equivalent_relation because it is by default NO_EQUIVALENT. The Honda Civic entity might then have a separate relation to the Old Honda Civic entity, as they are considered the same entity, or the following relation: RelatedEntity { mid = Old Honda Civic Mid equivalent_relation = EQUIVALENT } | boolean |
| category | Categories can be either a $PronounMention or $NominalMention. | NlpSemanticParsingSaftCoreference | Identifies a coreference mention (pronoun or nominal) resolved to an entity. | String |
| rawText | The substring of the raw query spanned by this annotation. | NlpSemanticParsingSaftCoreference | Identifies a coreference mention (pronoun or nominal) resolved to an entity. | String |
| referentText | The name of the entity this mentions refers to. | NlpSemanticParsingSaftCoreference | Identifies a coreference mention (pronoun or nominal) resolved to an entity. | String |
| category | Defines the category of measure, like $Mass. | NlpSemanticParsingSaftMeasure | Identifies a measure, like ’53 pounds’ in a query. | String |
| rawText | The substring of the raw query spanned by this annotation. | NlpSemanticParsingSaftMeasure | Identifies a measure, like ’53 pounds’ in a query. | String |
| value | The numerical value of the measure. | NlpSemanticParsingSaftMeasure | Identifies a measure, like ’53 pounds’ in a query. | float |
| coreference | Annotations for spans that are resolved coreference mentions. | NlpSemanticParsingSaftMentionAnnotation | SaftMentionAnnotation(s) are used to identify a sub-span of the input with some semantic relevance, for example PER (Person), LOC (Locations) or measure etc. Each SaftMentionAnnotation will have exactly one non-empty field. | NlpSemanticParsingSaftCoreference |
| entity | Annotations for spans like “san francisco giants”. | NlpSemanticParsingSaftMentionAnnotation | SaftMentionAnnotation(s) are used to identify a sub-span of the input with some semantic relevance, for example PER (Person), LOC (Locations) or measure etc. Each SaftMentionAnnotation will have exactly one non-empty field. | NlpSemanticParsingSaftSpan |
| measure | Annotations for spans “53 pounds”. | NlpSemanticParsingSaftMentionAnnotation | SaftMentionAnnotation(s) are used to identify a sub-span of the input with some semantic relevance, for example PER (Person), LOC (Locations) or measure etc. Each SaftMentionAnnotation will have exactly one non-empty field. | NlpSemanticParsingSaftMeasure |
| title | Annotations for spans like “the president of the United States”. | NlpSemanticParsingSaftMentionAnnotation | SaftMentionAnnotation(s) are used to identify a sub-span of the input with some semantic relevance, for example PER (Person), LOC (Locations) or measure etc. Each SaftMentionAnnotation will have exactly one non-empty field. | NlpSemanticParsingSaftSpan |
| category | Categories can be either syntactic (NNS for fine-grained-POS) or semantics ($Mass for measures). | NlpSemanticParsingSaftSpan | The lowest common denominator of a SAFT annotation is simply the definition of some |category| for a sub-span of the |raw_text| of the query. | String |
| rawText | The substring of the raw query spanned by this annotation. | NlpSemanticParsingSaftSpan | The lowest common denominator of a SAFT annotation is simply the definition of some |category| for a sub-span of the |raw_text| of the query. | String |
| document | The document that contains this character. | NlxDataSchemaByte | A single byte, such as that from a utf8-encoded character sequence. | MultiscalePointerIndex |
| document | The document that contains this character. | NlxDataSchemaCharacter | A single Unicode character. | MultiscalePointerIndex |
| paragraph | The paragraph that contains this character. | NlxDataSchemaCharacter | A single Unicode character. | MultiscalePointerIndex |
| sentence | The sentence that contains this character. | NlxDataSchemaCharacter | A single Unicode character. | MultiscalePointerIndex |
| text | The character itself. Must contain valid UTF-8. Must be exactly one Unicode character. | NlxDataSchemaCharacter | A single Unicode character. | String |
| token | The token that contains this character. | NlxDataSchemaCharacter | A single Unicode character. | MultiscalePointerIndex |
| author | The author(s) of this document. | NlxDataSchemaDocument | A single document. | list(MultiscalePointerIndex) |
| bytes | The bytes in this document. | NlxDataSchemaDocument | A single document. | MultiscalePointerSpan |
| characters | The characters in this document. | NlxDataSchemaDocument | A single document. | MultiscalePointerSpan |
| id | The identifier of this document. | NlxDataSchemaDocument | A single document. | String |
| languageCode | A set of BCP-47 codes indicating the language(s) of this document. | NlxDataSchemaDocument | A single document. | list(String) |
| languageSpans | The language spans in this document. | NlxDataSchemaDocument | A single document. | MultiscalePointerSpan |
| mentions | The mentions in this document. | NlxDataSchemaDocument | A single document. | MultiscalePointerSpan |
| paragraphs | The paragraphs in this document. | NlxDataSchemaDocument | A single document. | MultiscalePointerSpan |
| sentences | The sentences in this document. | NlxDataSchemaDocument | A single document. | MultiscalePointerSpan |
| text | The text of this document. Must contain valid UTF-8. | NlxDataSchemaDocument | A single document. | String |
| tokens | The tokens in this document. | NlxDataSchemaDocument | A single document. | MultiscalePointerSpan |
| url | The url of this document. | NlxDataSchemaDocument | A single document. | String |
| gender | Entity gender. Default label set is ‘masculine’, ‘feminine’, or ‘neuter’. (Perhaps in the future we can split ‘neuter’ into ‘inanimate’, ‘unknown’, and ‘non-binary’.) | NlxDataSchemaEntity | An entity, which may occur multiple times in the text. | String |
| mid | Machine identifier, such as those from the Freebase database (or similar entity database). | NlxDataSchemaEntity | An entity, which may occur multiple times in the text. | String |
| name | Free-form entity name. | NlxDataSchemaEntity | An entity, which may occur multiple times in the text. | String |
| type | Entity type, typically something like person/location/organization. The schema for types is not specified. If this entity has a MID, use the mid field instead or in conjunction with the type. | NlxDataSchemaEntity | An entity, which may occur multiple times in the text. | list(String) |
| bytes | The bytes in this span. | NlxDataSchemaLanguageSpan | A span of text that is written using a specified language (or languages). language_spans do not need to cover all of the characters in a text — in particular, some pieces of text may not use any language. Depending on the model used to generate them, multilingual text can be encoded using overlapping or non- overlapping language_spans; and using one or multiple language_codes per language_span. | MultiscalePointerSpan |
| characters | The characters in this span. | NlxDataSchemaLanguageSpan | A span of text that is written using a specified language (or languages). language_spans do not need to cover all of the characters in a text — in particular, some pieces of text may not use any language. Depending on the model used to generate them, multilingual text can be encoded using overlapping or non- overlapping language_spans; and using one or multiple language_codes per language_span. | MultiscalePointerSpan |
| document | The document that contains this span. | NlxDataSchemaLanguageSpan | A span of text that is written using a specified language (or languages). language_spans do not need to cover all of the characters in a text — in particular, some pieces of text may not use any language. Depending on the model used to generate them, multilingual text can be encoded using overlapping or non- overlapping language_spans; and using one or multiple language_codes per language_span. | MultiscalePointerIndex |
| languageCode | A set of BCP-47 codes indicating the language(s) of this span of text. | NlxDataSchemaLanguageSpan | A span of text that is written using a specified language (or languages). language_spans do not need to cover all of the characters in a text — in particular, some pieces of text may not use any language. Depending on the model used to generate them, multilingual text can be encoded using overlapping or non- overlapping language_spans; and using one or multiple language_codes per language_span. | list(String) |
| bytes | The bytes in this mention. | NlxDataSchemaMention | A mention of an entity. A single entity might be mentioned multiple times. | MultiscalePointerSpan |
| document | The document that contains this mention. | NlxDataSchemaMention | A mention of an entity. A single entity might be mentioned multiple times. | MultiscalePointerIndex |
| entity | The entity that this mention refers to. | NlxDataSchemaMention | A mention of an entity. A single entity might be mentioned multiple times. | MultiscalePointerIndex |
| kind | Mention kind, typically ‘referential’, ‘attributive’, or ‘modifier’. | NlxDataSchemaMention | A mention of an entity. A single entity might be mentioned multiple times. | String |
| text | The mention text itself. Must contain valid UTF-8. | NlxDataSchemaMention | A mention of an entity. A single entity might be mentioned multiple times. | String |
| tokens | The token(s) in this mention. This may not be present, or have zero length if representing an implicit mention, as in the prodrop case. | NlxDataSchemaMention | A mention of an entity. A single entity might be mentioned multiple times. | MultiscalePointerSpan |
| type | Mention type, typically ‘named’ (for name mentions) or ‘nominal’. More types include ‘pronominal’, ‘conjoined’ for conjoined mention construction, and ‘non-referential’ for non-referential pronoun mentions. | NlxDataSchemaMention | A mention of an entity. A single entity might be mentioned multiple times. | String |
| bytes | The bytes in this paragraph. | NlxDataSchemaParagraph | A single paragraph. | MultiscalePointerSpan |
| characters | The characters in this paragraph. | NlxDataSchemaParagraph | A single paragraph. | MultiscalePointerSpan |
| document | The document that contains this paragraph. | NlxDataSchemaParagraph | A single paragraph. | MultiscalePointerIndex |
| sentences | The sentences in this paragraph. | NlxDataSchemaParagraph | A single paragraph. | MultiscalePointerSpan |
| text | The text of this paragraph. Must contain valid UTF-8. | NlxDataSchemaParagraph | A single paragraph. | String |
| tokens | The tokens in this paragraph. | NlxDataSchemaParagraph | A single paragraph. | MultiscalePointerSpan |
| entityTypePresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| sentenceParagraphPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| entityMidPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| entityGenderPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| mentionBytesPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| entityPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleLayerPresence | |
| languageSpanDocumentPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| entityNamePresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| paragraphDocumentPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| sentencePresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleLayerPresence | |
| entity | NlxDataSchemaScaleSet | Standard NLX data schema. | list(NlxDataSchemaEntity) | |
| bytePresence | Metadata for which layers (scales) are present. WARNING: CURRENT USAGE IS AD HOC, DO NOT RELY ON THESE BEING POPULATED CORRECTLY. This should improve in v2. | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleLayerPresence |
| tokenDocumentPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| documentCharactersPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| tokenSentencePresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| character | NlxDataSchemaScaleSet | Standard NLX data schema. | list(NlxDataSchemaCharacter) | |
| documentLanguageCodePresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| token | NlxDataSchemaScaleSet | Standard NLX data schema. | list(NlxDataSchemaToken) | |
| tokenParagraphPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| documentIdPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| sentenceCharactersPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| languageSpanPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleLayerPresence | |
| paragraph | NlxDataSchemaScaleSet | Standard NLX data schema. | list(NlxDataSchemaParagraph) | |
| mentionDocumentPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| tokenDependencyPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| tokenPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleLayerPresence | |
| mention | NlxDataSchemaScaleSet | Standard NLX data schema. | list(NlxDataSchemaMention) | |
| paragraphCharactersPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| documentParagraphsPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| mentionEntityPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| mentionPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleLayerPresence | |
| tokenPosPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| sentenceBytesPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| tokenDependencyHeadPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| languageSpanLanguageCodePresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| sentenceTokensPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| documentTextPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| documentMentionsPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| documentUrlPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| paragraphTokensPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| characterParagraphPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| sentence | NlxDataSchemaScaleSet | Standard NLX data schema. | list(NlxDataSchemaSentence) | |
| mentionTokensPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| paragraphBytesPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| documentBytesPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| mentionTextPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| characterTextPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| characterTokenPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| characterSentencePresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| characterPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleLayerPresence | |
| byteDocumentPresence | Metadata for which layer (scale) fields are present. WARNING: CURRENT USAGE IS AD HOC, DO NOT RELY ON THESE BEING POPULATED CORRECTLY. This should improve in v2. | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence |
| paragraphPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleLayerPresence | |
| languageSpan | NlxDataSchemaScaleSet | Standard NLX data schema. | list(NlxDataSchemaLanguageSpan) | |
| languageSpanBytesPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| tokenTextPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| mentionTypePresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| tokenBytesPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| byte | NlxDataSchemaScaleSet | Standard NLX data schema. | list(NlxDataSchemaByte) | |
| tokenCharactersPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| documentTokensPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| characterDocumentPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| sentenceDocumentPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| documentSentencesPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| languageSpanCharactersPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| tokenDependencyLabelPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| paragraphTextPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| sentenceTextPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| documentPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleLayerPresence | |
| documentAuthorPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| document | NlxDataSchemaScaleSet | Standard NLX data schema. | list(NlxDataSchemaDocument) | |
| paragraphSentencesPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| mentionKindPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| documentLanguageSpansPresence | NlxDataSchemaScaleSet | Standard NLX data schema. | MultiscaleFieldPresence | |
| bytes | The bytes in this sentence. | NlxDataSchemaSentence | A single sentence or utterance. | MultiscalePointerSpan |
| characters | The characters in this sentence. | NlxDataSchemaSentence | A single sentence or utterance. | MultiscalePointerSpan |
| document | The document that contains this sentence. | NlxDataSchemaSentence | A single sentence or utterance. | MultiscalePointerIndex |
| paragraph | The paragraph that contains this sentence. | NlxDataSchemaSentence | A single sentence or utterance. | MultiscalePointerIndex |
| text | The text of this sentence. Must contain valid UTF-8. | NlxDataSchemaSentence | A single sentence or utterance. | String |
| tokens | The tokens in this sentence. | NlxDataSchemaSentence | A single sentence or utterance. | MultiscalePointerSpan |
| bytes | The bytes in this token. | NlxDataSchemaToken | A word, punctuation mark, or other small piece of text. | MultiscalePointerSpan |
| characters | The characters in this token. | NlxDataSchemaToken | A word, punctuation mark, or other small piece of text. | MultiscalePointerSpan |
| dependency | DEPRECATED: PLEASE USE dependency_head AND dependency_label FIELDS. One edge of the dependency parse. | NlxDataSchemaToken | A word, punctuation mark, or other small piece of text. | NlxDataSchemaTokenDependencyEdge |
| dependencyHead | The head of this token. By default, the root of the sentence is its own head; it should also have deprel as ‘root’. | NlxDataSchemaToken | A word, punctuation mark, or other small piece of text. | MultiscalePointerIndex |
| dependencyLabel | Relation label for this dependency. Generally this should be using the Universal Dependencies label format, using fine-grained labels like nsubj:pass. | NlxDataSchemaToken | A word, punctuation mark, or other small piece of text. | String |
| document | The document that contains this token. | NlxDataSchemaToken | A word, punctuation mark, or other small piece of text. | MultiscalePointerIndex |
| paragraph | The paragraph that contains this token. | NlxDataSchemaToken | A word, punctuation mark, or other small piece of text. | MultiscalePointerIndex |
| pos | Coarse part-of-speech tag. | NlxDataSchemaToken | A word, punctuation mark, or other small piece of text. | String |
| sentence | The sentence that contains this token. | NlxDataSchemaToken | A word, punctuation mark, or other small piece of text. | MultiscalePointerIndex |
| text | The text of this token. Must contain valid UTF-8. | NlxDataSchemaToken | A word, punctuation mark, or other small piece of text. | String |
| deprel | Relation label for this dependency. Generally this should be using the Universal Dependencies label format, using fine- grained labels like nsubj:pass. | NlxDataSchemaTokenDependencyEdge | DEPRECATED: PLEASE USE dependency_head AND dependency_label FIELDS. One edge of the dependency parse. | String |
| head | The head of this token. By default, the root of the sentence is its own head; it should also have deprel as ‘root’. | NlxDataSchemaTokenDependencyEdge | DEPRECATED: PLEASE USE dependency_head AND dependency_label FIELDS. One edge of the dependency parse. | MultiscalePointerIndex |
| value | The NSR value corresponding to this version. | NSRVersionedItem | Message representing a versioned NSR score used for experimentation. This protobuf is copied from quality_nsr::NSRVersionedItem. | number |
| versionId | The version id. | NSRVersionedItem | Message representing a versioned NSR score used for experimentation. This protobuf is copied from quality_nsr::NSRVersionedItem. | integer |
| author | OceanDataDocinfoWoodwingItemMetadata | Metadata describing an ‘item’ (article) in a Woodwing file. | String | |
| category | OceanDataDocinfoWoodwingItemMetadata | Metadata describing an ‘item’ (article) in a Woodwing file. | String | |
| description | OceanDataDocinfoWoodwingItemMetadata | Metadata describing an ‘item’ (article) in a Woodwing file. | String | |
| title | OceanDataDocinfoWoodwingItemMetadata | Metadata describing an ‘item’ (article) in a Woodwing file. | String | |
| docTag | data returned with search docresults (snippets) | OceanDocInfo | Ocean data in docserver results (whole documents) | OceanDocTag |
| DEPRECATEDIssueDate | this is in ONIX format. | OceanDocTag | !ERROR! D8693 -> Formula Error: An unexpected error occurred | String |
| coverPage | cover page (PrintedAsSeen string), to generate results snippet thumbnail image urls | OceanDocTag | !ERROR! D8694 -> Formula Error: An unexpected error occurred | String |
| editors | Editors string for front end. | OceanDocTag | !ERROR! D8695 -> Formula Error: An unexpected error occurred | String |
| encryptedExpressionId | OceanDocTag | !ERROR! D8696 -> Formula Error: An unexpected error occurred | String | |
| segmentTime | OceanDocTag | !ERROR! D8697 -> Formula Error: An unexpected error occurred | integer | |
| viewability | Volume viewability, which defines how/if the volume should be displayed in various locales. | OceanDocTag | !ERROR! D8698 -> Formula Error: An unexpected error occurred | OceanVolumeViewability |
| pageNumber | page_number of the page (OceanTypes::PageNumberType) In CAv2: page_number of the page ocean::PageNumber::T | OceanDocTag | !ERROR! D8699 -> Formula Error: An unexpected error occurred | integer |
| sourceType | The source type of the document. See BoundVolumeSource::SourceType in ocean/data/volume_types.protodevel for possible values. | OceanDocTag | !ERROR! D8700 -> Formula Error: An unexpected error occurred | integer |
| blockSnippet | OceanDocTag | !ERROR! D8701 -> Formula Error: An unexpected error occurred | boolean | |
| newspaperspecific | OceanDocTag | !ERROR! D8702 -> Formula Error: An unexpected error occurred | OceanDocTagNewspaperSpecific | |
| encryptedVolumeId | OceanDocTag | !ERROR! D8703 -> Formula Error: An unexpected error occurred | String | |
| volumeVersion | The version of the volume (serialized form). ONLY populated for Volume level docs | OceanDocTag | !ERROR! D8704 -> Formula Error: An unexpected error occurred | String |
| isLandingPage | whether this a landing page chosen at indexing time. | OceanDocTag | !ERROR! D8705 -> Formula Error: An unexpected error occurred | boolean |
| availableDownloads | A bitmap containing all available download formats (values defined in AvaialableDownloadFormats enum) NOTE: Only populated for Volume level docs | OceanDocTag | !ERROR! D8706 -> Formula Error: An unexpected error occurred | integer |
| contributor | OceanDocTag | !ERROR! D8707 -> Formula Error: An unexpected error occurred | list(OceanDocTagContributor) | |
| objectionableContentBitmap | A bitmap indicating whether content may be objectionable NOTE: Only populated for volume level docs | OceanDocTag | !ERROR! D8708 -> Formula Error: An unexpected error occurred | integer |
| pagerank | the page rank value of the book page | OceanDocTag | !ERROR! D8709 -> Formula Error: An unexpected error occurred | float |
| searchInBookUrl | the URL for the “search in book” | OceanDocTag | !ERROR! D8710 -> Formula Error: An unexpected error occurred | String |
| contentType | The content type of the document. See BoundVolumeSource::ContentType in ocean/data/volume_types.protodevel for possible values. | OceanDocTag | !ERROR! D8711 -> Formula Error: An unexpected error occurred | integer |
| workcluster | OceanDocTag | !ERROR! D8712 -> Formula Error: An unexpected error occurred | OceanDocTagWorkCluster | |
| price | Price information for a volume (per locale). Note existence of a price for a locale implies that the book is sellable for that locale. | OceanDocTag | !ERROR! D8713 -> Formula Error: An unexpected error occurred | OceanGEPrice |
| DEPRECATEDApplicationDate | this is in ONIX format. | OceanDocTag | !ERROR! D8714 -> Formula Error: An unexpected error occurred | String |
| goodTextDetail | Text quality as defined in CA_VolumeScoreResult::OACapabilities::TextQualityAssessment Note – This is only populated if good_text() and is_ge_quality() are true | OceanDocTag | !ERROR! D8715 -> Formula Error: An unexpected error occurred | integer |
| patentspecific | OceanDocTag | !ERROR! D8716 -> Formula Error: An unexpected error occurred | OceanDocTagPatentSpecific | |
| bookspecific | OceanDocTag | !ERROR! D8717 -> Formula Error: An unexpected error occurred | OceanDocTagBookSpecific | |
| structuredPageNumber | In CAv2 only: structured page number (printed number as we understand it) (result of ocean::StructuredPageNumberProto::AppendToString) | OceanDocTag | !ERROR! D8718 -> Formula Error: An unexpected error occurred | String |
| catalogspecific | OceanDocTag | !ERROR! D8719 -> Formula Error: An unexpected error occurred | OceanDocTagCatalogSpecific | |
| authors | TODO(leonid) Deprecate these Authors string for front end. | OceanDocTag | !ERROR! D8720 -> Formula Error: An unexpected error occurred | String |
| refPageUrl | the URL of the reference page (About this book) | OceanDocTag | !ERROR! D8721 -> Formula Error: An unexpected error occurred | String |
| numPages | Number of pages in this volume (usually as specified in metadata) | OceanDocTag | !ERROR! D8722 -> Formula Error: An unexpected error occurred | integer |
| metadataCoverExists | metadata_cover_exists will be set if there’s a metadata-provided cover thumbnail. the thumbnail will be used for scanless books or when a scanned book is in metadata-only view. | OceanDocTag | !ERROR! D8723 -> Formula Error: An unexpected error occurred | boolean |
| subjectBitmap | Bitmap indicating top-level subjects associated with this document. See ocean/metadata/subjects/util.h for more detail. | OceanDocTag | !ERROR! D8724 -> Formula Error: An unexpected error occurred | String |
| subTitle | Sub title string for front end | OceanDocTag | !ERROR! D8725 -> Formula Error: An unexpected error occurred | String |
| thumbnailUrl | the URL of the cover page. | OceanDocTag | !ERROR! D8726 -> Formula Error: An unexpected error occurred | String |
| coverPageSize | The size (in pixels) of the full-resolution clean images used for the cover page. The width and height will be zero if no image for that page. | OceanDocTag | !ERROR! D8727 -> Formula Error: An unexpected error occurred | OceanImageSize |
| isGeQuality | Set to true if volume has ge quality | OceanDocTag | !ERROR! D8728 -> Formula Error: An unexpected error occurred | boolean |
| DEPRECATEDPatentNumber | patent-specific fields. ALL DEPRECATED, moved into PatentSpecific group, above. | OceanDocTag | !ERROR! D8729 -> Formula Error: An unexpected error occurred | String |
| DEPRECATEDPublisherPercentVisible | Percent rights granted by publisher. This should only be set, and definitely should only be considered, if source_type == BoundVolumeSource::PUBLISHER. ‘0’ may mean we have no info on publisher rights so we have to just assume 0%. Deprecated as this is taken into account by viewability | OceanDocTag | !ERROR! D8730 -> Formula Error: An unexpected error occurred | integer |
| metadataCoverSize | The size (in pixels) of the metadata cover image. | OceanDocTag | !ERROR! D8731 -> Formula Error: An unexpected error occurred | OceanImageSize |
| geoRestrict | DEPRECATED! Being replaced in favor of viewability, below. geo restrict info (from OceanRights::geo_restrict) In CAv2: geo restrict info (from ocean::VolumeImprintRights::geo_restrict) | OceanDocTag | !ERROR! D8732 -> Formula Error: An unexpected error occurred | list(String) |
| printedPageNumber | printed page number (OceanPrintedPageNumber; from OceanPageInfoMap::Page::printed_page_number) | OceanDocTag | !ERROR! D8733 -> Formula Error: An unexpected error occurred | String |
| magazinespecific | OceanDocTag | !ERROR! D8734 -> Formula Error: An unexpected error occurred | OceanDocTagMagazineSpecific | |
| volumeType | OceanDocTag | !ERROR! D8735 -> Formula Error: An unexpected error occurred | integer | |
| urlKey | Bibkey to be used as part of the URL (to make them persistent in some sense). This is obtained by doing a GetURLKey() on the bibdata which returns the main bibkey associated with the volume based on priority. This is parseable into an OceanVolumeBibKey (ocean/metadata/bibkeys.h) Note: This should ideally be a required field longer term but for now keeping it optional for compatibility. In case of this being absent, we don’t include the key in the URL (just use volumeId as before). Note: For content type books, this key is supplemented by other bibkeys for this volumes(the field is aux_bibkeys) | OceanDocTag | !ERROR! D8736 -> Formula Error: An unexpected error occurred | String |
| DEPRECATEDPatentAssignee | OceanDocTag | !ERROR! D8737 -> Formula Error: An unexpected error occurred | String | |
| pageid | pageid of the page (OceanTypes::PageIdType) | OceanDocTag | !ERROR! D8738 -> Formula Error: An unexpected error occurred | integer |
| grantableLocale | List of locales for which this book can be bought from a publisher, and read as a Google eBook. Each locale is a lowercase, two-letter country-code (eg “ca”), and is copied from PublisherGrantability.Locale.locale, defined in ocean/data/docinfo/volume_viewability.proto. | OceanDocTag | !ERROR! D8739 -> Formula Error: An unexpected error occurred | list(String) |
| title | Title string for front end. | OceanDocTag | !ERROR! D8740 -> Formula Error: An unexpected error occurred | String |
| usingActualCover | using_actual_cover will be set if we are using the actual cover of the book (instead of the table of content, etc.). This is particularly useful to identify books where we inserted a generated cover via Coverups. | OceanDocTag | !ERROR! D8741 -> Formula Error: An unexpected error occurred | boolean |
| auxBibkeys | These are other bibkeys for this book beside the url_key, which is the primary key. For example, a book may have ISBN, OCLC num etc. In that case ISBN is the url_key and the OCLC number is the auxillary bibkey. The aux_bibkeys should have the same form as the url_key | OceanDocTagBookSpecific | Book specific fields. | list(String) |
| imprint | OceanDocTagBookSpecific | Book specific fields. | String | |
| numRatingHalfStars | OceanDocTagBookSpecific | Book specific fields. | integer | |
| numberingrange | OceanDocTagBookSpecific | Book specific fields. | list(OceanDocTagBookSpecificNumberingRange) | |
| partnerId | publisher id, if available | OceanDocTagBookSpecific | Book specific fields. | String |
| productEditionNumber | Set if the book is one of several editions or versions. Used by OFE to show numbered editions. The value is copied from clustering information. See also ocean/metadata/proto/bibdata_components.proto The value there is from metadata records by ocean/metadata/parsing/parse_utils.cc, and is a 1-based value. | OceanDocTagBookSpecific | Book specific fields. | integer |
| publicationDate | In the format yyyy.mm.dd, or possibly just yyyy. | OceanDocTagBookSpecific | Book specific fields. | String |
| publisherName | OceanDocTagBookSpecific | Book specific fields. | String | |
| subject | Subject (from Bisac) | OceanDocTagBookSpecific | Book specific fields. | String |
| endNumbering | OceanDocTagBookSpecificNumberingRange | These are copies of MetadataNumberingRange’s from ocean/metadata/metadata_range.proto. They should be used for rendering volume numbering information in search results (as this protobuf is the only piece of data available at that point). The numbering can look like “Volume 1” or “Parts A-D” Schema is volume/part/etc, type arabic number/roman number/letter/etc (these are both enums from ocean/metadata/metadata_enums.proto). In most cases there is only one numbering range (e.g. “Volume 1, Issue 2”), but in general the ranges may be disjoint (e.g. “Volumes 2, 3 and 7”) | list(String) | |
| numberType | OceanDocTagBookSpecificNumberingRange | These are copies of MetadataNumberingRange’s from ocean/metadata/metadata_range.proto. They should be used for rendering volume numbering information in search results (as this protobuf is the only piece of data available at that point). The numbering can look like “Volume 1” or “Parts A-D” Schema is volume/part/etc, type arabic number/roman number/letter/etc (these are both enums from ocean/metadata/metadata_enums.proto). In most cases there is only one numbering range (e.g. “Volume 1, Issue 2”), but in general the ranges may be disjoint (e.g. “Volumes 2, 3 and 7”) | list(integer) | |
| numberingSchema | OceanDocTagBookSpecificNumberingRange | These are copies of MetadataNumberingRange’s from ocean/metadata/metadata_range.proto. They should be used for rendering volume numbering information in search results (as this protobuf is the only piece of data available at that point). The numbering can look like “Volume 1” or “Parts A-D” Schema is volume/part/etc, type arabic number/roman number/letter/etc (these are both enums from ocean/metadata/metadata_enums.proto). In most cases there is only one numbering range (e.g. “Volume 1, Issue 2”), but in general the ranges may be disjoint (e.g. “Volumes 2, 3 and 7”) | list(integer) | |
| startNumbering | OceanDocTagBookSpecificNumberingRange | These are copies of MetadataNumberingRange’s from ocean/metadata/metadata_range.proto. They should be used for rendering volume numbering information in search results (as this protobuf is the only piece of data available at that point). The numbering can look like “Volume 1” or “Parts A-D” Schema is volume/part/etc, type arabic number/roman number/letter/etc (these are both enums from ocean/metadata/metadata_enums.proto). In most cases there is only one numbering range (e.g. “Volume 1, Issue 2”), but in general the ranges may be disjoint (e.g. “Volumes 2, 3 and 7”) | list(String) | |
| latest | Is this the latest issue of this catalog series? This is required to filter results if the latest restrict is on. | OceanDocTagCatalogSpecific | catalog-specific fields. | boolean |
| publicationDate | time_t date corresponding to the catalog publication date. Approximate when the catalog does not have an exact “date” of publication, e.g. For “Spring 2002”, year, month and day are 2002, 03 and 21, respectivley. This value is used to compare catalog issues to determine the latest. The value is stored in seconds-since-epoch, 1/1/1970. This is not a problem for catalogs because we are not dealing with any catalogs from before the 70’s. | OceanDocTagCatalogSpecific | catalog-specific fields. | integer |
| publicationTimeToDisplay | String to be displayed as catalog publication time, e.g. “Spring 2002”. | OceanDocTagCatalogSpecific | catalog-specific fields. | String |
| name | OceanDocTagContributor | The composite descriptor of the contributors that should be known to search and front end. Both fields are required. Replaces authors and editors strings. | String | |
| type | ContributionType enum from ocean/metadata/metadata_enums.proto Note that we pick only the “highest-ranking” contribution (i.e. writer and editor would collapse to “writer”. | OceanDocTagContributor | The composite descriptor of the contributors that should be known to search and front end. Both fields are required. Replaces authors and editors strings. | integer |
| displayDate | A human-readable date for display in the UI. Unlike “publication_date_” above, this should not be parsed into structured data, but should only be displayed as is. | OceanDocTagMagazineSpecific | Magazine-specific fields. See https://www.corp.google.com/eng/designdocs/scanning/magazines/designdoc.html for magazine design doc. | String |
| issueDescription | Description specific to a magazine issue, such as featured articles and article summaries. | OceanDocTagMagazineSpecific | Magazine-specific fields. See https://www.corp.google.com/eng/designdocs/scanning/magazines/designdoc.html for magazine design doc. | String |
| issueEnd | OceanDocTagMagazineSpecific | Magazine-specific fields. See https://www.corp.google.com/eng/designdocs/scanning/magazines/designdoc.html for magazine design doc. | integer | |
| issueStart | OceanDocTagMagazineSpecific | Magazine-specific fields. See https://www.corp.google.com/eng/designdocs/scanning/magazines/designdoc.html for magazine design doc. | integer | |
| item | Items within a magazine issue. | OceanDocTagMagazineSpecific | Magazine-specific fields. See https://www.corp.google.com/eng/designdocs/scanning/magazines/designdoc.html for magazine design doc. | list(OceanDataDocinfoWoodwingItemMetadata) |
| otherNumberingEnd | OceanDocTagMagazineSpecific | Magazine-specific fields. See https://www.corp.google.com/eng/designdocs/scanning/magazines/designdoc.html for magazine design doc. | integer | |
| otherNumberingSchema | NOTE: These should to be values from MetadataNumberingSchema; when this becomes a proto2, we can use MetadataEnums values. | OceanDocTagMagazineSpecific | Magazine-specific fields. See https://www.corp.google.com/eng/designdocs/scanning/magazines/designdoc.html for magazine design doc. | integer |
| otherNumberingStart | For season or quarter dates. | OceanDocTagMagazineSpecific | Magazine-specific fields. See https://www.corp.google.com/eng/designdocs/scanning/magazines/designdoc.html for magazine design doc. | integer |
| pageToItem | For each page of a magazine, maps to the item index of “item”. | OceanDocTagMagazineSpecific | Magazine-specific fields. See https://www.corp.google.com/eng/designdocs/scanning/magazines/designdoc.html for magazine design doc. | list(integer) |
| publicationDateEnd | OceanDocTagMagazineSpecific | Magazine-specific fields. See https://www.corp.google.com/eng/designdocs/scanning/magazines/designdoc.html for magazine design doc. | String | |
| publicationDateStart | OceanDocTagMagazineSpecific | Magazine-specific fields. See https://www.corp.google.com/eng/designdocs/scanning/magazines/designdoc.html for magazine design doc. | String | |
| serialTitle | This is used to render the metadata line of the snippet and should be present in all magazine documents. | OceanDocTagMagazineSpecific | Magazine-specific fields. See https://www.corp.google.com/eng/designdocs/scanning/magazines/designdoc.html for magazine design doc. | String |
| serialVolumeid | OceanDocTagMagazineSpecific | Magazine-specific fields. See https://www.corp.google.com/eng/designdocs/scanning/magazines/designdoc.html for magazine design doc. | String | |
| volume | OceanDocTagMagazineSpecific | Magazine-specific fields. See https://www.corp.google.com/eng/designdocs/scanning/magazines/designdoc.html for magazine design doc. | integer | |
| articleRollCoords | Newspaper Article Roll Coordinates used to figure out the location of the article wrt the page. It is of the form x,y. | OceanDocTagNewspaperSpecific | Newspaper-specific fields. | String |
| newspaperDate | Atlantis specific. Deprecated. | OceanDocTagNewspaperSpecific | Newspaper-specific fields. | float |
| newspaperName | OceanDocTagNewspaperSpecific | Newspaper-specific fields. | String | |
| newspaperUrl | Atlantis specific. Deprecated. | OceanDocTagNewspaperSpecific | Newspaper-specific fields. | String |
| publicationDate | These fields are only populated for Santorini (newspapers on goovols) formatted newspapers, not for Atlantis: YYYY.MM.DD format. | OceanDocTagNewspaperSpecific | Newspaper-specific fields. | String |
| publisher | Atlantis specific. Deprecated. | OceanDocTagNewspaperSpecific | Newspaper-specific fields. | String |
| applicationDate | this is in ONIX format. | OceanDocTagPatentSpecific | Patent specific fields. Currently empty, but need to move the fields below into here at a later date | String |
| contentLanguage | 2-letter language of the document such as “en” or “fr” This field was created for plumbing in the OFE API intl patent flow, and is probably not otherwise filled in. | OceanDocTagPatentSpecific | Patent specific fields. Currently empty, but need to move the fields below into here at a later date | String |
| docType | OceanDocTagPatentSpecific | Patent specific fields. Currently empty, but need to move the fields below into here at a later date | integer | |
| documentNumber | Just the number, no bibkey prefix. Called ‘doc number’ b/c it could be patent number for patents, application number for applications. | OceanDocTagPatentSpecific | Patent specific fields. Currently empty, but need to move the fields below into here at a later date | String |
| domesticClassification | US and Int’l patent classification codes for “related patents”. | OceanDocTagPatentSpecific | Patent specific fields. Currently empty, but need to move the fields below into here at a later date | list(String) |
| internationalClassification | OceanDocTagPatentSpecific | Patent specific fields. Currently empty, but need to move the fields below into here at a later date | list(String) | |
| issueDate | this is in ONIX format. | OceanDocTagPatentSpecific | Patent specific fields. Currently empty, but need to move the fields below into here at a later date | String |
| patentAssignee | OceanDocTagPatentSpecific | Patent specific fields. Currently empty, but need to move the fields below into here at a later date | String | |
| publicationNumber | For applications, the ‘publication number’ Something like US20071234567A1: ‘US’ prefix, 4 digit year, 7 digit serial number, 2 character code, all stuck together. | OceanDocTagPatentSpecific | Patent specific fields. Currently empty, but need to move the fields below into here at a later date | String |
| relativeThumbnailPath | Path identifying the image used for the thumbnail of this patent. e.g. “EP1234567B1/imgf0001.png” The client is expected to fill in the rest of the url such as: https://patentimages.storage.googleapis.com/thumbnails/EP1234567B1/imgf0001.png | OceanDocTagPatentSpecific | Patent specific fields. Currently empty, but need to move the fields below into here at a later date | String |
| tenCharUsClassification | OceanDocTagPatentSpecific | Patent specific fields. Currently empty, but need to move the fields below into here at a later date | list(String) | |
| clusterSize | OceanDocTagWorkCluster | Details of the work cluster for this Volume. | integer | |
| workId | OceanDocTagWorkCluster | Details of the work cluster for this Volume. | String | |
| amountInMicros | amount in micros. 1 is represented 1000000 | OceanGEMoney | A container proto to store prices for GE | String |
| currencyCode | The currency codes come from google3/i18n/identifiers/currencycode.h. | OceanGEMoney | A container proto to store prices for GE | String |
| locale | OceanGEPrice | GE sale related data | list(OceanGEPriceLocale) | |
| locale | The two character ISO country code | OceanGEPriceLocale | String | |
| offerPrice | Price used for sale by the OFE | OceanGEPriceLocale | OceanGEMoney | |
| onSaleTimeSecs | The time (in secs from epoch) the content goes on sale (only set when the book is not already sellable at the time of indexing). | OceanGEPriceLocale | String | |
| height | pixels | OceanImageSize | Size info of an image. | integer |
| width | pixels | OceanImageSize | Size info of an image. | integer |
| accessRights | These capture “commercial” contract related access rights provided by partners for a volume. | OceanLocaleViewability | How a volume may be viewed in a particular locale. Next available ID: 25 (ikkwong) | OceanVolumeAccessRights |
| allowAddingFrontmatterToPreview | Are we allowed to add all the front matter to the preview in addition to the preview amount that is from percent_book_shown? This means the front matter becomes freely previewable and does not count towards the previewable amount based on the percentage. | OceanLocaleViewability | How a volume may be viewed in a particular locale. Next available ID: 25 (ikkwong) | boolean |
| allowContinuousBrowse | By default, we allow continuous browse. PFE provides a means for partners to opt out entirely or just specific books. | OceanLocaleViewability | How a volume may be viewed in a particular locale. Next available ID: 25 (ikkwong) | boolean |
| allowRetailSyndication | whether OFE should display this volume in syndicated search results | OceanLocaleViewability | How a volume may be viewed in a particular locale. Next available ID: 25 (ikkwong) | boolean |
| bibkey | The bibkey upon which this viewability information is based. | OceanLocaleViewability | How a volume may be viewed in a particular locale. Next available ID: 25 (ikkwong) | String |
| canDisplayAds | Whether we can show ads with this book in this locale. | OceanLocaleViewability | How a volume may be viewed in a particular locale. Next available ID: 25 (ikkwong) | boolean |
| canDownloadEpub | In future, we will generate epub iff can_download_epub = true irrespective of viewability or download pdf state. | OceanLocaleViewability | How a volume may be viewed in a particular locale. Next available ID: 25 (ikkwong) | boolean |
| canDownloadPdf | In future, we will generate PDF iff can_download_pdf = true irrespective of viewability. | OceanLocaleViewability | How a volume may be viewed in a particular locale. Next available ID: 25 (ikkwong) | boolean |
| canShowLibraryLinks | Whether to show library links for the books in this imprint. | OceanLocaleViewability | How a volume may be viewed in a particular locale. Next available ID: 25 (ikkwong) | boolean |
| canShowPhotos | Whether we can show photos for this book in this locale. | OceanLocaleViewability | How a volume may be viewed in a particular locale. Next available ID: 25 (ikkwong) | boolean |
| canUseMetadataCover | It should be OK to use metadata covers normally, but we allow publishers to explicitly disallow them. | OceanLocaleViewability | How a volume may be viewed in a particular locale. Next available ID: 25 (ikkwong) | boolean |
| clientId | The client who provided the rights for this bibkey, and who should receive revenue derived from this book in this locale. This will only be present when we receive explicit rights from a publisher. | OceanLocaleViewability | How a volume may be viewed in a particular locale. Next available ID: 25 (ikkwong) | String |
| computedAccessRights | Volume related access rights that are computed by Goovols Syncher from partner and book metadata. This complements VolumeAccessRights. This message is used to capture “commerical” contracts that are computed from other sources. Any future computed rights that are not related to volume access should go into a new message. | OceanLocaleViewability | How a volume may be viewed in a particular locale. Next available ID: 25 (ikkwong) | OceanVolumeComputedAccessRights |
| dates | OceanLocaleViewability | How a volume may be viewed in a particular locale. Next available ID: 25 (ikkwong) | OceanLocaleViewabilityDates | |
| displayDetails | Volume display specific attributes are kept in display_details | OceanLocaleViewability | How a volume may be viewed in a particular locale. Next available ID: 25 (ikkwong) | OceanVolumeDisplayDetails |
| metadataViewMayIncludeInfoFromScans | This only applies when view_type == VIEW_METADATA and controls whether we’re allowed to include scanned info (keywords, toc, etc). in the metadata-view. For books in metadata view because they have been opted out, this would be false. | OceanLocaleViewability | How a volume may be viewed in a particular locale. Next available ID: 25 (ikkwong) | boolean |
| metadataViewSampleAllowed | This only applies when view_type == VIEW_METADATA and controls whether we’re allowed to include a text sample even for a metadata view book. | OceanLocaleViewability | How a volume may be viewed in a particular locale. Next available ID: 25 (ikkwong) | boolean |
| percentBookShown | How much of the book can be viewed in this locale. Will be 100 for VIEW_FULL; 0 for VIEW_SNIPPET_, VIEW_NONE and VIEW_METADATA; and some value between 0 and 100 (exclusive) for VIEW_PARTIAL. | OceanLocaleViewability | How a volume may be viewed in a particular locale. Next available ID: 25 (ikkwong) | integer |
| publicDomain | If present, this is the rights policy’s determination of the public domain status. (Of course, this determination is generally conservative (i.e. false negatives are likely), though exactly how conservative may depend on parameters to the rights policy.) If absent, public domain status can be inferred from view_type and view_reason, but that isn’t quite perfectly reliable: view_type should always be VIEW_FULL for public domain, but view_reason might be REASON_PUBLIC_DOMAIN (definitely public domain, obviously), some other value, or absent. In the future, new viewabilities should always have this field whenever possible. | OceanLocaleViewability | How a volume may be viewed in a particular locale. Next available ID: 25 (ikkwong) | boolean |
| sourcedetails | OceanLocaleViewability | How a volume may be viewed in a particular locale. Next available ID: 25 (ikkwong) | OceanLocaleViewabilitySourceDetails | |
| viewReason | The reason for the view_type. | OceanLocaleViewability | How a volume may be viewed in a particular locale. Next available ID: 25 (ikkwong) | String |
| viewType | The viewability specified for this locale. | OceanLocaleViewability | How a volume may be viewed in a particular locale. Next available ID: 25 (ikkwong) | String |
| effectiveDate | If specified, the LocaleViewability will become effective on this date. This field is used to allow pre-indexing of future books which will become viewable and searchable according to the LocaleViewability on the specified date. Before the effective date, the volume will have scanless-like VIEW_METADATA viewability. For details, see the design document at http://go/oceanviewabilityeffectivedate. The date is expressed as the number of seconds since the Unix epoch. | OceanLocaleViewabilityDates | Viewability related dates. | String |
| imprint | OceanLocaleViewabilitySourceDetails | How did we derive this viewability for this locale+volume? For “partner” books, this includes details about the “Imprint” that provided the rights. These details specify things such as preferred buy-the-book-url to show in the frontend. | OceanVolumeImprint | |
| flags | rights, mask-availability, porn, etc. | OceanPerDocData | Per-doc data in the Ocean index. Ocean indexing details are in https://www/eng/designdocs/scanning/ocean-indexing.html | String |
| numPages | OceanPerDocData | Per-doc data in the Ocean index. Ocean indexing details are in https://www/eng/designdocs/scanning/ocean-indexing.html | integer | |
| pageNumber | 1-based | OceanPerDocData | Per-doc data in the Ocean index. Ocean indexing details are in https://www/eng/designdocs/scanning/ocean-indexing.html | integer |
| pageid | OceanPerDocData | Per-doc data in the Ocean index. Ocean indexing details are in https://www/eng/designdocs/scanning/ocean-indexing.html | integer | |
| volumeid | OceanPerDocData | Per-doc data in the Ocean index. Ocean indexing details are in https://www/eng/designdocs/scanning/ocean-indexing.html | String | |
| allowAutoGeneratedText | If false, then we can only provide text layer generated from publisher provided epub. | OceanVolumeAccessRights | boolean | |
| canShowInfoCards | Whether we can show info cards inside this book. | OceanVolumeAccessRights | boolean | |
| canShowPhotos | Whether we can show photos inside this book. | OceanVolumeAccessRights | boolean | |
| numAdeDeviceAllowed | Maximum number of Adobe Digital Editions device per sale item allowed. 0 means no download allowed. -1 means unlimited download. | OceanVolumeAccessRights | integer | |
| numAdobeIdAllowed | Maximum number of Adobe id per sale item allowed. 0 means no download allowed. -1 means unlimited download. | OceanVolumeAccessRights | integer | |
| numDownloadsAllowed | Max. number of Google eBooks downloads allowed. This is related to iPhone/iPad/Androrid/WebReader reading, not to epub/pdf downloads. 0 means no download allowed. This is related to bug #3094719. | OceanVolumeAccessRights | integer | |
| numSimultaneousAccess | Number of readers can read the Google eBooks simultaneously | OceanVolumeAccessRights | integer | |
| offlineDownload | Download type for offline reading | OceanVolumeAccessRights | String | |
| percentCopyable | How much of a volume we allow user to extract as text (for copy+paste) | OceanVolumeAccessRights | integer | |
| percentPrintable | How much of a volume we allow user to print | OceanVolumeAccessRights | integer | |
| restrictOnlyToText | True iff restrict view only to epub text. Don’t show page images if this is true. Some pubs don’t have copyright for page layout and fonts. | OceanVolumeAccessRights | boolean | |
| sellFixedLayoutAsImageOnly | Whether we sell fixed layout as image only. | OceanVolumeAccessRights | boolean | |
| textToSpeech | Whether text to speech is allowed | OceanVolumeAccessRights | boolean | |
| treatAsPublicDomain | Whether we treat this book as public domain. | OceanVolumeAccessRights | boolean | |
| canFamilyShare | Whether this book can be shared with family members. | OceanVolumeComputedAccessRights | Volume related access rights that are computed by Goovols Syncher from partner and book metadata. This complements VolumeAccessRights. Next available ID: 4 (kblass) | boolean |
| panelizationFeatureInternalOnly | Whether the panelization feature is enabled for internal users only. | OceanVolumeComputedAccessRights | Volume related access rights that are computed by Goovols Syncher from partner and book metadata. This complements VolumeAccessRights. Next available ID: 4 (kblass) | boolean |
| viewableInternalOnly | Whether the book is viewable for internal users only. | OceanVolumeComputedAccessRights | Volume related access rights that are computed by Goovols Syncher from partner and book metadata. This complements VolumeAccessRights. Next available ID: 4 (kblass) | boolean |
| ccLicense | The creative commons license specified, Please refer ocean.CreativeCommonsLicenseType.Type for enum values Not exposed in Partner Frontend anymore. | OceanVolumeDisplayDetails | This message describes display attributes. The attributes which are applicable to OFE not indexing (mustang), should be added in this proto. | integer |
| accessRights | These capture “commercial” contract related access rights provided by partners for a volume. | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | OceanVolumeAccessRights |
| adsId | Id used in the google ads system | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | String |
| allowAddingFrontmatterToPreview | Are we allowed to add all the front matter to the preview in addition to the preview amount that is from percent_book_shown? | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | boolean |
| allowContinuousBrowse | By default, we allow continuous browse. PFE provides a means for partners to opt out entirely or just specific books. This will be deprecated once UpdateVolumesReqHandler returns VolumeViewability. | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | boolean |
| allowRetailSyndication | By default, we allow retailer syndication. PFE provides a means for partner to opt out. This will be deprecated once UpdateVolumesReqHandler returns VolumeViewability. | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | boolean |
| author | Beware: the author strings are not in fixed format..these can be comma separated or ‘and’ separated or have extra terms like ‘et al’ and sometimes have weird ones like ‘no author’ as these are fed in via a somewhat flexible free text tool. | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | String |
| bibkey | Commercial info comes with book identifiers like ISBN(or some bibkey), Title, Author. Passing these along as well with the commercials for better book identification/link up with rights. | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | String |
| buyTheBookText | Text to display in the buy-the-book blurb | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | String |
| buyTheBookUrl | ISBN/ISSN-parameterized URL to the imprint’s site for buying a book. For ISBN-parameterized links, the ISBN value will be substituted in the cannonical 13-digit form. | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | String |
| canDownloadEpub | iff true volume is available as Google Edition. This will be deprecated once UpdateVolumesReqHandler returns VolumeViewability. | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | boolean |
| canDownloadPdf | iff true and VIEW_TYPE=FULL_VIEW, then we will allow PDF download This will be deprecated once UpdateVolumesReqHandler returns VolumeViewability. | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | boolean |
| canShowLibraryLinks | Whether to show library links for the books in this imprint. This will be deprecated once UpdateVolumesReqHandler returns VolumeViewability. | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | boolean |
| canUseMetadataCover | It should be OK to use metadata covers normally, but we allow publishers to explicitly disallow them. This will be deprecated once UpdateVolumesReqHandler returns VolumeViewability. | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | boolean |
| disableOtherBuyTheBookLinks | Whether to disable other btb links for the books in this imprint. Show only btb link from this partner and remove everything else. | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | boolean |
| displayDetails | Volume display specific attributes are kept in display_details This will be deprecated once UpdateVolumesReqHandler returns VolumeViewability. | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | OceanVolumeDisplayDetails |
| geBibkey | The ISBN supplied by publisher (or Google) for the Google Edition e-book. One day it should be an attribute of the tome cluster. | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | String |
| imprintId | The imprint id from the ocean devel db for this imprint. | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | String |
| imprintName | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | String | |
| imprintUrl | URL to the imprint’s website, to go to upon a click on the logo | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | String |
| logoHeight | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | integer | |
| logoLocation | URL/location for the imprint’s logo to display | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | String |
| logoWidth | The logo image’s geometry | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | integer |
| percentBookShown | Percentage of book we are allowed to display This will be deprecated once UpdateVolumesReqHandler returns VolumeViewability. | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | integer |
| promotionalText | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | String | |
| promotionalUrl | We may allow imprints to run promotional campaigns. The following fields capture the blurb to display and the URL (ISBN-parameterized) link to provide. | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | String |
| publishedImprintName | Sometimes the Publisher/Imprint Name the book is published under is different from the current name and we may have this information. | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | String |
| pviRowid | Need a unique identifier for PFE records, using PVI ID | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | String |
| title | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | String | |
| useBibdata | Some records are deactivated, suppressed or excluded; we still want to hear about them, but we aren’t going to be using their bibdata | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | boolean |
| verticalType | OceanVolumeImprint | Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes. | String | |
| DEPRECATEDDefaultViewType | OceanVolumeViewability | integer | ||
| defaultViewability | The viewability for any locale that is not explicitly listed. | OceanVolumeViewability | OceanLocaleViewability | |
| inViewabilityLimbo | DEPRECATED: Viewability-Limbo was a state that prevented indexing from running if the viewability of a volume had dropped significantly. It was removed during viewability refactoring: http://go/viewability | OceanVolumeViewability | boolean | |
| locale | OceanVolumeViewability | list(OceanVolumeViewabilityLocale) | ||
| updatedByIndexer | Whether the volume viewability was updated by the indexer as opposed to a direct update in goovols. The absense of this bit will indicate to the indexer that it should not short-circuit indexing side effects that should occur when viewability changes. | OceanVolumeViewability | boolean | |
| DEPRECATEDViewType | OceanVolumeViewabilityLocale | integer | ||
| locale | The two-character ISO country code for the locale. | OceanVolumeViewabilityLocale | String | |
| viewability | The viewability specified for this locale. | OceanVolumeViewabilityLocale | OceanLocaleViewability | |
| angle | Angle of rotation of (in degrees, clockwise is positive) of the box about the top-left corner. | OcrPhotoBoundingBox | Bounding box of patch containing line, word or symbol. | number |
| curvedBox | Sequence of rotated boxes that tightly enclose the text. | OcrPhotoBoundingBox | Bounding box of patch containing line, word or symbol. | OcrPhotoCurvedBoundingBox |
| height | Box height (bottom pixels at top + height – 1). | OcrPhotoBoundingBox | Bounding box of patch containing line, word or symbol. | integer |
| left | x coordinate of top-left corner | OcrPhotoBoundingBox | Bounding box of patch containing line, word or symbol. | integer |
| top | y coordinate of top-left corner | OcrPhotoBoundingBox | Bounding box of patch containing line, word or symbol. | integer |
| width | Box width (rightmost pixels at left + width – 1). | OcrPhotoBoundingBox | Bounding box of patch containing line, word or symbol. | integer |
| points | The sequence of points that approximate the curve. | OcrPhotoCurve | Copy of ocr/goodoc/layout-common.proto:CurvedBoundingBox, temporary duplicated here to allow for on-device builds. | list(OcrPhotoCurvePoint) |
| midLineCurve | The curve of points along the middle of the text line. | OcrPhotoCurvedBoundingBox | OcrPhotoCurve | |
| thickness | If top_to_bottom is true, this is the width of the curved box. Otherwise, it is the height of the curved box. | OcrPhotoCurvedBoundingBox | float | |
| topToBottom | If true, the curve is interpreted as top to bottom of the line image. Otherwise, it is from left to right. | OcrPhotoCurvedBoundingBox | boolean | |
| x | OcrPhotoCurvePoint | float | ||
| y | NOTE: if we wish to support perspective (varying thickness), later on we could extend this message with a thickness field. In that case, CurvedBoundingBox.thickness() would be used as a default if !Point.has_thickness(). | OcrPhotoCurvePoint | float | |
| blockId | ID of the text block that this line belongs to. | OcrPhotoTextBox | Text with bounding box. | integer |
| box | Text bounding box. | OcrPhotoTextBox | Text with bounding box. | OcrPhotoBoundingBox |
| contentType | Content type for this box. | OcrPhotoTextBox | Text with bounding box. | String |
| symbolWidths | Optional width of characters in the text. | OcrPhotoTextBox | Text with bounding box. | list(integer) |
| text | Text string. | OcrPhotoTextBox | Text with bounding box. | String |
| country | OfficialPagesOfficialKey | This proto is used as the key for official pages data. WARNING WARNING WARNING WARNING WARNING PAY ATTENTION HERE! The query field contains a specially NORMALIZED query, NOT a raw one. You can get a normalized query in several ways: 1. from an squery with NormalizedQueryFromSquery 2. from a CJK-segmented and punctuation-stripped query with NormalizeText (NOTE: navboost queries are already CJK-segmented and punctuation-stripped, you can just pass them to NormalizeText) 3. from user text/query with CanonicalizeText (this will do the CJK segmenting, punctuation stripping and character normalization for you) All of these functions are in ./utils/external-utils.h | String | |
| language | OfficialPagesOfficialKey | This proto is used as the key for official pages data. WARNING WARNING WARNING WARNING WARNING PAY ATTENTION HERE! The query field contains a specially NORMALIZED query, NOT a raw one. You can get a normalized query in several ways: 1. from an squery with NormalizedQueryFromSquery 2. from a CJK-segmented and punctuation-stripped query with NormalizeText (NOTE: navboost queries are already CJK-segmented and punctuation-stripped, you can just pass them to NormalizeText) 3. from user text/query with CanonicalizeText (this will do the CJK segmenting, punctuation stripping and character normalization for you) All of these functions are in ./utils/external-utils.h | integer | |
| query | OfficialPagesOfficialKey | This proto is used as the key for official pages data. WARNING WARNING WARNING WARNING WARNING PAY ATTENTION HERE! The query field contains a specially NORMALIZED query, NOT a raw one. You can get a normalized query in several ways: 1. from an squery with NormalizedQueryFromSquery 2. from a CJK-segmented and punctuation-stripped query with NormalizeText (NOTE: navboost queries are already CJK-segmented and punctuation-stripped, you can just pass them to NormalizeText) 3. from user text/query with CanonicalizeText (this will do the CJK segmenting, punctuation stripping and character normalization for you) All of these functions are in ./utils/external-utils.h | String | |
| queries | OfficialPagesQuerySet | list(OfficialPagesOfficialKey) | ||
| queryCountryLanguageFingerprints | This is the fingerprint of the OfficialKey queries in the queries field. The index of a fingerprint in this field corresponds to the index of the fingerprinted query in the queries field. The fingerprint is produced with the QueryCountryLanguageFingerprint function in external-utils.h | OfficialPagesQuerySet | list(String) | |
| docid | OrionDocEntitiesProto | String | ||
| encodedEntity | This is encoded using EntityCandidate::Encode | OrionDocEntitiesProto | list(integer) | |
| confidenceValue | PairwiseQScoringData | number | ||
| value | PairwiseQScoringData | number | ||
| confidenceValue | The PairwiseQ confidence value corresponding to this version. | PairwiseQVersionedItem | Message representing a versioned PairwiseQ scores used for experimentation. This protobuf is copied from quality_nsr_pairwiseq::PairwiseQVersionedItem. | number |
| value | The PairwiseQ value corresponding to this version. | PairwiseQVersionedItem | Message representing a versioned PairwiseQ scores used for experimentation. This protobuf is copied from quality_nsr_pairwiseq::PairwiseQVersionedItem. | number |
| versionId | The version id. | PairwiseQVersionedItem | Message representing a versioned PairwiseQ scores used for experimentation. This protobuf is copied from quality_nsr_pairwiseq::PairwiseQVersionedItem. | integer |
| application | All evaluations are done within the context of a given application, e.g., “Gmail” and should not be reused in other apps. | PeoplestackFlexorgsProtoInternalExternal | String | |
| stateStatus | * There can be multiple states based on the context: 1. AUTOCOMPLETE + Gmail – context 1 2. AUTOCOMPLETE + Chat/Dynamite – context 2 3. “SOME OTHER ACTION” + Gmail – context 3 A client should identify whether a patrticular context is present in the list and only if one is found – use the state that goes alogn with the context, otherwise the client should default to whatever is the safe assumption about “internality/externality” the application should be making (likely, consider everything not explicitly “internal” as “external”). | PeoplestackFlexorgsProtoInternalExternal | list(PeoplestackFlexorgsProtoInternalExternalStateStatus) | |
| contextType | PeoplestackFlexorgsProtoInternalExternalStateStatus | String | ||
| state | PeoplestackFlexorgsProtoInternalExternalStateStatus | String | ||
| scienceDoctype | Scholar/Science Document type: <0 == not a Science Document -- default 0 == Science doc fully visible >0 == Science doc but limited visibility, the number is the visible terms | PerDocData | !ERROR! D8919 -> Formula Error: Unexpected , | integer |
| ScaledExptIndyRank2 | experimental | PerDocData | !ERROR! D8920 -> Formula Error: Unexpected , | integer |
| videoLanguage | Audio-based language classified by Automatic Language Identification (only for watch pages). | PerDocData | !ERROR! D8921 -> Formula Error: Unexpected , | QualityVidyaVideoLanguageVideoLanguage |
| phildata | PerDocData | !ERROR! D8922 -> Formula Error: Unexpected , | PhilPerDocData | |
| uacSpamScore | The uac spam score is represented in 7 bits, going from 0 to 127. Threshold is 64. Score >= 64 is considered as uac spam. | PerDocData | !ERROR! D8923 -> Formula Error: Unexpected , | integer |
| DEPRECATEDAuthorObfuscatedGaia | The obfuscated google profile gaia id(s) of the author(s) of the document. This field is deprecated, use the string version. | PerDocData | !ERROR! D8924 -> Formula Error: Unexpected , | list(String) |
| spamtokensContentScore | For SpamTokens content scores. Used in SiteBoostTwiddler to determine whether a page is UGC Spam. See go/spamtokens-dd for details. | PerDocData | !ERROR! D8925 -> Formula Error: Unexpected , | number |
| webrefEntities | WebRef entities associated to the document. See go/webref for details. | PerDocData | !ERROR! D8926 -> Formula Error: Unexpected , | RepositoryWebrefWebrefMustangAttachment |
| PremiumData | Additional metadata for Premium document in the Google index. | PerDocData | !ERROR! D8927 -> Formula Error: Unexpected , | PremiumPerDocData |
| spamMuppetSignals | Contains hacked site signals which will be used in query time joins. As of Oct’19, the field is stored in a separate corpus. It’ll only be populated for in-flight requests between retrieve and full-score in perdocdata. So no extra storage is needed on muppet side. | PerDocData | !ERROR! D8928 -> Formula Error: Unexpected , | SpamMuppetjoinsMuppetSignals |
| knexAnnotation | For indexing k’nex annotations for FreshDocs. | PerDocData | !ERROR! D8929 -> Formula Error: Unexpected , | SocialPersonalizationKnexAnnotation |
| smartphoneData | Additional metadata for smartphone documents in the Google index. | PerDocData | !ERROR! D8930 -> Formula Error: Unexpected , | SmartphonePerDocData |
| semanticDateConfidence | DEPRECATED: semantic_date_confidence replaced by semantic_date_info. | PerDocData | !ERROR! D8931 -> Formula Error: Unexpected , | integer |
| trendspamScore | For now, the count of matching trendspam queries. | PerDocData | !ERROR! D8932 -> Formula Error: Unexpected , | integer |
| ScaledSpamScoreYoram | Spamscores are represented as a 7-bit integer, going from 0 to 127. | PerDocData | !ERROR! D8933 -> Formula Error: Unexpected , | integer |
| numUrls | Total number of urls encoded in the url section = # of alternate urls + 1 | PerDocData | !ERROR! D8934 -> Formula Error: Unexpected , | integer |
| datesInfo | Stores dates-related info (e.g. page is old based on its date annotations). Used in FreshnessTwiddler. Use encode/decode functions from quality/timebased/utils/dates-info-helper-inl.h | PerDocData | !ERROR! D8935 -> Formula Error: Unexpected , | String |
| pagerank2 | PerDocData | !ERROR! D8936 -> Formula Error: Unexpected , | number | |
| nsrDataProto | Stripped site-level signals, not present in the explicit nsr_* fields, nor compressed_quality_signals. | PerDocData | !ERROR! D8937 -> Formula Error: Unexpected , | QualityNsrNsrData |
| fringeQueryPrior | Contains encoded FringeQueryPrior information. Unlikely to be meaningful for anyone other than fringe-ranking team. Contact fringe-ranking team if any questions, but do NOT use directly without consulting them. | PerDocData | !ERROR! D8938 -> Formula Error: Unexpected , | QualityFringeFringeQueryPriorPerDocData |
| kaltixdata | PerDocData | !ERROR! D8939 -> Formula Error: Unexpected , | KaltixPerDocData | |
| ymylHealthScore | Stores scores of ymyl health classifier as defined at go/ymyl-classifier-dd. To use this field, you MUST join g/pq-classifiers-announce and add your use case at http://shortn/_nfg9oAldou. | PerDocData | !ERROR! D8940 -> Formula Error: Unexpected , | integer |
| authorObfuscatedGaiaStr | PerDocData | !ERROR! D8941 -> Formula Error: Unexpected , | list(String) | |
| lastSignificantUpdate | Last significant update of the document. This is sourced from the quality_timebased.LastSignificantUpdate proto as computed by the LSUSelector from various signals. The value is a UNIX timestamp in seconds. | PerDocData | !ERROR! D8942 -> Formula Error: Unexpected , | String |
| spambrainData | Host-v1 sitechunk level scores coming from spambrain. | PerDocData | !ERROR! D8943 -> Formula Error: Unexpected , | SpamBrainData |
| DEPRECATEDQuarantineWhitelist | PerDocData | !ERROR! D8944 -> Formula Error: Unexpected , | boolean | |
| tundraClusterId | This field is propagated to shards. Stores clustering information on a site level for the Tundra project. This field is deprecated – used the equivalent field inside nsr_data_proto instead. | PerDocData | !ERROR! D8945 -> Formula Error: Unexpected , | integer |
| bodyWordsToTokensRatioTotal | PerDocData | !ERROR! D8946 -> Formula Error: Unexpected , | number | |
| homepagePagerankNs | The page-rank of the homepage of the site. Copied from the cdoc.doc().pagerank_ns() of the homepage. | PerDocData | !ERROR! D8947 -> Formula Error: Unexpected , | integer |
| topPetacatTaxId | Top petacat of the site. Used in SiteboostTwiddler to determine result/query matching. | PerDocData | !ERROR! D8948 -> Formula Error: Unexpected , | integer |
| OriginalContentScore | The original content score is represented as a 7-bits, going from 0 to 127. Only pages with little content have this field. The actual original content score ranges from 0 to 512. It is encoded with quality_q2::OriginalContentUtil::EncodeOriginalContentScore(). To decode the value, use quality_q2::OriginalContentUtil::DecodeOriginalContentScore(). | PerDocData | !ERROR! D8949 -> Formula Error: Unexpected , | integer |
| contentAttributions | PerDocData | !ERROR! D8950 -> Formula Error: Unexpected , | ContentAttributions | |
| webmirrorEcnFp | PerDocData | !ERROR! D8951 -> Formula Error: Unexpected , | String | |
| DocLevelSpamScore | The document spam score is represented as a 7-bits, going from 0 to 127. | PerDocData | !ERROR! D8952 -> Formula Error: Unexpected , | integer |
| urlPoisoningData | Contains url poisoning data for suppressing spam documents. | PerDocData | !ERROR! D8953 -> Formula Error: Unexpected , | UrlPoisoningData |
| Event | Free form debug info. NB2: consider carefully what to save here. It’s easy to eat lots of gfs space with debug info that nobody needs… | PerDocData | !ERROR! D8954 -> Formula Error: Unexpected , | list(PerDocDebugEvent) |
| mediaOrPeopleEntities | Contains the mids of the 5 most topical entities annotated with selected KG collections. This information is currently used on Image Search to detect cases where results converged to mostly a single person or media entity. More details: go/result-set-convergence. | PerDocData | !ERROR! D8955 -> Formula Error: Unexpected , | ImageQualitySensitiveMediaOrPeopleEntities |
| scaledSelectionTierRank | Selection tier rank is a language normalized score ranging from 0-32767 over the serving tier (Base, Zeppelins, Landfills) for this document. This is converted back to fractional position within the index tier by scaled_selection_tier_rank/32767. | PerDocData | !ERROR! D8956 -> Formula Error: Unexpected , | integer |
| pageTags | PerDocData | !ERROR! D8957 -> Formula Error: Unexpected , | list(integer) | |
| smearingMaxTotalOffdomainAnchors | PerDocData | !ERROR! D8958 -> Formula Error: Unexpected , | integer | |
| pagerank | Experimental pageranks (DEPRECATED; only pagerank in MustangBasicInfo is used). | PerDocData | !ERROR! D8959 -> Formula Error: Unexpected , | number |
| QuarantineInfo | bitmask of QuarantineBits (or’d together) used to store quarantine related information. For example: QUARANTINE_WHITELIST | QUARANTINE_URLINURL. | PerDocData | !ERROR! D8960 -> Formula Error: Unexpected , | integer |
| rosettaLanguages | Top two document language BCP-47 codes as generated by the RosettaLanguageAnnotator in the decreasing order of probability. | PerDocData | !ERROR! D8961 -> Formula Error: Unexpected , | list(String) |
| freshnessEncodedSignals | Stores freshness and aging related data, such as time-related quality metrics predicted from url-pattern level signals. Use the encoding decoding API in quality/freshness/docclassifier/aging/encoded-pattern-signals.h This field is deprecated. | PerDocData | !ERROR! D8962 -> Formula Error: Unexpected , | String |
| imagedata | PerDocData | !ERROR! D8963 -> Formula Error: Unexpected , | ImagePerDocData | |
| videoCorpusDocid | PerDocData | !ERROR! D8964 -> Formula Error: Unexpected , | String | |
| queriesForWhichOfficial | The set of (query, country, language) triples for which this document is considered to be the official page. For example, www.britneyspears.com would be official for (“britney spears”, “us”, 0) and others (0 is English). | PerDocData | !ERROR! D8965 -> Formula Error: Unexpected , | OfficialPagesQuerySet |
| nsrIsCovidLocalAuthority | This field is propagated to shards. In addition, it is populated at serving time by go/web-signal-joins. This field is deprecated – used the equivalent field inside nsr_data_proto instead. | PerDocData | !ERROR! D8966 -> Formula Error: Unexpected , | boolean |
| crawlerIdProto | For crawler-ID variations, the crawling context applied to the document. See go/url, and the description in google3/indexing/crawler_id | PerDocData | !ERROR! D8967 -> Formula Error: Unexpected , | LogsProtoIndexingCrawlerIdCrawlerIdProto |
| ScaledSpamScoreEric | PerDocData | !ERROR! D8968 -> Formula Error: Unexpected , | integer | |
| biasingdata | PerDocData | !ERROR! D8969 -> Formula Error: Unexpected , | BiasingPerDocData | |
| ScaledExptSpamScoreEric | PerDocData | !ERROR! D8970 -> Formula Error: Unexpected , | integer | |
| v2KnexAnnotation | For indexing v2 k’nex, see/go/knex-v2-doc-annotation for details. | PerDocData | !ERROR! D8971 -> Formula Error: Unexpected , | QualitySherlockKnexAnnotation |
| MobileData | Additional metadata for lowend mobile documents in the Google index. | PerDocData | !ERROR! D8972 -> Formula Error: Unexpected , | MobilePerDocData |
| BookCitationData | the book citation data for each web page, the average size is about 10 bytes | PerDocData | !ERROR! D8973 -> Formula Error: Unexpected , | BookCitationPerDocData |
| semanticDate | SemanticDate, estimated date of the content of a document based on the contents of the document (via parsing), anchors and related documents. Date is encoded as a 32-bits UNIX date (1970 Jan 1 epoch). Confidence is encoded using a SemanticDate specific format. For details of encoding, please refer to quality/freshness/docclassifier/semanticdate/public/semantic_date.proto | PerDocData | !ERROR! D8974 -> Formula Error: Unexpected , | integer |
| biasingdata2 | A replacement for BiasingPerDocData that is more space efficient. Once this is live everywhere, biasingdata will be deprecated. | PerDocData | !ERROR! D8975 -> Formula Error: Unexpected , | BiasingPerDocData2 |
| ymylNewsScore | Stores scores of ymyl news classifier as defined at go/ymyl-classifier-dd. To use this field, you MUST join g/pq-classifiers-announce and add your use case at http://shortn/_nfg9oAldou. | PerDocData | !ERROR! D8976 -> Formula Error: Unexpected , | integer |
| saftLanguageInt | Top document language as generated by SAFT LangID. For now we store bare minimum: just the top 1 language value, converted to the language enum, and only when different from the first value in ‘languages’. | PerDocData | !ERROR! D8977 -> Formula Error: Unexpected , | list(integer) |
| rsApplication | Application information associated to the document. | PerDocData | !ERROR! D8978 -> Formula Error: Unexpected , | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication |
| domainAge | 16-bit | PerDocData | !ERROR! D8979 -> Formula Error: Unexpected , | integer |
| lastSignificantUpdateInfo | Metadata about last significant update. Currently this only encodes the quality_timebased.LastSignificantUpdate.source field which contains the info on the source of the signal. NOTE: Please do not read the value directly. Use helpers from quality/timebased/lastsignificantupdate/lsu-helper.h instead. | PerDocData | !ERROR! D8980 -> Formula Error: Unexpected , | String |
| pagerank1 | PerDocData | !ERROR! D8981 -> Formula Error: Unexpected , | number | |
| spamCookbookAction | Actions based on Cookbook recipes that match the page. | PerDocData | !ERROR! D8982 -> Formula Error: Unexpected , | SpamCookbookAction |
| compressedUrl | Compressed URL string used for SETI. | PerDocData | !ERROR! D8983 -> Formula Error: Unexpected , | String |
| extraData | This field is available only in the docjoins: it is cleared before building per-doc data in both Mustang and Teragoogle. (MessageSet is inefficient in space for serving data) Use this for all new fields that aren’t needed during serving. Currently this field contains: * UrlSignals for the document level spam classifier (when the doclevelspamscore is set). * PerDocLangidData and realtimespam::ClassifierResult for the document level fresh spam classifier (when the doc-level fresh spam score is generated). * MicroblogDocQualitySignals for document-level microblog spam classifier. This only exists in Firebird for now. * spam_buckets::BucketsData for a document-structure hash This field is non-personal since the personal fields in MessageSet are not populated in production. | PerDocData | !ERROR! D8984 -> Formula Error: Unexpected , | Proto2BridgeMessageSet |
| socialgraphNodeNameFp | For Social Search we store the fingerprint of the SG node name. This is used in one of the superroot’s PRE_DOC twiddlers as a lookup key for the full Social Search data. PRE_DOC = twiddlers firing before the DocInfo request is sent to the mustang backend. | PerDocData | !ERROR! D8985 -> Formula Error: Unexpected , | String |
| urlAfterRedirectsFp | These two fingerprints are used for de-duping results in a twiddler. They should only be populated by freshdocs, and will only be present for documents that are chosen to be canonicals in a cluster whose previous canonical is also in the index. Additionally, url_after_redirects_fp is only present if it is different from a fingerprint of the URL. | PerDocData | !ERROR! D8986 -> Formula Error: Unexpected , | String |
| localizedCluster | Information on localized clusters, which is the relationship of translated and/or localized pages. | PerDocData | !ERROR! D8987 -> Formula Error: Unexpected , | IndexingDupsLocalizedLocalizedCluster |
| pageregions | String that encodes the position ranges for different regions of the document. See “indexer/pageregion.h” for an explanation, and how to decode the string | PerDocData | !ERROR! D8988 -> Formula Error: Unexpected , | String |
| KeywordStuffingScore | The keyword stuffing score is represented in 7 bits, going from 0 to 127. | PerDocData | !ERROR! D8989 -> Formula Error: Unexpected , | integer |
| spambrainTotalDocSpamScore | The document total spam score identified by spambrain, going from 0 to 1. | PerDocData | !ERROR! D8990 -> Formula Error: Unexpected , | number |
| noimageframeoverlayreason | If not 0, we should not show the image in overlay mode in image snippets | PerDocData | !ERROR! D8991 -> Formula Error: Unexpected , | integer |
| scienceHoldingsIds | Deprecated 2016/01/14. | PerDocData | !ERROR! D8992 -> Formula Error: Unexpected , | list(String) |
| crawlPagerank | This field is used internally by the docjoiner to forward the crawl pageranks from original canonicals to canonicals we actually chose; outside sources should not set it, and it should not be present in actual docjoins or the index. | PerDocData | !ERROR! D8993 -> Formula Error: Unexpected , | integer |
| BlogData | PerDocData | !ERROR! D8994 -> Formula Error: Unexpected , | BlogPerDocData | |
| nsrIsVideoFocusedSite | This field is propagated to shards. It will also be populated at serving time by go/web-signal-joins (see b/170607253). Bit indicating whether this site is video-focused, but not hosted on any major known video hosting domains. This field is deprecated – used the equivalent field inside nsr_data_proto instead. | PerDocData | !ERROR! D8995 -> Formula Error: Unexpected , | boolean |
| ScaledExptSpamScoreYoram | PerDocData | !ERROR! D8996 -> Formula Error: Unexpected , | integer | |
| spamrank | The spamrank measures the likelihood that this document links to known spammers. Its value is between 0 and 65535. | PerDocData | !ERROR! D8997 -> Formula Error: Unexpected , | integer |
| compressedQualitySignals | PerDocData | !ERROR! D8998 -> Formula Error: Unexpected , | CompressedQualitySignals | |
| videodata | PerDocData | !ERROR! D8999 -> Formula Error: Unexpected , | VideoPerDocData | |
| s3AudioLanguage | Primary video’s audio language classified by S3 based Automatic Language Identification (only for watch pages). | PerDocData | !ERROR! D9000 -> Formula Error: Unexpected , | S3AudioLanguageS3AudioLanguage |
| watchpageLanguageResult | Language classified by the WatchPageLanguage Model (go/watchpage-language). Only present for watch pages. | PerDocData | !ERROR! D9001 -> Formula Error: Unexpected , | WatchpageLanguageWatchPageLanguageResult |
| appsLink | AppsLink contains Android application IDs in outlinks. It is used to improve results ranking within applications universal. See http://go/apps-universal for the project details. | PerDocData | !ERROR! D9002 -> Formula Error: Unexpected , | QualityCalypsoAppsLink |
| desktopInterstitials | Contains desktop interstitials signal for VOLT ranking change. | PerDocData | !ERROR! D9003 -> Formula Error: Unexpected , | IndexingMobileInterstitialsProtoDesktopInterstitials |
| liveResultsData | PerDocData | !ERROR! D9004 -> Formula Error: Unexpected , | WeboftrustLiveResultsDocAttachments | |
| crowdingdata | PerDocData | !ERROR! D9005 -> Formula Error: Unexpected , | CrowdingPerDocData | |
| nsrSitechunk | SiteChunk computed for nsr. It some cases it can use more information than just url (e.g. youtube channels). See NsrAnnotator for details. If sitechunk is longer than –populate_nsr_sitechunk_max_length (default=100), it will not get populated. This field might be compressed and needs to be decoded with quality_nsr::util::DecodeNsrSitechunk. See go/nsr-chunks for more details. This field contains only nontrivial primary chunks. | PerDocData | !ERROR! D9006 -> Formula Error: Unexpected , | String |
| originalTitleHardTokenCount | The number of hard tokens in the title. | PerDocData | !ERROR! D9007 -> Formula Error: Unexpected , | integer |
| hostAge | The earliest firstseen date of all pages in this host/domain. These data are used in twiddler to sandbox fresh spam in serving time. It is 16 bit and the time is day number after 2005-12-31, and all the previous time are set to 0. If this url’s host_age == domain_age, then omit domain_age Please use //spam/content/siteage-util.h to convert the day between epoch second. Regarding usage of Sentinel values: We would like to check if a value exists in scoring bundle while using in Ranklab AST. For this having a sentinel value will help us know if the field exists or has a sentinel value (in the case it does not exist). 16-bit | PerDocData | !ERROR! D9008 -> Formula Error: Unexpected , | integer |
| inNewsstand | This field indicates whether the document is in the newsstand corpus. | PerDocData | !ERROR! D9009 -> Formula Error: Unexpected , | boolean |
| origin | PerDocData | !ERROR! D9010 -> Formula Error: Unexpected , | integer | |
| launchAppInfo | Info on how to launch a mobile app to consume this document’s content, if applicable (see go/calypso). | PerDocData | !ERROR! D9011 -> Formula Error: Unexpected , | QualityRichsnippetsAppsProtosLaunchAppInfoPerDocData |
| eventsDate | Date for Events. A web page might list multiple events with different dates. We only take one date (start date) per event. | PerDocData | !ERROR! D9012 -> Formula Error: Unexpected , | list(String) |
| homePageInfo | PerDocData | !ERROR! D9013 -> Formula Error: Unexpected , | integer | |
| GibberishScore | The gibberish score is represented in 7 bits, going from 0 to 127. | PerDocData | !ERROR! D9014 -> Formula Error: Unexpected , | integer |
| toolbarPagerank | A copy of the value stored in /namespace/indexing/wwwglobal//fakepr/* for this document. A value of quality_bakery::FakeprUtils::kUnknownToolbarPagerank indicates that we don’t have toolbar pagerank for this document. A value between 0 and 10 (inclusive) means that this is the toolbar pagerank of the page. Finally, if this value is not set it means that the toolbar pagerank is equivalent to: quality_bakery::FakeprUtils::EstimatePreDemotionFromPagerankNearestSeeds( basic_info.pagerank_ns()) called on the MustangBasicInfo attachment for the same document. | PerDocData | !ERROR! D9015 -> Formula Error: Unexpected , | integer |
| freshboxArticleScores | Stores scores of freshness-related classifiers: freshbox article score, live blog score and host-level article score. The encoding/decoding API is in quality/freshness/freshbox/goldmine/freshbox_annotation_encoder.h. To use this field, you MUST join g/pq-classifiers-announce and add your use case at http://shortn/_RYXS2lX2IV. | PerDocData | !ERROR! D9016 -> Formula Error: Unexpected , | integer |
| WhirlpoolDiscount | PerDocData | !ERROR! D9017 -> Formula Error: Unexpected , | number | |
| ScaledExptIndyRank3 | experimental | PerDocData | !ERROR! D9018 -> Formula Error: Unexpected , | integer |
| ToolBarData | PerDocData | !ERROR! D9019 -> Formula Error: Unexpected , | ToolBarPerDocData | |
| nsrIsElectionAuthority | This field is propagated to shards. It will also be populated at serving time by go/web-signal-joins (see b/168114815). This field is deprecated – used the equivalent field inside nsr_data_proto instead. | PerDocData | !ERROR! D9020 -> Formula Error: Unexpected , | boolean |
| onsiteProminence | Onsite prominence measures the importance of the document within its site. It is computed by propagating simulated traffic from the homepage and high craps click pages. It is a 13-bit int. | PerDocData | !ERROR! D9021 -> Formula Error: Unexpected , | integer |
| travelGoodSitesInfo | This field stores information about good travel sites. | PerDocData | !ERROR! D9022 -> Formula Error: Unexpected , | QualityTravelGoodSitesData |
| IsAnchorBayesSpam | Is this document considered spam by the anchor bayes classifier? | PerDocData | !ERROR! D9023 -> Formula Error: Unexpected , | boolean |
| isHotdoc | Set by the FreshDocs instant doc joiner. See //indexing/instant/hotdocs/README and http://go/freshdocs-hotdocs. | PerDocData | !ERROR! D9024 -> Formula Error: Unexpected , | boolean |
| commercialScore | A measure of commerciality of the document Score > 0 indicates document is commercial (i.e. sells something) Computed by repository/pageclassifiers/parsehandler-commercial.cc | PerDocData | !ERROR! D9025 -> Formula Error: Unexpected , | number |
| asteroidBeltIntents | For indexing Asteroid Belt intent scores. See go/asteroid-belt for details. | PerDocData | !ERROR! D9026 -> Formula Error: Unexpected , | QualityOrbitAsteroidBeltDocumentIntentScores |
| TagPageScore | Tag-site-ness of a page, repesented in 7-bits range from 0 to 100. Smaller value means worse tag page. | PerDocData | !ERROR! D9027 -> Formula Error: Unexpected , | integer |
| geodata | geo data; approx 24 bytes for 23M U.S. pages | PerDocData | !ERROR! D9028 -> Formula Error: Unexpected , | String |
| oceandata | 28 bytes per page, only in the Ocean index | PerDocData | !ERROR! D9029 -> Formula Error: Unexpected , | OceanPerDocData |
| pagerank0 | PerDocData | !ERROR! D9030 -> Formula Error: Unexpected , | number | |
| SpamWordScore | The spamword score is represented in 7-bits, going from 0 to 127. | PerDocData | !ERROR! D9031 -> Formula Error: Unexpected , | integer |
| ScaledIndyRank | The independence rank is represented as a 16-bit integer, which is multiplied by (max_indy_rank / 65536) to produce actual independence rank values. max_indy_rank is typically 0.84. | PerDocData | !ERROR! D9032 -> Formula Error: Unexpected , | integer |
| bodyWordsToTokensRatioBegin | The body words over tokens ratios for the beginning part and whole doc. NB: To save space, field body_words_to_tokens_ratio_total is not set if it has the same value as body_words_to_tokens_ratio_begin (e.g., short docs). | PerDocData | !ERROR! D9033 -> Formula Error: Unexpected , | number |
| topPetacatWeight | PerDocData | !ERROR! D9034 -> Formula Error: Unexpected , | number | |
| fireflySiteSignal | Contains Site signal information for Firefly ranking change. See http://ariane/313938 for more details. | PerDocData | !ERROR! D9035 -> Formula Error: Unexpected , | QualityCopiaFireflySiteSignal |
| titleHardTokenCountWithoutStopwords | Number of hard tokens originally in title without counting the stopwords. | PerDocData | !ERROR! D9036 -> Formula Error: Unexpected , | integer |
| hostNsr | Site rank computed for host-level sitechunks. This value encodes nsr, site_pr and new_nsr. See quality_nsr::util::ConvertNsrDataToHostNsr and go/nsr. This field is deprecated – used the equivalent field inside nsr_data_proto instead. | PerDocData | !ERROR! D9037 -> Formula Error: Unexpected , | integer |
| semanticDateInfo | Info is encoded using a SemanticDate specific format. Contains confidence scores for day/month/year components as well as various meta data required by the freshness twiddlers. | PerDocData | !ERROR! D9038 -> Formula Error: Unexpected , | integer |
| languages | Plausible languages in order of decreasing plausibility. Language values are small, IE < 127 so this should compress to one byte each. | PerDocData | !ERROR! D9039 -> Formula Error: Unexpected , | list(integer) |
| GroupsData | 16 bytes of groups2 data: used only in groups2 index | PerDocData | !ERROR! D9040 -> Formula Error: Unexpected , | GroupsPerDocData |
| countryInfo | This field stores the country information for the document in the form of CountryAttachment. | PerDocData | !ERROR! D9041 -> Formula Error: Unexpected , | CountryCountryAttachment |
| brainloc | Brainloc contains location information for the document. See ariane/273189 for details. | PerDocData | !ERROR! D9042 -> Formula Error: Unexpected , | QualityGeoBrainlocBrainlocAttachment |
| ScaledLinkAgeSpamScore | End DEPRECATED ———————————————————— Link age score is represented as a 7-bit integer, going from 0 to 127. | PerDocData | !ERROR! D9043 -> Formula Error: Unexpected , | integer |
| ScaledExptIndyRank | DEPRECATED —————————————————————- Please do not use these fields in any new code. experimental | PerDocData | !ERROR! D9044 -> Formula Error: Unexpected , | integer |
| shingleInfo | PerDocData | !ERROR! D9045 -> Formula Error: Unexpected , | ShingleInfoPerDocData | |
| productSitesInfo | This field stores information about product sites. | PerDocData | !ERROR! D9046 -> Formula Error: Unexpected , | QualityProductProductSiteData |
| spambrainDomainSitechunkData | Domain sitechunk level scores coming from spambrain. | PerDocData | !ERROR! D9047 -> Formula Error: Unexpected , | SpamBrainData |
| voltData | Contains page UX signals for VOLT ranking change. See http://ariane/4025970 for more details. | PerDocData | !ERROR! D9048 -> Formula Error: Unexpected , | IndexingMobileVoltVoltPerDocData |
| timeSensitivity | Encoded Document Time Sensitivity signal. | PerDocData | !ERROR! D9049 -> Formula Error: Unexpected , | integer |
| servingTimeClusterIds | A set of cluster ids which are generated in Alexandria and used to de-dup results at serving time. | PerDocData | !ERROR! D9050 -> Formula Error: Unexpected , | IndexingDocjoinerServingTimeClusterIds |
| Message | depends on the source | PerDocDebugEvent | Free form debug information from various components. | String |
| Source | source tag, helps interpret value/message | PerDocDebugEvent | Free form debug information from various components. | String |
| Timestamp | seconds since the epoch | PerDocDebugEvent | Free form debug information from various components. | integer |
| Value | depends on the source | PerDocDebugEvent | Free form debug information from various components. | String |
| subId | A unique identifier for this alias, this identifier is unique to the type of this Alias. This means that aliases of different types can have the same sub_id, hence always use the full AliasId message to refer to an alias, not this field only. Because HOME and WORK aliases are unique, aliases of type HOME or WORK always have sub_id 0. | PersonalizationMapsAliasAliasId | A unique association of an AliasType and a number to identify this alias. | String |
| type | PersonalizationMapsAliasAliasId | A unique association of an AliasType and a number to identify this alias. | String | |
| aliasId | The id of the alias associated with this point. This is used to query for details for the info window and to display different icons depending on the AliasType contained in this message. | PersonalizationMapsAliasIcon | A subset of an Alias that is stored on kansas max. It is used in Search for alias resolution and in Maps to show icons quickly on basetiles. Next ID: 18 | PersonalizationMapsAliasAliasId |
| droppedPinS2cellId | If this is a dropped pin alias, the leaf (level 30) S2 cell ID corresponding to the aliased lat/lng. Calculated once and stored here so that it can safely be used as an identifier across clients without risk of rounding differences leading to different values. | PersonalizationMapsAliasIcon | A subset of an Alias that is stored on kansas max. It is used in Search for alias resolution and in Maps to show icons quickly on basetiles. Next ID: 18 | String |
| featureId | The featureid that was associated with the alias when it was saved. If this is not set the lat/lng in ‘point’ is the aliased entity, i.e. this is a dropped pin alias. | PersonalizationMapsAliasIcon | A subset of an Alias that is stored on kansas max. It is used in Search for alias resolution and in Maps to show icons quickly on basetiles. Next ID: 18 | GeostoreFeatureIdProto |
| featureName | For non-address feature aliases (e.g. businesses), the name of the feature (formatted from the FeatureProto) when it was saved. | PersonalizationMapsAliasIcon | A subset of an Alias that is stored on kansas max. It is used in Search for alias resolution and in Maps to show icons quickly on basetiles. Next ID: 18 | String |
| featureType | The type of the feature associated with the alias. | PersonalizationMapsAliasIcon | A subset of an Alias that is stored on kansas max. It is used in Search for alias resolution and in Maps to show icons quickly on basetiles. Next ID: 18 | String |
| formattedAddress | One-line geocoded address that this lat/lng represents at the time this alias was created by the user. | PersonalizationMapsAliasIcon | A subset of an Alias that is stored on kansas max. It is used in Search for alias resolution and in Maps to show icons quickly on basetiles. Next ID: 18 | String |
| isAdsJoinCompliant | Indicates whether this alias is Ads join compliant for use by 3p clients. See go/ios_address and go/aliased-locations-provenance for more details. Please contact oolong-team@ for additional questions regarding usage of this field. | PersonalizationMapsAliasIcon | A subset of an Alias that is stored on kansas max. It is used in Search for alias resolution and in Maps to show icons quickly on basetiles. Next ID: 18 | boolean |
| nickname | Free-text alias if alias type is NICKNAME. Otherwise unset. Limited to 40 characters. | PersonalizationMapsAliasIcon | A subset of an Alias that is stored on kansas max. It is used in Search for alias resolution and in Maps to show icons quickly on basetiles. Next ID: 18 | String |
| point | lat/lng the icon is to be shown at. | PersonalizationMapsAliasIcon | A subset of an Alias that is stored on kansas max. It is used in Search for alias resolution and in Maps to show icons quickly on basetiles. Next ID: 18 | GeostorePointProto |
| ptoken | Encapsulates the privacy policy relevant signals for this event. See go/kansas-embedded-ptokens for additional details. Keep the type fully qualified in case (when) we decide to make proto compiler enforce ‘.ptoken.PToken’ as the only allowed type for the field number 9099. Hence, don’t remove the leading ‘.’. See go/protobuf-ptoken-field for details around the 9099 field number. | PersonalizationMapsAliasIcon | A subset of an Alias that is stored on kansas max. It is used in Search for alias resolution and in Maps to show icons quickly on basetiles. Next ID: 18 | PtokenPToken |
| stickerId | The id of the sticker asset chosen by the user to replace the default asset for the alias. | PersonalizationMapsAliasIcon | A subset of an Alias that is stored on kansas max. It is used in Search for alias resolution and in Maps to show icons quickly on basetiles. Next ID: 18 | integer |
| syntheticFeature | If the feature associated with the alias has synthetic_geometry. | PersonalizationMapsAliasIcon | A subset of an Alias that is stored on kansas max. It is used in Search for alias resolution and in Maps to show icons quickly on basetiles. Next ID: 18 | boolean |
| timestamp | [INTERNAL ONLY] Last update of bigtable by kansas, in microseconds. Volatile only and not saved in kansas column. inmemory only because >= 16. | PersonalizationMapsAliasIcon | A subset of an Alias that is stored on kansas max. It is used in Search for alias resolution and in Maps to show icons quickly on basetiles. Next ID: 18 | String |
| opaRecipesContext | Contexts regarding the preferences from OPA_RECIPES. | PersonalizationSettingsApiProtoLocalDiscoveryLocalDiscoverySettingsMetadata | Metadata related to LocalDiscoverySettings,e.g., dietary_restriction, cuisine and ingredient. | PersonalizationSettingsApiProtoLocalDiscoveryOpaRecipesContext |
| uiEntryPoint | The UI entry point from which the entity preference was set. | PersonalizationSettingsApiProtoLocalDiscoveryLocalDiscoverySettingsMetadata | Metadata related to LocalDiscoverySettings,e.g., dietary_restriction, cuisine and ingredient. | String |
| docId | The recipe doc id where the setting comes from. | PersonalizationSettingsApiProtoLocalDiscoveryOpaRecipesContext | LINT.IfChange Contexts regarding the preferences from OPA_RECIPES. For example, users can click a recipes and say they don’t like one cuisine. OpaRecipesContext will contain the doc_id/url of that recipes. | String |
| url | The recipe url where the setting comes from. | PersonalizationSettingsApiProtoLocalDiscoveryOpaRecipesContext | LINT.IfChange Contexts regarding the preferences from OPA_RECIPES. For example, users can click a recipes and say they don’t like one cuisine. OpaRecipesContext will contain the doc_id/url of that recipes. | String |
| PhilString | phil data , approx 70 bytes for top 500M | PhilPerDocData | String | |
| PhilVersion | PhilPerDocData | integer | ||
| durationMs | The duration of the animation or movie (not including any looping), in milliseconds. If there is only a single frame (and thus not animated), the duration will be 0. | PhotosAnimationMetadata | String | |
| loopCount | The number of times the animation plays. If 0, the animation will loop indefinitely. If positive, this number includes the initial playthrough. For example, a value of 3 means that each frame is shown 3 times. | PhotosAnimationMetadata | integer | |
| numFrames | PhotosAnimationMetadata | String | ||
| version | Currently there are two versions of DynamicDepth (go/ddv2). DynamicDepth photos without a set version should be assumed to be ddv1. | PhotosDynamicDepthMetadata | Metadata pertaining to nested Dynamic Depth metadata. Currently this message is used to indicate the presence of dynamic depth. | integer |
| caption | PhotosFourCMetadata | String | ||
| copyright | PhotosFourCMetadata | String | ||
| creator | PhotosFourCMetadata | list(String) | ||
| credit | PhotosFourCMetadata | String | ||
| far | Depth map far plane distance. | PhotosGDepthMetadata | Metadata in the GDepth XMP block. Note that GDepth::Data is not copied into this message. | number |
| format | Depth map format. | PhotosGDepthMetadata | Metadata in the GDepth XMP block. Note that GDepth::Data is not copied into this message. | String |
| imageHeight | Depth map source image height. | PhotosGDepthMetadata | Metadata in the GDepth XMP block. Note that GDepth::Data is not copied into this message. | integer |
| imageWidth | Depth map source image width. | PhotosGDepthMetadata | Metadata in the GDepth XMP block. Note that GDepth::Data is not copied into this message. | integer |
| mime | Depth map mime type. | PhotosGDepthMetadata | Metadata in the GDepth XMP block. Note that GDepth::Data is not copied into this message. | String |
| near | Depth map near plane distance. | PhotosGDepthMetadata | Metadata in the GDepth XMP block. Note that GDepth::Data is not copied into this message. | number |
| units | Depth map units of distance. | PhotosGDepthMetadata | Metadata in the GDepth XMP block. Note that GDepth::Data is not copied into this message. | String |
| gainmap | Indicates the presence of some kind of gainmap-utilizing format. | PhotosHdrMetadata | HDR Metadata describes in what way an image expresses high dynamic range information (e.g. using a gainmap or a specialized color space). | PhotosHdrMetadataGainmap |
| adobeHdr | Indicates that this image can be processed as an Adobe HDR (FlexDR) image by reading the MPF segments. | PhotosHdrMetadataGainmap | Details about gainmap-based HDR formats (e.g. go/ghdr). Notably, images can adhere to multiple gainmap specifications concurrently. | boolean |
| appleHdr | Indicates that this image can be processed as an Apple HDR image by reading the MPF segments (if JPEG) or HEIF segments (if HEIC). | PhotosHdrMetadataGainmap | Details about gainmap-based HDR formats (e.g. go/ghdr). Notably, images can adhere to multiple gainmap specifications concurrently. | boolean |
| googleHdr | Indicates that this image can be processed as a go/ghdr (UltraHDR) image by reading the GContainer in the primary XMP block. | PhotosHdrMetadataGainmap | Details about gainmap-based HDR formats (e.g. go/ghdr). Notably, images can adhere to multiple gainmap specifications concurrently. | boolean |
| relation | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| freebytecounts | PhotosImageMetadata | Next tag value: 384. | String | |
| exposureindex | PhotosImageMetadata | Next tag value: 384. | number | |
| gdepthMetadata | PhotosImageMetadata | Next tag value: 384. | PhotosGDepthMetadata | |
| addlmodelinfo | PhotosImageMetadata | Next tag value: 384. | String | |
| redeyemode | PhotosImageMetadata | Next tag value: 384. | boolean | |
| captionwriter | PhotosImageMetadata | Next tag value: 384. | String | |
| organisationinimagename | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| productid | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| rating | PhotosImageMetadata | Next tag value: 384. | number | |
| colormap | PhotosImageMetadata | Next tag value: 384. | integer | |
| countrycode | PhotosImageMetadata | Next tag value: 384. | String | |
| stitchingsoftware | PhotosImageMetadata | Next tag value: 384. | String | |
| croppedareaimageheightpixels | PhotosImageMetadata | Next tag value: 384. | integer | |
| state | PhotosImageMetadata | Next tag value: 384. | String | |
| usageterms | PhotosImageMetadata | Next tag value: 384. | String | |
| DEPRECATEDLargestvalidinteriorrectheight | PhotosImageMetadata | Next tag value: 384. | integer | |
| lensinfo | PhotosImageMetadata | Next tag value: 384. | String | |
| modelreleaseid | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| referencedate | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| expirationdate | PhotosImageMetadata | Next tag value: 384. | String | |
| gpsdestdistanceref | PhotosImageMetadata | Next tag value: 384. | String | |
| webstatement | PhotosImageMetadata | Next tag value: 384. | String | |
| subjectarea | PhotosImageMetadata | Next tag value: 384. | integer | |
| headline | PhotosImageMetadata | Next tag value: 384. | String | |
| relatedsoundfile | PhotosImageMetadata | Next tag value: 384. | String | |
| gpsmeasuremode | PhotosImageMetadata | Next tag value: 384. | String | |
| xresolution | PhotosImageMetadata | Next tag value: 384. | number | |
| function | PhotosImageMetadata | Next tag value: 384. | boolean | |
| advisory | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| format | PhotosImageMetadata | Next tag value: 384. | String | |
| caption | Caption embedded in IPTC | PhotosImageMetadata | Next tag value: 384. | String |
| gimagemime | PhotosImageMetadata | Next tag value: 384. | String | |
| customrendered | PhotosImageMetadata | Next tag value: 384. | integer | |
| relatedimagefileformat | PhotosImageMetadata | Next tag value: 384. | String | |
| maxavailwidth | PhotosImageMetadata | Next tag value: 384. | integer | |
| chromasubsampling | A typed representation that translates the values from ycbcrsubsampling. | PhotosImageMetadata | Next tag value: 384. | String |
| gpsdestdistance | PhotosImageMetadata | Next tag value: 384. | number | |
| propertyreleaseid | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| date | PhotosImageMetadata | Next tag value: 384. | String | |
| sensorheight | PhotosImageMetadata | Next tag value: 384. | number | |
| initialviewheadingdegrees | PhotosImageMetadata | Next tag value: 384. | integer | |
| yresolution | PhotosImageMetadata | Next tag value: 384. | number | |
| bitspersample | Start of reflected fields. These do not duplicate the above fields. | PhotosImageMetadata | Next tag value: 384. | integer |
| gcameraspecialtypeid | Camera creations metadata. The opaque id string created by the OEM. For bursts, this field should not be present. Instead, the two properties below will allow Photos to identify and provide special treatment for bursts. | PhotosImageMetadata | Next tag value: 384. | String |
| rotate | This field is deprecated. Rotation is now accomplished via ImageInfo.exif_orientation and ImageInfo.edit_list. WARNING: the presence of rotate is used by FIFE to identify older images. Setting this (even to the correct number of degrees) on newer images can cause incorrectly rotated thumbnails. This was the cause of omg/58543 Number of degrees (0, 90, 180, 270) | PhotosImageMetadata | Next tag value: 384. | integer |
| ciadrpcode | PhotosImageMetadata | Next tag value: 384. | String | |
| microvideooriginaloffset | This is similar to gcameramicrovideooffset, except it stores the unverified value that was provided in the motion photo file. This field is not part of the XMP or spec. It is used to ensure we preserve data from the original file when offset is modified. | PhotosImageMetadata | Next tag value: 384. | integer |
| mimeType | Mime type of image | PhotosImageMetadata | Next tag value: 384. | integer |
| posepitchdegrees | PhotosImageMetadata | Next tag value: 384. | number | |
| minsamplevalue | PhotosImageMetadata | Next tag value: 384. | integer | |
| iptclastedited | PhotosImageMetadata | Next tag value: 384. | String | |
| maxaperturevalue | PhotosImageMetadata | Next tag value: 384. | number | |
| motionphotovideodataboxheader | The Motion Photo Video Data (MPVD) box header of a HEIF motion photo. It is used for reconstructing the original moton photo bytes. See go/photos-be-heic-motion-photos for more details. | PhotosImageMetadata | Next tag value: 384. | String |
| ciadrregion | PhotosImageMetadata | Next tag value: 384. | String | |
| envelopenumber | PhotosImageMetadata | Next tag value: 384. | String | |
| subjectlocation | PhotosImageMetadata | Next tag value: 384. | integer | |
| gpsdop | PhotosImageMetadata | Next tag value: 384. | number | |
| sensingmethod | PhotosImageMetadata | Next tag value: 384. | integer | |
| width | width and height are before any rotation (including EXIF orientation). | PhotosImageMetadata | Next tag value: 384. | integer |
| ownername | PhotosImageMetadata | Next tag value: 384. | String | |
| stripbytecounts | PhotosImageMetadata | Next tag value: 384. | String | |
| gcameramicrovideo | The following XMP metadata are used specifically for MicroVideo. More information about MicroVideo format can be found at go/photos-microvideo-format A value of 1 indicates that this file was a MicroVideo at capture time. Otherwise, this is not a MicroVideo (not set or 0). | PhotosImageMetadata | Next tag value: 384. | integer |
| orientation | Exif camera orientation. “1” means “no rotation”. | PhotosImageMetadata | Next tag value: 384. | integer |
| height | PhotosImageMetadata | Next tag value: 384. | integer | |
| subjectcode | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| DEPRECATEDLargestvalidinteriorrecttop | PhotosImageMetadata | Next tag value: 384. | integer | |
| gpsstatus | PhotosImageMetadata | Next tag value: 384. | String | |
| timesent | PhotosImageMetadata | Next tag value: 384. | String | |
| gpsdatestamp | This is in UTC time. Format is YYYY:mm:dd. | PhotosImageMetadata | Next tag value: 384. | String |
| ciurlwork | PhotosImageMetadata | Next tag value: 384. | String | |
| DEPRECATEDGpstimestamp | This field was originally marked incorrectly as optional (rather than repeated). In order to fix it, the first field has been marked as deprecated and replaced with a field with a new name and tag number. | PhotosImageMetadata | Next tag value: 384. | number |
| photometricinterpretation | PhotosImageMetadata | Next tag value: 384. | integer | |
| relatedimagewidth | PhotosImageMetadata | Next tag value: 384. | String | |
| gcameramotionphoto | An indication that this item should be treated as a Motion Photo. 0 -> Not Motion Photo, 1 -> Motion Photo, everything else is undefined per the spec. If it’s a motion photo, the previous gcamera fields should be ignored. | PhotosImageMetadata | Next tag value: 384. | integer |
| projectiontype | PhotosImageMetadata | Next tag value: 384. | String | |
| aperturevalue | PhotosImageMetadata | Next tag value: 384. | number | |
| ycbcrsubsampling | PhotosImageMetadata | Next tag value: 384. | integer | |
| marked | PhotosImageMetadata | Next tag value: 384. | boolean | |
| keyword | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| contributor | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| country | PhotosImageMetadata | Next tag value: 384. | String | |
| dynamicDepthMetadata | DynamicDepth (go/dynamic-depth) metadata is described in the metadata of sub-images in the container. The presence of this field can be used to determine that an image is in the dynamic depth format. | PhotosImageMetadata | Next tag value: 384. | PhotosDynamicDepthMetadata |
| croppedareaimagewidthpixels | PhotosImageMetadata | Next tag value: 384. | integer | |
| lightsource | PhotosImageMetadata | Next tag value: 384. | integer | |
| brightnessvalue | PhotosImageMetadata | Next tag value: 384. | number | |
| sublocation | PhotosImageMetadata | Next tag value: 384. | String | |
| DEPRECATEDLargestvalidinteriorrectwidth | PhotosImageMetadata | Next tag value: 384. | integer | |
| exposuremode | PhotosImageMetadata | Next tag value: 384. | integer | |
| DEPRECATEDLargestvalidinteriorrectleft | PhotosImageMetadata | Next tag value: 384. | integer | |
| imagetype | PhotosImageMetadata | Next tag value: 384. | String | |
| longitude | +/- 180 inclusive | PhotosImageMetadata | Next tag value: 384. | float |
| gpstrack | PhotosImageMetadata | Next tag value: 384. | number | |
| gpstrackref | PhotosImageMetadata | Next tag value: 384. | String | |
| focalplanexres | PhotosImageMetadata | Next tag value: 384. | number | |
| exposuretime | PhotosImageMetadata | Next tag value: 384. | number | |
| compressedbitsperpixel | PhotosImageMetadata | Next tag value: 384. | number | |
| urgency | PhotosImageMetadata | Next tag value: 384. | String | |
| subjectdistancerange | PhotosImageMetadata | Next tag value: 384. | integer | |
| baseurl | PhotosImageMetadata | Next tag value: 384. | String | |
| objectattributereference | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| meteringmode | PhotosImageMetadata | Next tag value: 384. | integer | |
| compressionlevel | PhotosImageMetadata | Next tag value: 384. | integer | |
| gpsdestlongituderef | PhotosImageMetadata | Next tag value: 384. | String | |
| focalplaneunits | PhotosImageMetadata | Next tag value: 384. | number | |
| audioduration | PhotosImageMetadata | Next tag value: 384. | String | |
| imageorientation | PhotosImageMetadata | Next tag value: 384. | String | |
| exposurebias | PhotosImageMetadata | Next tag value: 384. | number | |
| citelwork | PhotosImageMetadata | Next tag value: 384. | String | |
| maxavailheight | PhotosImageMetadata | Next tag value: 384. | integer | |
| audiosamplingresolution | PhotosImageMetadata | Next tag value: 384. | String | |
| xmp4c | PhotosImageMetadata | Next tag value: 384. | PhotosFourCMetadata | |
| gpsimgdirection | PhotosImageMetadata | Next tag value: 384. | number | |
| distance | PhotosImageMetadata | Next tag value: 384. | number | |
| animationMetadata | PhotosImageMetadata | Next tag value: 384. | PhotosAnimationMetadata | |
| altitude | PhotosImageMetadata | Next tag value: 384. | float | |
| cameraid | PhotosImageMetadata | Next tag value: 384. | String | |
| whitebalance | PhotosImageMetadata | Next tag value: 384. | integer | |
| flashreturn | PhotosImageMetadata | Next tag value: 384. | integer | |
| expirationtime | PhotosImageMetadata | Next tag value: 384. | String | |
| envelopepriority | PhotosImageMetadata | Next tag value: 384. | String | |
| bitDepth | The number of bits per pixel used to express a color. Most images have 8-bit depth and Photos/thumbnailer currently do not support more than 8 bits (except RAW). | PhotosImageMetadata | Next tag value: 384. | integer |
| gcameramotionphotoversion | Indicates the Motion Photo version of the spec (initially 1). | PhotosImageMetadata | Next tag value: 384. | integer |
| organisationinimagecode | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| lensid | PhotosImageMetadata | Next tag value: 384. | String | |
| gpsdestbearingref | PhotosImageMetadata | Next tag value: 384. | String | |
| locationshown | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| originatingprogram | PhotosImageMetadata | Next tag value: 384. | String | |
| minormodelagedisclosure | PhotosImageMetadata | Next tag value: 384. | String | |
| releasedate | PhotosImageMetadata | Next tag value: 384. | String | |
| mode | PhotosImageMetadata | Next tag value: 384. | integer | |
| maxsamplevalue | PhotosImageMetadata | Next tag value: 384. | integer | |
| fullpanowidthpixels | PhotosImageMetadata | Next tag value: 384. | integer | |
| focallength | PhotosImageMetadata | Next tag value: 384. | number | |
| hdrMetadata | Indicates that the image has some form of HDR present or available to it. | PhotosImageMetadata | Next tag value: 384. | PhotosHdrMetadata |
| panoramaMetadata | PhotosImageMetadata | Next tag value: 384. | PhotosPanoramaMetadata | |
| gpsspeedref | PhotosImageMetadata | Next tag value: 384. | String | |
| thumbnailerBuildCl | The build CL for the version of thumbnailer that built this image. | PhotosImageMetadata | Next tag value: 384. | integer |
| lastphotodate | PhotosImageMetadata | Next tag value: 384. | String | |
| capturesoftware | PhotosImageMetadata | Next tag value: 384. | String | |
| gcameraburstprimary | A value of 1 indicates that this was the primary (“best shot”) at capture time. Within Photos we should only treat this image as the best shot if the user hasn’t made an explicit choice. Defining the initial primary allows consistency between OEMs, Photos clients, and the Photos backend. This value is optional, cameras are not required to set it on any photo in a burst. Clients will default to the 0th frame, but may run an algorithm to pick a better default. | PhotosImageMetadata | Next tag value: 384. | integer |
| scenecapturetype | PhotosImageMetadata | Next tag value: 384. | integer | |
| gaincontrol | PhotosImageMetadata | Next tag value: 384. | integer | |
| cellwidth | PhotosImageMetadata | Next tag value: 384. | integer | |
| gpsimgdirectionref | PhotosImageMetadata | Next tag value: 384. | String | |
| DEPRECATEDIscolor | PhotosImageMetadata | Next tag value: 384. | integer | |
| flashcompensation | PhotosImageMetadata | Next tag value: 384. | number | |
| coverage | PhotosImageMetadata | Next tag value: 384. | String | |
| isoequivalent | PhotosImageMetadata | Next tag value: 384. | integer | |
| DEPRECATEDBlendingtype | PhotosImageMetadata | Next tag value: 384. | String | |
| offsettimeoriginal | PhotosImageMetadata | Next tag value: 384. | String | |
| programversion | PhotosImageMetadata | Next tag value: 384. | String | |
| releasetime | PhotosImageMetadata | Next tag value: 384. | String | |
| datesent | PhotosImageMetadata | Next tag value: 384. | String | |
| gpsspeed | PhotosImageMetadata | Next tag value: 384. | number | |
| fullpanoheightpixels | PhotosImageMetadata | Next tag value: 384. | integer | |
| datecreated | PhotosImageMetadata | Next tag value: 384. | String | |
| offsettimedigitized | PhotosImageMetadata | Next tag value: 384. | String | |
| location | PhotosImageMetadata | Next tag value: 384. | String | |
| daylightsavings | 0 = no daylight savings, 1 = daylight savings enabled. Note that this field only represents whether the setting in the camera was turned on or off. It must not be used to modify the timestamp of the photo. That is, the capture time is already completely determined by exif_time, timezoneoffset and timezoneminutes. | PhotosImageMetadata | Next tag value: 384. | list(integer) |
| gpsdestlatituderef | PhotosImageMetadata | Next tag value: 384. | String | |
| personinimage | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| version | PhotosImageMetadata | Next tag value: 384. | String | |
| DEPRECATEDProcess | PhotosImageMetadata | Next tag value: 384. | integer | |
| ciadrctry | PhotosImageMetadata | Next tag value: 384. | String | |
| intellectualgenre | PhotosImageMetadata | Next tag value: 384. | String | |
| referenceblackwhite | PhotosImageMetadata | Next tag value: 384. | number | |
| referencenumber | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| language | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| contact | PhotosImageMetadata | Next tag value: 384. | String | |
| digitalzoomratio | PhotosImageMetadata | Next tag value: 384. | number | |
| hasAlpha | The image has an alpha channel (potential transparency). If the image is decoded, this will be updated to indicate whether there is any active transparency. Formats supporting alpha: png, webp, gif, heif. | PhotosImageMetadata | Next tag value: 384. | boolean |
| usepanoramaviewer | GPano-related fields. A handful of these have been deprecated due to a change in the spec since its initial design. | PhotosImageMetadata | Next tag value: 384. | boolean |
| firmware | PhotosImageMetadata | Next tag value: 384. | String | |
| resolutionunit | PhotosImageMetadata | Next tag value: 384. | integer | |
| initialviewpitchdegrees | PhotosImageMetadata | Next tag value: 384. | integer | |
| gcameramotionphotocreator | Indicates the creator of the Motion Photo. This will be set if the MotionPhoto was generated from a LivePhoto from the iOS to Android conversion tool. | PhotosImageMetadata | Next tag value: 384. | String |
| spectralsensitivity | PhotosImageMetadata | Next tag value: 384. | String | |
| contentlocationname | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| digitalsourcetype | PhotosImageMetadata | Next tag value: 384. | String | |
| whitepoint | PhotosImageMetadata | Next tag value: 384. | number | |
| timezoneoffset | The elements in the timezone and daylight savings field arrays correspond to the following date/time fields: 0) datecreated (ie. DateTimeOriginal) 1) datetime (ie. DateTime or last modified date) 2) datetimedigitized (ie. DateTimeDigitized) If the field does not exist, then there is no valid time zone information for that date/time field. Offset in hours. | PhotosImageMetadata | Next tag value: 384. | list(integer) |
| source | PhotosImageMetadata | Next tag value: 384. | String | |
| audiooutcue | PhotosImageMetadata | Next tag value: 384. | String | |
| subjectreference | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| flashused | PhotosImageMetadata | Next tag value: 384. | integer | |
| propertyreleasestatus | PhotosImageMetadata | Next tag value: 384. | String | |
| datetimedigitized | PhotosImageMetadata | Next tag value: 384. | String | |
| extrasamples | PhotosImageMetadata | Next tag value: 384. | integer | |
| certificate | PhotosImageMetadata | Next tag value: 384. | String | |
| digimageguid | PhotosImageMetadata | Next tag value: 384. | String | |
| subsectimedigitized | PhotosImageMetadata | Next tag value: 384. | String | |
| exposurelockused | PhotosImageMetadata | Next tag value: 384. | boolean | |
| interoperabilityindex | PhotosImageMetadata | Next tag value: 384. | String | |
| event | PhotosImageMetadata | Next tag value: 384. | String | |
| gpsdestlongitude | PhotosImageMetadata | Next tag value: 384. | number | |
| gaudiomime | PhotosImageMetadata | Next tag value: 384. | String | |
| exifTime | Timestamp embedded in the image. The value comes from the first valid date-time field extracted from the metadata in the order: 1) datecreated (ie. DateTimeOriginal) 2) datetimedigitized (ie. DateTimeDigitized) 3) datetime (ie. DateTime or last modified date) The type of this field is equivalent to a time_t (ie. number of seconds since the epoch – 00:00 hours, Jan 1, 1970) except that it is an int64 rather than an int. | PhotosImageMetadata | Next tag value: 384. | String |
| focallengthin35mmfilm | PhotosImageMetadata | Next tag value: 384. | integer | |
| serviceidentifier | PhotosImageMetadata | Next tag value: 384. | String | |
| rowsperstrip | PhotosImageMetadata | Next tag value: 384. | String | |
| author | PhotosImageMetadata | Next tag value: 384. | String | |
| shutterspeedvalue | PhotosImageMetadata | Next tag value: 384. | number | |
| exposureprogram | PhotosImageMetadata | Next tag value: 384. | integer | |
| poseheadingdegrees | PhotosImageMetadata | Next tag value: 384. | number | |
| latitude | GPS Info: +/- 90 inclusive | PhotosImageMetadata | Next tag value: 384. | float |
| freeoffsets | PhotosImageMetadata | Next tag value: 384. | integer | |
| burstuuid | PhotosImageMetadata | Next tag value: 384. | String | |
| subsectime | PhotosImageMetadata | Next tag value: 384. | String | |
| gcameramotionphotopresentationtimestampus | The presentation timestamp in microseconds of the video frame corresponding to the image still. Value may be -1 to denote unset/unspecified. | PhotosImageMetadata | Next tag value: 384. | integer |
| celllength | PhotosImageMetadata | Next tag value: 384. | integer | |
| primarychromaticities | PhotosImageMetadata | Next tag value: 384. | number | |
| languageidentifier | PhotosImageMetadata | Next tag value: 384. | String | |
| gpsdifferential | PhotosImageMetadata | Next tag value: 384. | integer | |
| gpsdestlatitude | PhotosImageMetadata | Next tag value: 384. | number | |
| city | PhotosImageMetadata | Next tag value: 384. | String | |
| modelage | PhotosImageMetadata | Next tag value: 384. | list(integer) | |
| thresholding | PhotosImageMetadata | Next tag value: 384. | integer | |
| ccdwidth | PhotosImageMetadata | Next tag value: 384. | number | |
| sensorwidth | PhotosImageMetadata | Next tag value: 384. | number | |
| datetime | PhotosImageMetadata | Next tag value: 384. | String | |
| createdate | PhotosImageMetadata | Next tag value: 384. | String | |
| objecttypereference | PhotosImageMetadata | Next tag value: 384. | String | |
| ycbcrcoefficients | PhotosImageMetadata | Next tag value: 384. | number | |
| offsettime | PhotosImageMetadata | Next tag value: 384. | String | |
| samplesperpixel | PhotosImageMetadata | Next tag value: 384. | integer | |
| gcameramicrovideooffset | The offset in bytes from the end of the file to the point where the appended mp4 begins (equivalent to the length of the compressed mp4). This field might be provided in the original MicroVideo from client, but it might become invalid when the image component is edited, so it is expected that the thumbnailer will validate it and find the correct value (by scanning through the JPEG) if it is invalid. In other words, only a valid offset should be returned by thumbnailer. | PhotosImageMetadata | Next tag value: 384. | integer |
| gcameraisautoenhanced | Indicates that an OEM has applied auto enhance via Photos’ API. | PhotosImageMetadata | Next tag value: 384. | boolean |
| stripoffsets | PhotosImageMetadata | Next tag value: 384. | String | |
| software | PhotosImageMetadata | Next tag value: 384. | String | |
| exif4c | 4C metadata (caption, copyright, creator, credit) specific to each of the three metadata segments (EXIF, XMP, IPTC). These are used to keep separate the 4C data from each segment so that we can properly preserve the per-segment 4C data on write (when PreserveLevel is set appropriately). | PhotosImageMetadata | Next tag value: 384. | PhotosFourCMetadata |
| identifier | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| cameramodel | Exif camera model | PhotosImageMetadata | Next tag value: 384. | String |
| gpssatellites | PhotosImageMetadata | Next tag value: 384. | String | |
| audiosamplingrate | PhotosImageMetadata | Next tag value: 384. | String | |
| gcameramicrovideopresentationtimestampus | The presentation timestamp in microseconds of the video frame corresponding to the image still. Value may be -1 to denote unset/unspecified. | PhotosImageMetadata | Next tag value: 384. | integer |
| credits | PhotosImageMetadata | Next tag value: 384. | String | |
| autoenhance | Indicates whether auto-enhance has been applied to the image. | PhotosImageMetadata | Next tag value: 384. | boolean |
| firstphotodate | PhotosImageMetadata | Next tag value: 384. | String | |
| croppedareatoppixels | PhotosImageMetadata | Next tag value: 384. | integer | |
| exifTimeUtcSource | The exif_time_utc_source indicates the source from which the exif_time_utc field is calculated. | PhotosImageMetadata | Next tag value: 384. | String |
| destination | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| hostcomputer | PhotosImageMetadata | Next tag value: 384. | String | |
| url | PhotosImageMetadata | Next tag value: 384. | String | |
| gcreationscameraburstid | PhotosImageMetadata | Next tag value: 384. | String | |
| initialverticalfovdegrees | PhotosImageMetadata | Next tag value: 384. | number | |
| objectcycle | PhotosImageMetadata | Next tag value: 384. | String | |
| modifydate | PhotosImageMetadata | Next tag value: 384. | String | |
| gcameraburstid | A unique String. The property should be present and identical for all images that make up a burst. It should be unique across devices (UUID recommended). Unlike GCreations:CameraBurstId, we should use images with this property to create auto collages and animations. | PhotosImageMetadata | Next tag value: 384. | String |
| nickname | PhotosImageMetadata | Next tag value: 384. | String | |
| ycbcrpositioning | PhotosImageMetadata | Next tag value: 384. | integer | |
| saturation | PhotosImageMetadata | Next tag value: 384. | integer | |
| type | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| copyrightnotice | PhotosImageMetadata | Next tag value: 384. | String | |
| gpsmapdatum | PhotosImageMetadata | Next tag value: 384. | String | |
| modelreleasestatus | PhotosImageMetadata | Next tag value: 384. | String | |
| uno | PhotosImageMetadata | Next tag value: 384. | String | |
| digitalsourcefiletype | PhotosImageMetadata | Next tag value: 384. | String | |
| instructions | PhotosImageMetadata | Next tag value: 384. | String | |
| category | PhotosImageMetadata | Next tag value: 384. | String | |
| ciadrcity | PhotosImageMetadata | Next tag value: 384. | String | |
| gpsdestbearing | PhotosImageMetadata | Next tag value: 384. | number | |
| ciemailwork | PhotosImageMetadata | Next tag value: 384. | String | |
| editorialupdate | PhotosImageMetadata | Next tag value: 384. | String | |
| transmissionreference | PhotosImageMetadata | Next tag value: 384. | String | |
| referenceservice | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| ismpformat | The image is a Multi-Picture Object. | PhotosImageMetadata | Next tag value: 384. | boolean |
| relatedimageheight | PhotosImageMetadata | Next tag value: 384. | String | |
| aperturefnumber | PhotosImageMetadata | Next tag value: 384. | number | |
| ciadrextadr | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| gpstime | This is in UTC Time. Contains three floats: hour, minute and second. Supports subsecond resolution. | PhotosImageMetadata | Next tag value: 384. | list(number) |
| gcameramicrovideoversion | Indicates the file format version of the MicroVideo (initially 1). | PhotosImageMetadata | Next tag value: 384. | integer |
| destinationLatitude | +/- 90 inclusive | PhotosImageMetadata | Next tag value: 384. | float |
| artworkorobject | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| destinationLongitude | +/- 180 inclusive | PhotosImageMetadata | Next tag value: 384. | float |
| exifTimeUtc | The exif_time_utc field is a UTC-based alternative to the exif_time field, which is in local time, rather than UTC. If they were not separate, clients would be unable to distinguish if the source were UTC- or local-based. | PhotosImageMetadata | Next tag value: 384. | String |
| planarconfiguration | PhotosImageMetadata | Next tag value: 384. | integer | |
| fillorder | PhotosImageMetadata | Next tag value: 384. | integer | |
| editstatus | PhotosImageMetadata | Next tag value: 384. | String | |
| grayresponseunit | PhotosImageMetadata | Next tag value: 384. | integer | |
| timezoneminutes | Remaining minutes of offset. | PhotosImageMetadata | Next tag value: 384. | list(integer) |
| contentlocationcode | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| initialviewrolldegrees | PhotosImageMetadata | Next tag value: 384. | integer | |
| poserolldegrees | PhotosImageMetadata | Next tag value: 384. | number | |
| gcameradisableautocreation | The possible values are: “Animation”, “Collage”, “Pano”, “Movies”. Photos will avoid creating the listed types using the containing image or video. The property is optional. The property can be included multiple times to disable creation of multiple different types. | PhotosImageMetadata | Next tag value: 384. | list(String) |
| cvterm | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| metadatadate | PhotosImageMetadata | Next tag value: 384. | String | |
| subsectimeoriginal | PhotosImageMetadata | Next tag value: 384. | String | |
| lens | PhotosImageMetadata | Next tag value: 384. | String | |
| fixtureidentifier | PhotosImageMetadata | Next tag value: 384. | String | |
| sourcephotoscount | PhotosImageMetadata | Next tag value: 384. | integer | |
| actionadvised | PhotosImageMetadata | Next tag value: 384. | String | |
| authorposition | PhotosImageMetadata | Next tag value: 384. | String | |
| imagenumber | PhotosImageMetadata | Next tag value: 384. | String | |
| cameramake | Exif camera make | PhotosImageMetadata | Next tag value: 384. | String |
| scene | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| supplementalcategory | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| contrast | PhotosImageMetadata | Next tag value: 384. | integer | |
| uniqueid | For unique hash: | PhotosImageMetadata | Next tag value: 384. | String |
| audiotype | PhotosImageMetadata | Next tag value: 384. | String | |
| serialnumber | PhotosImageMetadata | Next tag value: 384. | String | |
| croppedarealeftpixels | PhotosImageMetadata | Next tag value: 384. | integer | |
| colorspace | PhotosImageMetadata | Next tag value: 384. | integer | |
| colorprofile | Indicates whether or not the source image had an embedded color profile. | PhotosImageMetadata | Next tag value: 384. | boolean |
| initialhorizontalfovdegrees | PhotosImageMetadata | Next tag value: 384. | number | |
| title | PhotosImageMetadata | Next tag value: 384. | String | |
| gcreationstype | String representation of creation type. Should be one of {“GCameraCollage”, “GCameraAnimation”, “GCameraGroupSmiles”, “GPhotosCollage”, “GPhotosAnimation”}. | PhotosImageMetadata | Next tag value: 384. | String |
| label | PhotosImageMetadata | Next tag value: 384. | String | |
| owner | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| flashenergy | PhotosImageMetadata | Next tag value: 384. | number | |
| publisher | PhotosImageMetadata | Next tag value: 384. | list(String) | |
| iptc4c | PhotosImageMetadata | Next tag value: 384. | PhotosFourCMetadata | |
| sharpness | PhotosImageMetadata | Next tag value: 384. | integer | |
| grayresponsecurve | PhotosImageMetadata | Next tag value: 384. | integer | |
| sphericalPanorama | PhotosPanoramaMetadata | boolean | ||
| vr180Panorama | True if the image is a VR180 image. See go/3d180 for details. | PhotosPanoramaMetadata | boolean | |
| xmax | PhotosVisionGroundtruthdbNormalizedBoundingBox | Bounding box coordinates are relative to the width and height of the image. For example, if image is 100×200 and NormalizedBoundingBox is , the bounding box coordinates will be (10, 40) to (50, 180). Note parts of the bounding box may fall outside the image. | number | |
| xmin | PhotosVisionGroundtruthdbNormalizedBoundingBox | Bounding box coordinates are relative to the width and height of the image. For example, if image is 100×200 and NormalizedBoundingBox is , the bounding box coordinates will be (10, 40) to (50, 180). Note parts of the bounding box may fall outside the image. | number | |
| ymax | PhotosVisionGroundtruthdbNormalizedBoundingBox | Bounding box coordinates are relative to the width and height of the image. For example, if image is 100×200 and NormalizedBoundingBox is , the bounding box coordinates will be (10, 40) to (50, 180). Note parts of the bounding box may fall outside the image. | number | |
| ymin | PhotosVisionGroundtruthdbNormalizedBoundingBox | Bounding box coordinates are relative to the width and height of the image. For example, if image is 100×200 and NormalizedBoundingBox is , the bounding box coordinates will be (10, 40) to (50, 180). Note parts of the bounding box may fall outside the image. | number | |
| floatData | For single precision floating point data | PhotosVisionObjectrecFeatureVector | list(number) | |
| altitudeMeters | Altitude of the point above the earth’s surface, in meters. | PhotosVisionObjectrecGeoLocation | The geo-location of a single point, or of the “center” of a group of points. | float |
| countryCode | Country code string. | PhotosVisionObjectrecGeoLocation | The geo-location of a single point, or of the “center” of a group of points. | String |
| fromGps | Indicates if the lat/lon above is assumed to come from a GPS device. | PhotosVisionObjectrecGeoLocation | The geo-location of a single point, or of the “center” of a group of points. | boolean |
| lat | Latitude in degrees north. Values south of the equator are negative. | PhotosVisionObjectrecGeoLocation | The geo-location of a single point, or of the “center” of a group of points. | float |
| latErrorBound | When applied to a single point, represents the estimated error bounds of manual geotagging. The estimate is based on size of the bounding box of the map used for manual geotagging. When applied to a group of points, the error bounds represent the dispersion around the group center (lat/lon above). The dispersion in this case is computed as half the interquartile range. Reference: http://en.wikipedia.org/wiki/Interquartile_range (lat +/- lat_error_bound, lng +/- lng_error_bound). | PhotosVisionObjectrecGeoLocation | The geo-location of a single point, or of the “center” of a group of points. | float |
| lon | Longitude in degrees east. Values west of 0 deg are negative. | PhotosVisionObjectrecGeoLocation | The geo-location of a single point, or of the “center” of a group of points. | float |
| lonErrorBound | PhotosVisionObjectrecGeoLocation | The geo-location of a single point, or of the “center” of a group of points. | float | |
| additionalInfo | Optional info provided by the feature extractor. | PhotosVisionObjectrecGlobalFeature | Global feature for the image. | String |
| featureVector | PhotosVisionObjectrecGlobalFeature | Global feature for the image. | PhotosVisionObjectrecFeatureVector | |
| quantizedFeatureVector | PhotosVisionObjectrecGlobalFeature | Global feature for the image. | PhotosVisionObjectrecQuantizedFeatureVector | |
| tag | Tag for this global feature. E.g., “DELG”, “SBv4” or “DELG_region1”. | PhotosVisionObjectrecGlobalFeature | Global feature for the image. | String |
| version | PhotosVisionObjectrecGlobalFeature | Global feature for the image. | String | |
| authorName | Name of the author or image source. User-defined. Must be NULL-terminated. | PhotosVisionObjectrecImageTemplate | ImageTemplate contains local and/or global features generated from one image. User-defined members can be set to any value within the constraints outlined below. Algorithms usually pass these through without evaluation, unless documented otherwise. Next id: 29 | String |
| corpus | Identifier for which corpus the image belongs to. Currently Cyclone uses this field in: – photos_vision_objectrec.SpatialMatcherRequest.residual_template to select which spatial matcher should be applied to the candidate matches – photos_vision_objectrec.CustomCorpusQuantizer to map a custom corpus to one or more posting lists | PhotosVisionObjectrecImageTemplate | ImageTemplate contains local and/or global features generated from one image. User-defined members can be set to any value within the constraints outlined below. Algorithms usually pass these through without evaluation, unless documented otherwise. Next id: 29 | String |
| geoLocation | The geolocation of the image. Assumed to represent the location where the photo was taken from. | PhotosVisionObjectrecImageTemplate | ImageTemplate contains local and/or global features generated from one image. User-defined members can be set to any value within the constraints outlined below. Algorithms usually pass these through without evaluation, unless documented otherwise. Next id: 29 | PhotosVisionObjectrecGeoLocation |
| globalFeature | PhotosVisionObjectrecImageTemplate | ImageTemplate contains local and/or global features generated from one image. User-defined members can be set to any value within the constraints outlined below. Algorithms usually pass these through without evaluation, unless documented otherwise. Next id: 29 | list(PhotosVisionObjectrecGlobalFeature) | |
| imageHeight | PhotosVisionObjectrecImageTemplate | ImageTemplate contains local and/or global features generated from one image. User-defined members can be set to any value within the constraints outlined below. Algorithms usually pass these through without evaluation, unless documented otherwise. Next id: 29 | integer | |
| imageId | Unique identifier for the image used to compute this template. | PhotosVisionObjectrecImageTemplate | ImageTemplate contains local and/or global features generated from one image. User-defined members can be set to any value within the constraints outlined below. Algorithms usually pass these through without evaluation, unless documented otherwise. Next id: 29 | String |
| imageUrl | URL or filename of the image used to compute this template. User-defined. Must contain only ASCII characters and be NULL-terminated. | PhotosVisionObjectrecImageTemplate | ImageTemplate contains local and/or global features generated from one image. User-defined members can be set to any value within the constraints outlined below. Algorithms usually pass these through without evaluation, unless documented otherwise. Next id: 29 | String |
| imageWidth | Dimension of the image used to compute this template. | PhotosVisionObjectrecImageTemplate | ImageTemplate contains local and/or global features generated from one image. User-defined members can be set to any value within the constraints outlined below. Algorithms usually pass these through without evaluation, unless documented otherwise. Next id: 29 | integer |
| info | PhotosVisionObjectrecImageTemplate | ImageTemplate contains local and/or global features generated from one image. User-defined members can be set to any value within the constraints outlined below. Algorithms usually pass these through without evaluation, unless documented otherwise. Next id: 29 | String | |
| objectInfo | Tags pertaining to this image. User-defined. Must be NULL-terminated. | PhotosVisionObjectrecImageTemplate | ImageTemplate contains local and/or global features generated from one image. User-defined members can be set to any value within the constraints outlined below. Algorithms usually pass these through without evaluation, unless documented otherwise. Next id: 29 | list(String) |
| objectName | Name of the object/scene depicted. User-defined. Must contain only ASCII characters and be NULL-terminated. | PhotosVisionObjectrecImageTemplate | ImageTemplate contains local and/or global features generated from one image. User-defined members can be set to any value within the constraints outlined below. Algorithms usually pass these through without evaluation, unless documented otherwise. Next id: 29 | String |
| opaqueData | Opaque template data. May be used to pass through additional data from template sources to processing modules, that is not already covered by other members of this PB. It is the responsibility of processing modules to verify that the data is in a compatible format. | PhotosVisionObjectrecImageTemplate | ImageTemplate contains local and/or global features generated from one image. User-defined members can be set to any value within the constraints outlined below. Algorithms usually pass these through without evaluation, unless documented otherwise. Next id: 29 | String |
| roi | Region-of-interest: The bounding box of the object or scene depicted in the image. | PhotosVisionObjectrecImageTemplate | ImageTemplate contains local and/or global features generated from one image. User-defined members can be set to any value within the constraints outlined below. Algorithms usually pass these through without evaluation, unless documented otherwise. Next id: 29 | PhotosVisionObjectrecROI |
| subset | PhotosVisionObjectrecImageTemplate | ImageTemplate contains local and/or global features generated from one image. User-defined members can be set to any value within the constraints outlined below. Algorithms usually pass these through without evaluation, unless documented otherwise. Next id: 29 | list(PhotosVisionObjectrecImageTemplateSubSet) | |
| version | Feature version. | PhotosVisionObjectrecImageTemplate | ImageTemplate contains local and/or global features generated from one image. User-defined members can be set to any value within the constraints outlined below. Algorithms usually pass these through without evaluation, unless documented otherwise. Next id: 29 | String |
| descriptor | PhotosVisionObjectrecImageTemplateSubSet | Each SubSet contains LocalDescriptors of a specific type. The type indicates which algorithm has been used to generate the descriptors. No enum is defined for the descriptor_type. For most applications it is sufficient to know if two descriptors are of the same or a different type, while ignoring the details of their generation. The descriptor type ‘0’ is reserved and must not be used. | list(PhotosVisionObjectrecLocalDescriptor) | |
| descriptorType | PhotosVisionObjectrecImageTemplateSubSet | Each SubSet contains LocalDescriptors of a specific type. The type indicates which algorithm has been used to generate the descriptors. No enum is defined for the descriptor_type. For most applications it is sufficient to know if two descriptors are of the same or a different type, while ignoring the details of their generation. The descriptor type ‘0’ is reserved and must not be used. | integer | |
| isBinaryDescriptor | Used to indicate if the descriptor is binary or not. When decompressing feature this is useful to decide calling different decompression functions. | PhotosVisionObjectrecImageTemplateSubSet | Each SubSet contains LocalDescriptors of a specific type. The type indicates which algorithm has been used to generate the descriptors. No enum is defined for the descriptor_type. For most applications it is sufficient to know if two descriptors are of the same or a different type, while ignoring the details of their generation. The descriptor type ‘0’ is reserved and must not be used. | boolean |
| numDescriptors | Used to store the number of descriptors for statistical purposes, if the descriptors themselves are not stored. | PhotosVisionObjectrecImageTemplateSubSet | Each SubSet contains LocalDescriptors of a specific type. The type indicates which algorithm has been used to generate the descriptors. No enum is defined for the descriptor_type. For most applications it is sufficient to know if two descriptors are of the same or a different type, while ignoring the details of their generation. The descriptor type ‘0’ is reserved and must not be used. | integer |
| affineMatrix | Optional affine matrix. Supersedes scale and orientation if present. r’ = affine_matrix.r + (x,y) defines an affine transform from the normalized image patch (in which the interest point is centered at the origin with scale 1) to the image. If the affine matrix is set, the following approximations are recommended: scale = sqrt(0.5 * (xx*xx + xy*xy + yx*yx + yy*yy)); orientation = atan2(yx – xy, xx + yy); If not present, the affine matrix can be computed from scale and orientation as: xx = scale * cos(orientation); xy = scale * -sin(orientation); yx = scale * sin(orientation); yy = scale * cos(orientation); | PhotosVisionObjectrecLocalDescriptor | LocalDescriptor holds interest point data and an optional local descriptor vector. | PhotosVisionObjectrecMatrix2D |
| data | PhotosVisionObjectrecLocalDescriptor | LocalDescriptor holds interest point data and an optional local descriptor vector. | String | |
| dataFactor | data_factor and data represent the local descriptor vector in a compressed format, using only 8 bit per value. Each byte of the data string yields one component of the local descriptor by bit-casting it to an int8 and multiplying it by data_factor. Protocol buffers do not support int8 directly. | PhotosVisionObjectrecLocalDescriptor | LocalDescriptor holds interest point data and an optional local descriptor vector. | number |
| featureVector | Unquantized feature vector (float). | PhotosVisionObjectrecLocalDescriptor | LocalDescriptor holds interest point data and an optional local descriptor vector. | PhotosVisionObjectrecFeatureVector |
| opaqueData | Opaque descriptor data. May be used to pass through descriptor data from descriptor sources to processing modules, that is not already covered by data/data_factor and/or cannot be expressed as a vector of numbers. It is the responsibility of processing modules to verify that the data is in a compatible format. | PhotosVisionObjectrecLocalDescriptor | LocalDescriptor holds interest point data and an optional local descriptor vector. | String |
| orientation | Orientation is optional, as some interest point detectors don’t compute it. The range of orientation is [-pi,pi). | PhotosVisionObjectrecLocalDescriptor | LocalDescriptor holds interest point data and an optional local descriptor vector. | number |
| scale | Each interest point must have a characteristic scale > 0. | PhotosVisionObjectrecLocalDescriptor | LocalDescriptor holds interest point data and an optional local descriptor vector. | number |
| strength | The strength or weight, indicating the relative significance of this point. | PhotosVisionObjectrecLocalDescriptor | LocalDescriptor holds interest point data and an optional local descriptor vector. | number |
| x | The position in the image with sub-pixel accuracy. The center of the upper left pixel has coordinates (0.0, 0.0). Thus the range for x and y is (-0.5, width – 0.5) x (-0.5, height – 0.5). | PhotosVisionObjectrecLocalDescriptor | LocalDescriptor holds interest point data and an optional local descriptor vector. | number |
| y | PhotosVisionObjectrecLocalDescriptor | LocalDescriptor holds interest point data and an optional local descriptor vector. | number | |
| xx | PhotosVisionObjectrecMatrix2D | A 2×2 float matrix. | number | |
| xy | PhotosVisionObjectrecMatrix2D | A 2×2 float matrix. | number | |
| yx | PhotosVisionObjectrecMatrix2D | A 2×2 float matrix. | number | |
| yy | PhotosVisionObjectrecMatrix2D | A 2×2 float matrix. | number | |
| data | PhotosVisionObjectrecQuantizedFeatureVector | Quantized/compressed feature vector (8 bit per value). Can be decoded by multiplying data_factor to each data byte. | String | |
| dataFactor | PhotosVisionObjectrecQuantizedFeatureVector | Quantized/compressed feature vector (8 bit per value). Can be decoded by multiplying data_factor to each data byte. | number | |
| xMax | PhotosVisionObjectrecROI | A region of interest in the image. | integer | |
| xMin | PhotosVisionObjectrecROI | A region of interest in the image. | integer | |
| yMax | PhotosVisionObjectrecROI | A region of interest in the image. | integer | |
| yMin | PhotosVisionObjectrecROI | A region of interest in the image. | integer | |
| debugInfo | DebugInfo stores debug information from the overall classifier. This allows for instance to update counters related to blacklisting without running the full classifier again. | PornFlagData | A protocol buffer to store the url, referer and porn flag for a url. and an optional image score. Next available tag id: 51. | list(ImagePornDebugInfo) |
| finalOffensiveScore | Final offensive score based on image salient terms and image OCR vulgar and offensive scores. | PornFlagData | A protocol buffer to store the url, referer and porn flag for a url. and an optional image score. Next available tag id: 51. | number |
| finalViolenceScore | Final violence score based on some image signals (brain pixel score, co-clicked images violence score, navboost queries score, etc.). | PornFlagData | A protocol buffer to store the url, referer and porn flag for a url. and an optional image score. Next available tag id: 51. | number |
| finalViolenceScoreVersion | A string that indicates the version of SafeSearch classifier used to compute final_violence_score. | PornFlagData | A protocol buffer to store the url, referer and porn flag for a url. and an optional image score. Next available tag id: 51. | String |
| internalSignals | A proto that stores SafeSearch internal signals that are not exported to clients. SafeSearch team does not provide any guarantees about the presence or the semantics of these signals in the future. | PornFlagData | A protocol buffer to store the url, referer and porn flag for a url. and an optional image score. Next available tag id: 51. | SafesearchInternalImageSignals |
| numberFaces | number of faces | PornFlagData | A protocol buffer to store the url, referer and porn flag for a url. and an optional image score. Next available tag id: 51. | integer |
| ocrAnnotation | Information about image OCR text. For details see image/safesearch/content/public/ocr_annotation.proto. | PornFlagData | A protocol buffer to store the url, referer and porn flag for a url. and an optional image score. Next available tag id: 51. | ImageSafesearchContentOCRAnnotation |
| offensiveSymbolDetection | QuimbyCongas-based detection of offensive symbols in the image (currently swastika and Nazi yellow badge). | PornFlagData | A protocol buffer to store the url, referer and porn flag for a url. and an optional image score. Next available tag id: 51. | ImageSafesearchContentOffensiveSymbolDetection |
| photodnaHash | Binary version of the PhotoDNA hash (144 bytes long). If not set (has_photodna_hash() == false) it means that it was not computed, if empty (has_photodna_hash() == true && photodna_hash() == “”) it means that the computation failed (cannot be computed for images smaller than 50 x 50). | PornFlagData | A protocol buffer to store the url, referer and porn flag for a url. and an optional image score. Next available tag id: 51. | String |
| pornWithHighConfidence | This field is set to true when we are pretty confident that the image is porn (with higher precision than the img_porn_moderate restrict). In particular, it means that the image might be demoted for non-porn queries when SafeSearch is Off. | PornFlagData | A protocol buffer to store the url, referer and porn flag for a url. and an optional image score. Next available tag id: 51. | boolean |
| qbstOffensiveScore | QBST-based image offensive score, Navboost based | PornFlagData | A protocol buffer to store the url, referer and porn flag for a url. and an optional image score. Next available tag id: 51. | number |
| qbstSpoofScore | QBST-based image spoof score, Navboost based, unrelated to the pixel-based score in PornAnnotation. | PornFlagData | A protocol buffer to store the url, referer and porn flag for a url. and an optional image score. Next available tag id: 51. | number |
| queryStats | Query statistics from Navboost logs. For more details see classifier/porn/proto/image_porn_classifier_signals.proto. | PornFlagData | A protocol buffer to store the url, referer and porn flag for a url. and an optional image score. Next available tag id: 51. | ClassifierPornQueryStats |
| queryTextViolenceScore | Aggregated navboost query violence score. | PornFlagData | A protocol buffer to store the url, referer and porn flag for a url. and an optional image score. Next available tag id: 51. | number |
| referer | url of the referer page | PornFlagData | A protocol buffer to store the url, referer and porn flag for a url. and an optional image score. Next available tag id: 51. | String |
| referrerCounts | Information about referrers and their porn classification. For details see classifier/porn/proto/image_porn_classifier_signals.proto. | PornFlagData | A protocol buffer to store the url, referer and porn flag for a url. and an optional image score. Next available tag id: 51. | ClassifierPornReferrerCounts |
| semanticSexualizationScore | Starburst-based score predicting sexualization level of the image. | PornFlagData | A protocol buffer to store the url, referer and porn flag for a url. and an optional image score. Next available tag id: 51. | number |
| url | url of the image | PornFlagData | A protocol buffer to store the url, referer and porn flag for a url. and an optional image score. Next available tag id: 51. | String |
| addressLine | These correspond to the “AddressLine” elements in xAL, which are used to hold unstructured text. This is an addendum to the structured values; when the address is formatted, the provided lines are prepended to the formatted version of the street component fields for Western countries, and appended for CJK countries. These lines are in display order. Formerly users of PostalAddress were discouraged from mixing address_line with structured address elements. Mixing is now encouraged if address_line has to be used at all. | PostalAddress | Next free ID: 32 | list(String) |
| administrativeAreaName | Top-level administrative subdivision of this country. Examples: US state, IT region, UK constituent nation, JP prefecture. | PostalAddress | Next free ID: 32 | String |
| countryName | Name corresponding to country code. Optional. This can usually be inferred from country_name_code. | PostalAddress | Next free ID: 32 | String |
| countryNameCode | xAL does not specify a scheme for country codes. We strongly recommend ISO 3166-1-alpha-2 (two letter codes, as used in DNS) if you use this field. (Use “GB”, not “UK”.) | PostalAddress | Next free ID: 32 | String |
| dependentLocalityName | Dependent locality or sublocality. Used for UK dependent localities, or neighborhoods or boroughs in other locations. If trying to represent a UK double-dependent locality, include both the double-dependent locality and the dependent locality in this field, e.g. “Whaley, Langwith”. | PostalAddress | Next free ID: 32 | String |
| dependentThoroughfareName | Dependent thoroughfares are used to define UK-style dependent thoroughfares, and secondary streets in addresses in other locales, including intersections. Formatting is locale-dependent. | PostalAddress | Next free ID: 32 | String |
| firmName | NEW: The firm or organization. This goes at a finer granularity than address_lines in the address. Omit if not needed. | PostalAddress | Next free ID: 32 | String |
| isDisputed | Required to support the suppression of country names from formatted results for addresses within geo-politically disputed areas. Note that we cannot achieve this by not setting the country, as this would prevent us from selecting a suitable formatting template. Addresses converted from Oyster, by the standard conversion libraries, will have this field set if the address lies within a geo-politically disputed area (ie, contained within features of type TYPE_DISPUTED_AREA) even if the disputed area itself is not a visible part of the formatted address. An example of a disputed area is “No Man’s Land” near Jerusalem which has the flag FLAG_NEVER_DISPLAY set for all its names. See: go/disputed-areas-2014 for more information. | PostalAddress | Next free ID: 32 | boolean |
| languageCode | Language of the address. May affect address formatting for multi- lingual countries. Also allows storing multilingual location names as repeated PostalAddress. Not in xAL. Use language codes which are accepted by i18n_identifiers::LanguageCodeCoverter::FromOther(). Examples include “en” and “de-CH”. | PostalAddress | Next free ID: 32 | String |
| localityName | Locality. This is something of a fuzzy term, but it generally refers to the city/town portion of an address. In regions of the world where localities are not well defined or do not fit into this structure well (for example, Japan), leave locality_name empty and use address_line. Examples: US city, IT comune, UK post town. | PostalAddress | Next free ID: 32 | String |
| postBoxNumber | This corresponds to PostBoxNumber in xAL format. In xAL format, it’s nested inside PostBox, which also contains a “Type” field to distinguish between PO Box, Private Bag etc. Current support in this proto is for PO Box only. Note that although this is modelled as a string, it should have the number only, with any necessary punctuation (such as “-“). For example, for “P.O. Box 123”, this field would hold “123” – the template displaying this would prepend P.O. Box when formatting if necessary. | PostalAddress | Next free ID: 32 | String |
| postalCodeNumber | Despite the name, postal_code_number values are frequently alphanumeric. Examples: “94043”, “SW1W”, “SW1W 9TQ”. | PostalAddress | Next free ID: 32 | String |
| postalCodeNumberExtension | Used for postal-code suffixes, such as the 4-digit extension of a US ZIP+4 code. | PostalAddress | Next free ID: 32 | String |
| premiseName | The “premise” is something like a house or building. | PostalAddress | Next free ID: 32 | String |
| recipientName | NEW: The recipient. This goes at a finer granularity than address_lines in the address. Not present in xAL. Omit if not needed. | PostalAddress | Next free ID: 32 | String |
| sortingCode | This corresponds to the SortingCode sub-element of the xAL PostalServiceElements element. Use is very country-specific. Where it is used, the value is either a string like “CEDEX”, optionally followed by a number (e.g. “CEDEX 7”), or just a number alone, representing the “sector code” (Jamaica), “delivery area indicator” (Malawi) or “post office indicator” (e.g. Côte d’Ivoire). | PostalAddress | Next free ID: 32 | String |
| subAdministrativeAreaName | Second-level administrative subdivision of this country. Examples: US county, IT province, UK county. | PostalAddress | Next free ID: 32 | String |
| subPremiseName | The “subpremise” is something like an apartment or suite. xAL offers more structured premise and subpremise values, but we don’t. | PostalAddress | Next free ID: 32 | String |
| thoroughfareName | Name of thoroughfare. Intersections should be represented with this field or address_line. Examples: “Amphitheatre Parkway”, “N Shoreline Blvd & Charleston Rd” | PostalAddress | Next free ID: 32 | String |
| thoroughfareNumber | Thoroughfare numbers (street numbers) can be very complex indeed. xAL defines fancy structures like “ThoroughfareNumberRange” to represent the details, but we haven’t included that yet. It is worth noting that this needs to be a string, not a number. Example: “1600” | PostalAddress | Next free ID: 32 | String |
| restricts | PrecomputedRestricts | The restricts that are computed before building a Mustang index. | list(String) | |
| Currency | type froogle/currency/currency.h | PremiumPerDocData | Per-doc data for premium documents in the Google index. | integer |
| Date | publishing date (seconds since 1970, | PremiumPerDocData | Per-doc data for premium documents in the Google index. | String |
| Entitlement | entitlement data | PremiumPerDocData | Per-doc data for premium documents in the Google index. | list(integer) |
| IsArchival | True if a free document is archival in nature. | PremiumPerDocData | Per-doc data for premium documents in the Google index. | boolean |
| IsEntitled | User is entitled to see the premium content for free. | PremiumPerDocData | Per-doc data for premium documents in the Google index. | boolean |
| Price | price * 100 if available | PremiumPerDocData | Per-doc data for premium documents in the Google index. | integer |
| Publication | negative values for prior dates) FP of the Premium publication name | PremiumPerDocData | Per-doc data for premium documents in the Google index. | String |
| AsrModel | ASR model MPM version. | PseudoVideoData | Available tags: 14+ | String |
| DocKey | This should be the MustangDocId, we need to figure out how to generate a uint64 given the int64 we have in data_set | PseudoVideoData | Available tags: 14+ | String |
| Lang | Language of the recognizer used to generate transcript. | PseudoVideoData | Available tags: 14+ | String |
| MustangDocId | This is the videodocid associate to the http://video.google.com/videoplay?docid= NUMBER | PseudoVideoData | Available tags: 14+ | String |
| Url | URL for document. | PseudoVideoData | Available tags: 14+ | String |
| s3Mode | PseudoVideoData | Available tags: 14+ | String | |
| s3ModelInfoLabel | S3 ASR model info. | PseudoVideoData | Available tags: 14+ | String |
| transcript | PseudoVideoData | Available tags: 14+ | PseudoVideoDataTranscript | |
| Text | The complete transcription text. | PseudoVideoDataTranscript | A time-coded transcription of the document’s audio track. | String |
| timestamp | PseudoVideoDataTranscript | A time-coded transcription of the document’s audio track. | list(PseudoVideoDataTranscriptTimestamp) | |
| CharOffset | PseudoVideoDataTranscriptTimestamp | Mapping of time/character correspondences. Used to map found snippets to the time and thumbnail nearest that snippet. | integer | |
| Confidence | quantized to values in range 0-127 | PseudoVideoDataTranscriptTimestamp | Mapping of time/character correspondences. Used to map found snippets to the time and thumbnail nearest that snippet. | integer |
| TimeOffset | PseudoVideoDataTranscriptTimestamp | Mapping of time/character correspondences. Used to map found snippets to the time and thumbnail nearest that snippet. | integer | |
| androidIntent | The list of android intents that the app is capable of executing. | QualityActionsAppInfo | Information of the app to be annotated for the query. It contains the name of the app, the package name associated with it. It also contains the confidence associated with {app, package} pair. This confidence is calculated from different signals like navboost, ranking etc. which later is used for ranking the apps for a particular query. The source of this app information is also indicated. This app info can either be from installed app (collected from device content) or from the fastmap. LINT.IfChange | list(String) |
| appName | This is the string matched from the query. | QualityActionsAppInfo | Information of the app to be annotated for the query. It contains the name of the app, the package name associated with it. It also contains the confidence associated with {app, package} pair. This confidence is calculated from different signals like navboost, ranking etc. which later is used for ranking the apps for a particular query. The source of this app information is also indicated. This app info can either be from installed app (collected from device content) or from the fastmap. LINT.IfChange | String |
| category | Category of this package. | QualityActionsAppInfo | Information of the app to be annotated for the query. It contains the name of the app, the package name associated with it. It also contains the confidence associated with {app, package} pair. This confidence is calculated from different signals like navboost, ranking etc. which later is used for ranking the apps for a particular query. The source of this app information is also indicated. This app info can either be from installed app (collected from device content) or from the fastmap. LINT.IfChange | QualityActionsAppUnderstandingCategory |
| confidence | QualityActionsAppInfo | Information of the app to be annotated for the query. It contains the name of the app, the package name associated with it. It also contains the confidence associated with {app, package} pair. This confidence is calculated from different signals like navboost, ranking etc. which later is used for ranking the apps for a particular query. The source of this app information is also indicated. This app info can either be from installed app (collected from device content) or from the fastmap. LINT.IfChange | number | |
| displayName | This is the display name of the app as shown below the app icon. | QualityActionsAppInfo | Information of the app to be annotated for the query. It contains the name of the app, the package name associated with it. It also contains the confidence associated with {app, package} pair. This confidence is calculated from different signals like navboost, ranking etc. which later is used for ranking the apps for a particular query. The source of this app information is also indicated. This app info can either be from installed app (collected from device content) or from the fastmap. LINT.IfChange | String |
| fallbackUrl | URL for the website associated with this app. | QualityActionsAppInfo | Information of the app to be annotated for the query. It contains the name of the app, the package name associated with it. It also contains the confidence associated with {app, package} pair. This confidence is calculated from different signals like navboost, ranking etc. which later is used for ranking the apps for a particular query. The source of this app information is also indicated. This app info can either be from installed app (collected from device content) or from the fastmap. LINT.IfChange | String |
| packageName | Note that the package_name could be empty for two reasons: – The AppInfo is annotated by device content. – The ngram exists in app name fastmap, but there are a lot of packages associated with it. e.g., there could be a lot of apps for app name “recipes app”. | QualityActionsAppInfo | Information of the app to be annotated for the query. It contains the name of the app, the package name associated with it. It also contains the confidence associated with {app, package} pair. This confidence is calculated from different signals like navboost, ranking etc. which later is used for ranking the apps for a particular query. The source of this app information is also indicated. This app info can either be from installed app (collected from device content) or from the fastmap. LINT.IfChange | String |
| source | For the future source, use the field in source_data.source(). | QualityActionsAppInfo | Information of the app to be annotated for the query. It contains the name of the app, the package name associated with it. It also contains the confidence associated with {app, package} pair. This confidence is calculated from different signals like navboost, ranking etc. which later is used for ranking the apps for a particular query. The source of this app information is also indicated. This app info can either be from installed app (collected from device content) or from the fastmap. LINT.IfChange | String |
| sourceData | QualityActionsAppInfo | Information of the app to be annotated for the query. It contains the name of the app, the package name associated with it. It also contains the confidence associated with {app, package} pair. This confidence is calculated from different signals like navboost, ranking etc. which later is used for ranking the apps for a particular query. The source of this app information is also indicated. This app info can either be from installed app (collected from device content) or from the fastmap. LINT.IfChange | list(QualityActionsAppInfoSourceData) | |
| allowListSourceData | QualityActionsAppInfoSourceData | This deprecates the above: * confidence=3 * source=4 This allows us to merge AppInfo data per package_name. | QualityActionsAppInfoSourceDataAllowListSourceData | |
| confidence | Confidence from navboost. | QualityActionsAppInfoSourceData | This deprecates the above: * confidence=3 * source=4 This allows us to merge AppInfo data per package_name. | number |
| install | Number of installs from marmot. | QualityActionsAppInfoSourceData | This deprecates the above: * confidence=3 * source=4 This allows us to merge AppInfo data per package_name. | String |
| isCategorical | QualityActionsAppInfoSourceData | This deprecates the above: * confidence=3 * source=4 This allows us to merge AppInfo data per package_name. | boolean | |
| mediaProviderSourceData | QualityActionsAppInfoSourceData | This deprecates the above: * confidence=3 * source=4 This allows us to merge AppInfo data per package_name. | QualityActionsAppInfoSourceDataMediaProviderSourceData | |
| source | QualityActionsAppInfoSourceData | This deprecates the above: * confidence=3 * source=4 This allows us to merge AppInfo data per package_name. | String | |
| teleportSourceData | Signals present when the source is TELEPORT. | QualityActionsAppInfoSourceData | This deprecates the above: * confidence=3 * source=4 This allows us to merge AppInfo data per package_name. | AssistantTeleportTeleportNicknameSignals |
| preReleaseMode | Whether the app is in the pre-release stage and only available for testing. | QualityActionsAppInfoSourceDataAllowListSourceData | Additional signals when the source is ATV’s allow list. | boolean |
| unknownAppDeviceCompatibility | Whether app compatibility is unknown. This field is needed for apps like apple tv that have different package names on different devices. Play Gateway Service (PGS) lookup is needed to validate that the app is available on the user’s device. go/app-fulfillment-quality | QualityActionsAppInfoSourceDataAllowListSourceData | Additional signals when the source is ATV’s allow list. | boolean |
| providerKey | The unique provider key/enumeration string as used in KG. See also /base/mediaasset/provider/provider_enumerator. | QualityActionsAppInfoSourceDataMediaProviderSourceData | The MEDIA_PROVIDER source can further specify information about the content served by the app. | String |
| providerType | The type of content served by the App. See also chrome.dongle.pints.ProviderType. | QualityActionsAppInfoSourceDataMediaProviderSourceData | The MEDIA_PROVIDER source can further specify information about the content served by the app. | String |
| category | QualityActionsAppUnderstandingCategory | Category that this app falls into. | String | |
| confidence | QualityActionsAppUnderstandingCategory | Category that this app falls into. | number | |
| buttons | Buttons on the notification | QualityActionsCustomizedNotification | DEPRECATED. No longer supported after migration to Tasks. | list(QualityActionsCustomizedNotificationButton) |
| surfaceType | Surface type for the notification | QualityActionsCustomizedNotification | DEPRECATED. No longer supported after migration to Tasks. | String |
| tapAction | Tap action on the notification body. This overwrites the default tap action on reminder trigger notification (which on mobile, is the reminders hub page). | QualityActionsCustomizedNotification | DEPRECATED. No longer supported after migration to Tasks. | QualityActionsCustomizedNotificationPayload |
| text | Notification text | QualityActionsCustomizedNotification | DEPRECATED. No longer supported after migration to Tasks. | String |
| label | REQUIRED. text for the button label | QualityActionsCustomizedNotificationButton | String | |
| tapAction | REQUIRED. tap action for the button | QualityActionsCustomizedNotificationButton | QualityActionsCustomizedNotificationPayload | |
| url | Currently for payload we only support raw string url. More structured options may be added in the future | QualityActionsCustomizedNotificationPayload | String | |
| providers | QualityActionsNewsProviderAnnotationData | Aqua annotation data for news provider. This proto is added as an extension to NimbleAnnotationData.semantics_proto for nimble annotation. | list(QualityActionsNewsProviderAnnotationDataProvider) | |
| locales | List of supported locales for this provider. Must follow the format from go/iii, e.g.: ‘en’, ‘en-US’, ‘en-GB’, etc. Short forms without regions codes, such as, ‘en’ match all possible regions: en-US, en-GB, en-IN, etc. | QualityActionsNewsProviderAnnotationDataProvider | NextId: 6 | list(String) |
| officialName | The official name of the provider. Used in TTS and should be localized. | QualityActionsNewsProviderAnnotationDataProvider | NextId: 6 | String |
| officialNamePronunciation | TTS hint for the pronunciation of the name. Should be left blank unless TTS performs poorly on official_name. Example: Without hinting, TTS mispronounces “The Daily 202” as “the daily two hundred and two”. Feeding tts the string “the daily two oh two” produces correct TTS. | QualityActionsNewsProviderAnnotationDataProvider | NextId: 6 | String |
| providerId | The provider id used for news source URL lookup in Kansas. See b/27250779 for details. | QualityActionsNewsProviderAnnotationDataProvider | NextId: 6 | integer |
| score | A score of how confident the annotated span is a news provider. For example, a high score is assigned for span “bbc news”, but a low score for span “bbc”, which only triggers narrative news aqua parse for a query with explicit news intent, e.g [play news from bbc]. | QualityActionsNewsProviderAnnotationDataProvider | NextId: 6 | float |
| archived | OPTIONAL. True if the reminder is archived. Not present implies false. | QualityActionsReminder | Next id: 33 | boolean |
| archivedTime | OPTIONAL. The time when this reminder is archived. Deprecated. Use `archived_timestamp` instead. | QualityActionsReminder | Next id: 33 | AssistantApiDateTime |
| archivedTimestamp | OPTIONAL. When the reminder was completed (only present when archived == true). Maps to apps_intelligence.dialog.Task’s complete_time field. | QualityActionsReminder | Next id: 33 | DateTime |
| asyncInteractionType | REQUIRED. async_interaction_type of the reminder trigger notification | QualityActionsReminder | Next id: 33 | String |
| attachment | OPTIONAL. Attachments associated with this Reminder. If the attachment has different behavior on different surfaces (e.g., deeplinks), specify multiple attachments here, and specify the surface types and links in the inner fields. There should be at most one attachment for each surface. | QualityActionsReminder | Next id: 33 | list(AssistantRemindersAttachment) |
| bareTitle | OPTIONAL. Populated only for assignable reminders (E.g. “buy milk”). It will be used in the post-execution card-rendering. If not poulated, i.e. in non-assignable mode, caller should fallback to use $title. | QualityActionsReminder | Next id: 33 | String |
| clientId | OPTIONAL. The reminders “client” id. This ID uniquely identifies a reminder instance and may be generated by any client that writes to our Reminder backend. | QualityActionsReminder | Next id: 33 | String |
| clientType | REQUIRED. The type of this attachment. This is used for frontends (e.g., Hubpage) to customize UX. And also for customized VE logging. | QualityActionsReminder | Next id: 33 | QualityDialogManagerReminderClientType |
| createTime | OPTIONAL. The create time of this reminder. This field is propagated only for the reminders fetched from backend. | QualityActionsReminder | Next id: 33 | AssistantApiDateTime |
| createTimestamp | OPTIONAL. The create time of this reminder. This field is propagated only only for the reminders fetched from backend. | QualityActionsReminder | Next id: 33 | DateTime |
| creator | OPTIONAL. Creator of a reminder (owned by the current user). Used in shared reminder RUD operations. | QualityActionsReminder | Next id: 33 | QualityActionsReminderPerson |
| customizedNotificationCard | OPTIONAL. Contains fields needed to build the customized notification card DEPRECATED. No longer supported after migration to Tasks. | QualityActionsReminder | Next id: 33 | list(QualityActionsCustomizedNotification) |
| datetime | A representation of the Gregorian calendar date and timezone-relative time a reminder is scheduled for. This contains the date and time of either a single reminder or the upcoming instance of a recurring reminder. | QualityActionsReminder | Next id: 33 | AssistantApiDateTime |
| description | OPTIONAL. Full-length description of the reminder. | QualityActionsReminder | Next id: 33 | String |
| documentAssignmentSource | QualityActionsReminder | Next id: 33 | QualityActionsReminderDocument | |
| dynamiteGroupAssignmentSource | QualityActionsReminder | Next id: 33 | QualityActionsReminderDynamiteGroup | |
| extraNotificationDeviceId | OPTIONAL. Device ID for home notification which should have loud notification. See go/device-id-storage-in-tasks | QualityActionsReminder | Next id: 33 | String |
| id | DEPRECATED. Use `client_id` or `server_id` instead. | QualityActionsReminder | Next id: 33 | String |
| location | QualityActionsReminder | Next id: 33 | QualityActionsReminderLocation | |
| log | OPTIONAL. Associated logs to be plumbed through along with a reminder. | QualityActionsReminder | Next id: 33 | AssistantLogsReminderLog |
| memoryPayload | OPTIONAL. Memory record payload which is associated with this reminder. This will be set for all Assistant reminders created after the first launch of the Reminder Memory integration, see go/reminders-memory for more details. Also, this might apply to all other types of reminders. | QualityActionsReminder | Next id: 33 | AssistantRemindersMemoryPayload |
| notifying | OPTIONAL. True if the reminder is notifying on the device that is making the request to the server. | QualityActionsReminder | Next id: 33 | boolean |
| personalReferenceMetadata | OPTIONAL. Populated if the reminder is based off of a personal reference, e.g. [my hotel] when the user has a hotel reservation. Contains the information needed for suggestion chip attribution, e.g. a link back to the email reservation. | QualityActionsReminder | Next id: 33 | CopleySourceTypeList |
| recipient | OPTIONAL. Recipient of a reminder (created by the current user). Used for shared reminder CRUD operations. | QualityActionsReminder | Next id: 33 | QualityActionsReminderPerson |
| recurrence | QualityActionsReminder | Next id: 33 | QualityActionsReminderRecurrenceInfo | |
| serverId | OPTIONAL. The reminders backend “server” id. Only filled in some scenarios, e.g. to generate the reminders hubpage detailed-reminder view. | QualityActionsReminder | Next id: 33 | String |
| symbolicTime | QualityActionsReminder | Next id: 33 | String | |
| title | REQUIRED. The main textual representation of the reminder with the final title. For assignable reminders, this would be e.g. “From John: buy milk”. | QualityActionsReminder | Next id: 33 | String |
| updateTimestamp | OPTIONAL. The last updated time of this reminder. This field is propagated only for the reminders fetched from ARIS (go/aris-dd). | QualityActionsReminder | Next id: 33 | DateTime |
| categoryInfo | QualityActionsReminderLocation | A representation of reminder-triggering locations. They may be specific, resolved locations, non-specific location groups, or personal aliases. Next id: 12 | QualityActionsReminderLocationCategoryInfo | |
| chainInfo | QualityActionsReminderLocation | A representation of reminder-triggering locations. They may be specific, resolved locations, non-specific location groups, or personal aliases. Next id: 12 | QualityActionsReminderLocationChainInfo | |
| customLocationType | Optional additional information about the types of the custom location. This field is not stored in backend, and is only used to plumb NLP information to fulfillment UI. | QualityActionsReminderLocation | A representation of reminder-triggering locations. They may be specific, resolved locations, non-specific location groups, or personal aliases. Next id: 12 | String |
| displayAddress | An address string that is suitable for displaying to the user in an application interface. It can be detailed, or brief. e.g. “80 Absolute Ave, Unit 1708, Mississauga, ON” e.g. “151 Charles Street West” | QualityActionsReminderLocation | A representation of reminder-triggering locations. They may be specific, resolved locations, non-specific location groups, or personal aliases. Next id: 12 | String |
| geoFeatureId | Filled if location_type is CUSTOM and this is a resolved instance of a business (not for specific address locations). | QualityActionsReminderLocation | A representation of reminder-triggering locations. They may be specific, resolved locations, non-specific location groups, or personal aliases. Next id: 12 | GeostoreFeatureIdProto |
| lat | QualityActionsReminderLocation | A representation of reminder-triggering locations. They may be specific, resolved locations, non-specific location groups, or personal aliases. Next id: 12 | float | |
| lng | QualityActionsReminderLocation | A representation of reminder-triggering locations. They may be specific, resolved locations, non-specific location groups, or personal aliases. Next id: 12 | float | |
| locationType | QualityActionsReminderLocation | A representation of reminder-triggering locations. They may be specific, resolved locations, non-specific location groups, or personal aliases. Next id: 12 | String | |
| name | Descriptive name, e.g. “43rd st new york”, a user-edited place name (e.g. “Gym”), or a reverse geocoded business name. This can be any string. | QualityActionsReminderLocation | A representation of reminder-triggering locations. They may be specific, resolved locations, non-specific location groups, or personal aliases. Next id: 12 | String |
| personalLocationMetadata | Deprecated in favor of Reminder.personal_reference_metadata. | QualityActionsReminderLocation | A representation of reminder-triggering locations. They may be specific, resolved locations, non-specific location groups, or personal aliases. Next id: 12 | CopleySourceTypeList |
| ttsAddress | A localized, shortened version of the address, suitable for TTS. This originates in the LocationFrame. | QualityActionsReminderLocation | A representation of reminder-triggering locations. They may be specific, resolved locations, non-specific location groups, or personal aliases. Next id: 12 | String |
| displayName | A (localized) display string describing the category. This is s generic string describing the category, and may be different than the term the user actually said, e.g. name: “supermarket”, display_name: “Grocery Stores” | QualityActionsReminderLocationCategoryInfo | If LocationType is CATEGORICAL, this is info about the category. For example, the category “Grocery Stores” includes chains such as Safeway and Whole Foods. | String |
| locationCategory | QualityActionsReminderLocationCategoryInfo | If LocationType is CATEGORICAL, this is info about the category. For example, the category “Grocery Stores” includes chains such as Safeway and Whole Foods. | String | |
| chainMid | The freebase mid of the chain entity. | QualityActionsReminderLocationChainInfo | If LocationType is CHAIN, this is info about the chain. | String |
| chainName | The geostore.NameProto.text (corresponding to the user’s language) at the time of reminder creation. In most cases, this is the same as name, but there may be corner cases where they differ, e.g. name: “bestbuy”, chain_name: “Best Buy”. | QualityActionsReminderLocationChainInfo | If LocationType is CHAIN, this is info about the chain. | String |
| featureId | The (corporate entity) chain’s MapFacts feature id. | QualityActionsReminderLocationChainInfo | If LocationType is CHAIN, this is info about the chain. | GeostoreFeatureIdProto |
| displayName | REQUIRED. Their full name, which will be shown/spoken when referring to this person informally, e.g. “You have 2 reminders from Dave Smith.” | QualityActionsReminderPerson | A representation of a person other than the current user, who may have created the reminder for the current user, or will receive it from them. | String |
| emailAddress | OPTIONAL. Their email address. | QualityActionsReminderPerson | A representation of a person other than the current user, who may have created the reminder for the current user, or will receive it from them. | String |
| gaiaId | REQUIRED. Their gaia id (used by the backend for CRUD operations). | QualityActionsReminderPerson | A representation of a person other than the current user, who may have created the reminder for the current user, or will receive it from them. | String |
| givenName | REQUIRED. Their given name, which will be shown/spoken when referring to this person informally, e.g. “You have 2 reminders from Dave.” | QualityActionsReminderPerson | A representation of a person other than the current user, who may have created the reminder for the current user, or will receive it from them. | String |
| photoUrl | OPTIONAL. The URL of the photo. This field is read from photo field from go/people-api. Also see go/khdgk for URL formats. This field might be missing if user does not have photo URL available. | QualityActionsReminderPerson | A representation of a person other than the current user, who may have created the reminder for the current user, or will receive it from them. | String |
| clientId | OPTIONAL. Client-assigned-id for the recurring reminder | QualityActionsReminderRecurrenceInfo | Recurrence rule for specifying time-based repeating reminders. | String |
| recurrence | The recurrence pattern. | QualityActionsReminderRecurrenceInfo | Recurrence rule for specifying time-based repeating reminders. | AssistantApiRecurrence |
| recurrenceId | An id which uniquely identifies a recurrence series. | QualityActionsReminderRecurrenceInfo | Recurrence rule for specifying time-based repeating reminders. | String |
| serverId | REQUIRED. Server-assigned-id for the recurring reminder | QualityActionsReminderRecurrenceInfo | Recurrence rule for specifying time-based repeating reminders. | String |
| pauseDuration | The delay between each two sounds. | QualityActionsRingtone | Ringtone information used for the notification of timer and alarm. | AssistantApiDuration |
| soundUrl | The sound urls will be used to play. | QualityActionsRingtone | Ringtone information used for the notification of timer and alarm. | list(String) |
| homegraphId | QualityActionsRoom | The room in which an alarm or timer resides | String | |
| name | QualityActionsRoom | The room in which an alarm or timer resides | String | |
| creationTime | The time when this timer was created | QualityActionsTimer | Conceptually, timers are clocks that count down from an initial duration and notify when they reach 0. In practice, as a timer is running, it holds a stable expiration time and computes the remaining duration using the current time. When a timer is paused, it holds a stable remaining duration. | AssistantApiTimestamp |
| device | Identifies the device this timer belongs to. | QualityActionsTimer | Conceptually, timers are clocks that count down from an initial duration and notify when they reach 0. In practice, as a timer is running, it holds a stable expiration time and computes the remaining duration using the current time. When a timer is paused, it holds a stable remaining duration. | AssistantApiSettingsDeviceSettings |
| expireTime | When not paused: the time the timer is (or was) scheduled to expire, in milliseconds since the Unix epoch. This should be deprecated and replaced by the expire_timer_time with DateTime type once DateTime proto includes unix timestamp (b/63636831). | QualityActionsTimer | Conceptually, timers are clocks that count down from an initial duration and notify when they reach 0. In practice, as a timer is running, it holds a stable expiration time and computes the remaining duration using the current time. When a timer is paused, it holds a stable remaining duration. | String |
| expireTimerTime | This is currently being only used only for the response generation when the user describe the expired datatime as a search constraint. We will used it for everything else once that for filtering once DateTime proto includes unix timestamp (b/63636831) and expire_time is deprecated. | QualityActionsTimer | Conceptually, timers are clocks that count down from an initial duration and notify when they reach 0. In practice, as a timer is running, it holds a stable expiration time and computes the remaining duration using the current time. When a timer is paused, it holds a stable remaining duration. | NlpSemanticParsingDatetimeDateTime |
| id | A string key used as an identifier to this timer, unique for a given Provider. | QualityActionsTimer | Conceptually, timers are clocks that count down from an initial duration and notify when they reach 0. In practice, as a timer is running, it holds a stable expiration time and computes the remaining duration using the current time. When a timer is paused, it holds a stable remaining duration. | String |
| label | The label, provided by a user, associated with this timer. | QualityActionsTimer | Conceptually, timers are clocks that count down from an initial duration and notify when they reach 0. In practice, as a timer is running, it holds a stable expiration time and computes the remaining duration using the current time. When a timer is paused, it holds a stable remaining duration. | String |
| lastUpdated | The time when this timer was last updated (creation, paused, resumed, etc.) | QualityActionsTimer | Conceptually, timers are clocks that count down from an initial duration and notify when they reach 0. In practice, as a timer is running, it holds a stable expiration time and computes the remaining duration using the current time. When a timer is paused, it holds a stable remaining duration. | AssistantApiTimestamp |
| originalDuration | The duration of the timer when it was started, in milliseconds. | QualityActionsTimer | Conceptually, timers are clocks that count down from an initial duration and notify when they reach 0. In practice, as a timer is running, it holds a stable expiration time and computes the remaining duration using the current time. When a timer is paused, it holds a stable remaining duration. | String |
| originalTimerDuration | The duration set for the timer. The DateTimeModifier field is ignored. This field is currently only experimental until we switch the Dialog code and gramnar to the new format. | QualityActionsTimer | Conceptually, timers are clocks that count down from an initial duration and notify when they reach 0. In practice, as a timer is running, it holds a stable expiration time and computes the remaining duration using the current time. When a timer is paused, it holds a stable remaining duration. | NlpSemanticParsingDatetimeDuration |
| provider | The provider that owns this alarm. For Android, this includes the app that owns this alarm, where an intent should be sent to modify it. | QualityActionsTimer | Conceptually, timers are clocks that count down from an initial duration and notify when they reach 0. In practice, as a timer is running, it holds a stable expiration time and computes the remaining duration using the current time. When a timer is paused, it holds a stable remaining duration. | AssistantApiCoreTypesProvider |
| remainingDuration | When PAUSED: the remaining duration in milliseconds. | QualityActionsTimer | Conceptually, timers are clocks that count down from an initial duration and notify when they reach 0. In practice, as a timer is running, it holds a stable expiration time and computes the remaining duration using the current time. When a timer is paused, it holds a stable remaining duration. | String |
| remainingTimerDuration | The duration remained for the timer. This is needed because there is no expiration date for paused timer. The DateTimeModifier field is ignored. This field is currently only experimental until we switch the Dialog code and gramnar to the new format. | QualityActionsTimer | Conceptually, timers are clocks that count down from an initial duration and notify when they reach 0. In practice, as a timer is running, it holds a stable expiration time and computes the remaining duration using the current time. When a timer is paused, it holds a stable remaining duration. | NlpSemanticParsingDatetimeDuration |
| ringtone | The ringtone will be played when the timer fires, it will replace the beep sound if it is not empty. | QualityActionsTimer | Conceptually, timers are clocks that count down from an initial duration and notify when they reach 0. In practice, as a timer is running, it holds a stable expiration time and computes the remaining duration using the current time. When a timer is paused, it holds a stable remaining duration. | QualityActionsRingtone |
| ringtoneTaskMetadata | Ringtone Task Metadata information used to generate sound for firing the timer. | QualityActionsTimer | Conceptually, timers are clocks that count down from an initial duration and notify when they reach 0. In practice, as a timer is running, it holds a stable expiration time and computes the remaining duration using the current time. When a timer is paused, it holds a stable remaining duration. | AssistantApiCoreTypesRingtoneTaskMetadata |
| room | Contains info about the room the timer is in | QualityActionsTimer | Conceptually, timers are clocks that count down from an initial duration and notify when they reach 0. In practice, as a timer is running, it holds a stable expiration time and computes the remaining duration using the current time. When a timer is paused, it holds a stable remaining duration. | QualityActionsRoom |
| status | The current status of the timer. | QualityActionsTimer | Conceptually, timers are clocks that count down from an initial duration and notify when they reach 0. In practice, as a timer is running, it holds a stable expiration time and computes the remaining duration using the current time. When a timer is paused, it holds a stable remaining duration. | String |
| vibrate | Whether or not the device will vibrate when the timer fires. | QualityActionsTimer | Conceptually, timers are clocks that count down from an initial duration and notify when they reach 0. In practice, as a timer is running, it holds a stable expiration time and computes the remaining duration using the current time. When a timer is paused, it holds a stable remaining duration. | boolean |
| pageEmbedding | QualityAuthorityTopicEmbeddingsVersionedItem | Proto populated into shards and copied to superroot. Message storing a versioned TopicEmbeddings scores. This is copied from TopicEmbeddings in docjoins. | String | |
| siteEmbedding | Compressed site/page embeddings. | QualityAuthorityTopicEmbeddingsVersionedItem | Proto populated into shards and copied to superroot. Message storing a versioned TopicEmbeddings scores. This is copied from TopicEmbeddings in docjoins. | String |
| siteFocusScore | Number denoting how much a site is focused on one topic. | QualityAuthorityTopicEmbeddingsVersionedItem | Proto populated into shards and copied to superroot. Message storing a versioned TopicEmbeddings scores. This is copied from TopicEmbeddings in docjoins. | number |
| siteRadius | The measure of how far page_embeddings deviate from the site_embedding. | QualityAuthorityTopicEmbeddingsVersionedItem | Proto populated into shards and copied to superroot. Message storing a versioned TopicEmbeddings scores. This is copied from TopicEmbeddings in docjoins. | number |
| versionId | QualityAuthorityTopicEmbeddingsVersionedItem | Proto populated into shards and copied to superroot. Message storing a versioned TopicEmbeddings scores. This is copied from TopicEmbeddings in docjoins. | integer | |
| applicationId | QualityCalypsoAppsLink | list(String) | ||
| defaultFormatInformation | Fallback option for the LiveOp format. We will try en-US -> en -> any locale and get the first one that is available. | QualityCalypsoAppsUniversalAuLiveOpDetail | Contains the needed information for serving a single LiveOp/LiveEvent on AU. Next ID: 9 | QualityCalypsoAppsUniversalAuLiveOpFormat |
| defaultScheduleInformation | Fallback option for the LiveOp event scheduling information. Will use earliest start time and last end time from PDC LiveOps data dump. | QualityCalypsoAppsUniversalAuLiveOpDetail | Contains the needed information for serving a single LiveOp/LiveEvent on AU. Next ID: 9 | QualityCalypsoAppsUniversalAuLiveOpEvent |
| eventId | android | QualityCalypsoAppsUniversalAuLiveOpDetail | Contains the needed information for serving a single LiveOp/LiveEvent on AU. Next ID: 9 | String |
| eventType | [REQUIRED] type of live op event. | QualityCalypsoAppsUniversalAuLiveOpDetail | Contains the needed information for serving a single LiveOp/LiveEvent on AU. Next ID: 9 | String |
| eventUrl | ios | QualityCalypsoAppsUniversalAuLiveOpDetail | Contains the needed information for serving a single LiveOp/LiveEvent on AU. Next ID: 9 | String |
| priority | QualityCalypsoAppsUniversalAuLiveOpDetail | Contains the needed information for serving a single LiveOp/LiveEvent on AU. Next ID: 9 | String | |
| endTimestampMillis | [REQUIRED] End time in UTC for the live-op event. | QualityCalypsoAppsUniversalAuLiveOpEvent | Contains the schedule for a single live-op event. Next ID: 4 | String |
| previewTimestampMillis | If specified, a live-op event must be shown only after this preview-time (in UTC). Otherwise, the event can be shown at any time as long as its before the end time. | QualityCalypsoAppsUniversalAuLiveOpEvent | Contains the schedule for a single live-op event. Next ID: 4 | String |
| startTimestampMillis | [REQUIRED] Start time in UTC for the live-op event. | QualityCalypsoAppsUniversalAuLiveOpEvent | Contains the schedule for a single live-op event. Next ID: 4 | String |
| deeplink | QualityCalypsoAppsUniversalAuLiveOpFormat | Contains the format information for a single LiveOp/LiveEvent. Next ID: 11 | String | |
| description | QualityCalypsoAppsUniversalAuLiveOpFormat | Contains the format information for a single LiveOp/LiveEvent. Next ID: 11 | String | |
| eyebrow | iOS only, kind of event type | QualityCalypsoAppsUniversalAuLiveOpFormat | Contains the format information for a single LiveOp/LiveEvent. Next ID: 11 | String |
| imageUrl | QualityCalypsoAppsUniversalAuLiveOpFormat | Contains the format information for a single LiveOp/LiveEvent. Next ID: 11 | String | |
| originalImageUrl | QualityCalypsoAppsUniversalAuLiveOpFormat | Contains the format information for a single LiveOp/LiveEvent. Next ID: 11 | String | |
| squareImageUrl | QualityCalypsoAppsUniversalAuLiveOpFormat | Contains the format information for a single LiveOp/LiveEvent. Next ID: 11 | String | |
| status | iOS only, sort of start schedule | QualityCalypsoAppsUniversalAuLiveOpFormat | Contains the format information for a single LiveOp/LiveEvent. Next ID: 11 | String |
| title | QualityCalypsoAppsUniversalAuLiveOpFormat | Contains the format information for a single LiveOp/LiveEvent. Next ID: 11 | String | |
| videoId | QualityCalypsoAppsUniversalAuLiveOpFormat | Contains the format information for a single LiveOp/LiveEvent. Next ID: 11 | String | |
| videoUrl | QualityCalypsoAppsUniversalAuLiveOpFormat | Contains the format information for a single LiveOp/LiveEvent. Next ID: 11 | String | |
| liveOpEvents | QualityCalypsoAppsUniversalAuLiveOpsDetailInfo | Stores all possible LiveOps/LiveEvents that are eligible to be shown for an app. | list(QualityCalypsoAppsUniversalAuLiveOpDetail) | |
| packageName | QualityCalypsoAppsUniversalAuLiveOpsDetailInfo | Stores all possible LiveOps/LiveEvents that are eligible to be shown for an app. | String | |
| fifeUrl | QualityCalypsoAppsUniversalImage | String | ||
| height | QualityCalypsoAppsUniversalImage | integer | ||
| width | QualityCalypsoAppsUniversalImage | integer | ||
| enhancedImage | iOS cover image, which includes the uni image from UAM only. | QualityCalypsoAppsUniversalImageData | QualityCalypsoAppsUniversalImage | |
| featureGraphic | aka. promotional image / cover image. | QualityCalypsoAppsUniversalImageData | QualityCalypsoAppsUniversalImage | |
| screenshot | QualityCalypsoAppsUniversalImageData | list(QualityCalypsoAppsUniversalImage) | ||
| dailyClicks | QualityCopiaFireflySiteSignal | Proto message containing site-level signal for search stack. Because firefly_stats.proto depends on “//segindexer:compositedoc_proto”, we cannot make perdocdata contain it. | String | |
| dailyGoodClicks | QualityCopiaFireflySiteSignal | Proto message containing site-level signal for search stack. Because firefly_stats.proto depends on “//segindexer:compositedoc_proto”, we cannot make perdocdata contain it. | String | |
| dataTimeSec | QualityCopiaFireflySiteSignal | Proto message containing site-level signal for search stack. Because firefly_stats.proto depends on “//segindexer:compositedoc_proto”, we cannot make perdocdata contain it. | String | |
| firstBoostedTimeSec | QualityCopiaFireflySiteSignal | Proto message containing site-level signal for search stack. Because firefly_stats.proto depends on “//segindexer:compositedoc_proto”, we cannot make perdocdata contain it. | String | |
| impressionsInBoostedPeriod | QualityCopiaFireflySiteSignal | Proto message containing site-level signal for search stack. Because firefly_stats.proto depends on “//segindexer:compositedoc_proto”, we cannot make perdocdata contain it. | String | |
| latestBylineDateSec | QualityCopiaFireflySiteSignal | Proto message containing site-level signal for search stack. Because firefly_stats.proto depends on “//segindexer:compositedoc_proto”, we cannot make perdocdata contain it. | String | |
| latestFirstseenSec | QualityCopiaFireflySiteSignal | Proto message containing site-level signal for search stack. Because firefly_stats.proto depends on “//segindexer:compositedoc_proto”, we cannot make perdocdata contain it. | String | |
| numOfArticles8 | QualityCopiaFireflySiteSignal | Proto message containing site-level signal for search stack. Because firefly_stats.proto depends on “//segindexer:compositedoc_proto”, we cannot make perdocdata contain it. | String | |
| numOfArticlesByPeriods | number of articles (lattice article score is 0.8 or more) sliced by 30 days (num_of_articles_by_periods[0] is the newest). | QualityCopiaFireflySiteSignal | Proto message containing site-level signal for search stack. Because firefly_stats.proto depends on “//segindexer:compositedoc_proto”, we cannot make perdocdata contain it. | list(String) |
| numOfGamblingPages | QualityCopiaFireflySiteSignal | Proto message containing site-level signal for search stack. Because firefly_stats.proto depends on “//segindexer:compositedoc_proto”, we cannot make perdocdata contain it. | String | |
| numOfUrls | QualityCopiaFireflySiteSignal | Proto message containing site-level signal for search stack. Because firefly_stats.proto depends on “//segindexer:compositedoc_proto”, we cannot make perdocdata contain it. | String | |
| numOfUrlsByPeriods | number of urls sliced by 30 days (num_of_urls_by_periods[0] is the newest). | QualityCopiaFireflySiteSignal | Proto message containing site-level signal for search stack. Because firefly_stats.proto depends on “//segindexer:compositedoc_proto”, we cannot make perdocdata contain it. | list(String) |
| recentImpForQuotaSystem | QualityCopiaFireflySiteSignal | Proto message containing site-level signal for search stack. Because firefly_stats.proto depends on “//segindexer:compositedoc_proto”, we cannot make perdocdata contain it. | String | |
| siteFp | Hash value of the site. This will be used by our experiment and analysis. | QualityCopiaFireflySiteSignal | Proto message containing site-level signal for search stack. Because firefly_stats.proto depends on “//segindexer:compositedoc_proto”, we cannot make perdocdata contain it. | String |
| totalImpressions | QualityCopiaFireflySiteSignal | Proto message containing site-level signal for search stack. Because firefly_stats.proto depends on “//segindexer:compositedoc_proto”, we cannot make perdocdata contain it. | String | |
| blueGingerSupportedServices | This field tells us whether this LocalResult supports any of the services that Blue Ginger offers. | QualityDialogManagerExternalIds | Various external IDs that we may have for a given LocalResult. These IDs can map to the corresponding result in other Google systems (KnowledgeGraph) or in third-party systems (OpenTable). | BlueGingerClientVisibleProtoBlueGingerSupportedServices |
| knowledgeGraphMid | QualityDialogManagerExternalIds | Various external IDs that we may have for a given LocalResult. These IDs can map to the corresponding result in other Google systems (KnowledgeGraph) or in third-party systems (OpenTable). | String | |
| maddenSupportedActions | Google-internal actions supported by go/madden for this LocalResult. | QualityDialogManagerExternalIds | Various external IDs that we may have for a given LocalResult. These IDs can map to the corresponding result in other Google systems (KnowledgeGraph) or in third-party systems (OpenTable). | GeoOndemandAssistantSupportedActions |
| openTableRestaurantId | QualityDialogManagerExternalIds | Various external IDs that we may have for a given LocalResult. These IDs can map to the corresponding result in other Google systems (KnowledgeGraph) or in third-party systems (OpenTable). | String | |
| intent | LINT.ThenChange( //depot/google3/googledata/nlp/generation/messages/assistant/\\ dialog_LOCAL_LocalAssistantSchema/\\ dialog.LOCAL.LocalAssistantSchema_zxx.genx.textpb, //depot/google3/quality/dialog_manager/verticals/local/assistant/\\ suggestion_chip_util.cc) | QualityDialogManagerLocalIntentOptions | list(String) | |
| adminArea1 | This field can represent different areas depending on the country. For example in the US it is state but in Canada it would be a province. | QualityDialogManagerLocalResult | A generic representation of a local result returned by a local backend. Next ID: 33 | String |
| availableIntents | The set of available intents changes with result. An intersection of available_intents and allowed_intents (See: local_config.proto), is shown to the user. | QualityDialogManagerLocalResult | A generic representation of a local result returned by a local backend. Next ID: 33 | QualityDialogManagerLocalIntentOptions |
| businessType | Bitset of business types this result falls into. Many fields in this message may be unset – expect good coverage for restaurants and hotels for now, but not for other verticals. | QualityDialogManagerLocalResult | A generic representation of a local result returned by a local backend. Next ID: 33 | NlpSemanticParsingLocalBusinessType |
| country | QualityDialogManagerLocalResult | A generic representation of a local result returned by a local backend. Next ID: 33 | String | |
| countryCode | The two-letter ISO 3166-1 country code of this result. Generated by FindFeatureCountryCode http://google3/geostore/base/public/country.h?l=39&rcl=154898119 so it should always be populated, but technically there is no guarantee. | QualityDialogManagerLocalResult | A generic representation of a local result returned by a local backend. Next ID: 33 | String |
| distanceMeters | For a directions result, this field will be the distance from the origin to this result using the best measure we have available – the distance along a route, if we have one, or just the crow’s flight distance. For a local result, this field will be the crow’s flight distance from the user to the result. | QualityDialogManagerLocalResult | A generic representation of a local result returned by a local backend. Next ID: 33 | String |
| distanceUnits | The standard units of the location where the user is based (not their current location). For example, miles for a user from the US, kilometers for the UK. A US user currently in the UK should have units read in miles. | QualityDialogManagerLocalResult | A generic representation of a local result returned by a local backend. Next ID: 33 | String |
| externalIds | Various external IDs that we may have for this result. | QualityDialogManagerLocalResult | A generic representation of a local result returned by a local backend. Next ID: 33 | QualityDialogManagerExternalIds |
| featureType | QualityDialogManagerLocalResult | A generic representation of a local result returned by a local backend. Next ID: 33 | String | |
| inUserAdminArea1 | If true, this LocalResult is located in the same state as the user’s location. | QualityDialogManagerLocalResult | A generic representation of a local result returned by a local backend. Next ID: 33 | boolean |
| inUserCountry | If true, this LocalResult is located in the same country as the user’s location. | QualityDialogManagerLocalResult | A generic representation of a local result returned by a local backend. Next ID: 33 | boolean |
| inUserLocality | Whether this result is in the same city or town that the user is in. | QualityDialogManagerLocalResult | A generic representation of a local result returned by a local backend. Next ID: 33 | boolean |
| internalFoodOrderingMetadata | Internal Food ordering action (i.e food ordering via Google) metadata. | QualityDialogManagerLocalResult | A generic representation of a local result returned by a local backend. Next ID: 33 | LocalsearchProtoInternalFoodOrderingActionMetadata |
| isBusinessChain | If the original query had a chain intent, and this result is for a business chain. | QualityDialogManagerLocalResult | A generic representation of a local result returned by a local backend. Next ID: 33 | boolean |
| locality | City/Town. | QualityDialogManagerLocalResult | A generic representation of a local result returned by a local backend. Next ID: 33 | String |
| name | The name of the result, extracted from its FeatureProto’s name field. | QualityDialogManagerLocalResult | A generic representation of a local result returned by a local backend. Next ID: 33 | String |
| neighborhood | Neighborhood within a city. This field is not likely to be set for towns or smaller cities. | QualityDialogManagerLocalResult | A generic representation of a local result returned by a local backend. Next ID: 33 | String |
| resultId | All info we will need to lookup this result in search. | QualityDialogManagerLocalResult | A generic representation of a local result returned by a local backend. Next ID: 33 | NlpSemanticParsingLocalLocalResultId |
| streetName | QualityDialogManagerLocalResult | A generic representation of a local result returned by a local backend. Next ID: 33 | String | |
| streetNumber | QualityDialogManagerLocalResult | A generic representation of a local result returned by a local backend. Next ID: 33 | String | |
| synonym | A list of text synonyms the user could use to refer to the result. | QualityDialogManagerLocalResult | A generic representation of a local result returned by a local backend. Next ID: 33 | list(String) |
| ttsAddress | The address of this result formatted for TTS output. This formatting removes acronyms like 2-letter state codes as they cannot be spoken well. | QualityDialogManagerLocalResult | A generic representation of a local result returned by a local backend. Next ID: 33 | String |
| type | QualityDialogManagerReminderClientType | Define Reminder Client Type. This field is for the purposes of 1) UX Customization: Reminder frontends can be configured to have a slightly different UX (e.g., A customized button on Hubpage. A customized notification layout.) 2) Metrics: Client can count how many Reminders with a certain client type are retrieved/mutated. (e.g., VEIDs in go/oparaw.) 3) Index: ListReminder can list all Reminders with a certain client type. 4) Visibility control: some frontends (identified by provenance type, shortn/_xVC9nY2Eb8) only have access to a subset of client types. | String | |
| bylineDateSecs | Publish date set by webmaster. See detailed description here: http://shortn/_1eC0zzjR7k. Note that this will currently only be set for canonical documents where byline date could be extracted. | QualityDniDocPreviewRestrictions | Set of per-document markup restrictions based on go/eucd-indexing-design. Used for EUCD and global preview compliance. Next ID: 20 | String |
| crawlTsUsec | The time that the info in this attachment was computed during crawl, in microseconds. | QualityDniDocPreviewRestrictions | Set of per-document markup restrictions based on go/eucd-indexing-design. Used for EUCD and global preview compliance. Next ID: 20 | String |
| extendedNewsPreviewsDomain | Whether this document comes from a domain that is affected by Extended News Previews (ENP) and its status (approved/rejected). | QualityDniDocPreviewRestrictions | Set of per-document markup restrictions based on go/eucd-indexing-design. Used for EUCD and global preview compliance. Next ID: 20 | QualityDniExtendedNewsPreviews |
| faviconDisplay | Whether the favicon for a given domain should be displayed. FAVICON_DISPLAY_UNSPECIFIED – Display the favicon DISABLE_FAVICON – the favicon should not be rendered by the feature | QualityDniDocPreviewRestrictions | Set of per-document markup restrictions based on go/eucd-indexing-design. Used for EUCD and global preview compliance. Next ID: 20 | String |
| firstseenDateSecs | Firstseen date populated by indexing. It works as fallback to byline_date if it doesn’t exist. Note that this will currently only be set for canonical documents where firstseen date could be populated. | QualityDniDocPreviewRestrictions | Set of per-document markup restrictions based on go/eucd-indexing-design. Used for EUCD and global preview compliance. Next ID: 20 | integer |
| isAmp | Only be true when the page itself is an AMP page. For paired AMP, the canonical page will have this bit as false. | QualityDniDocPreviewRestrictions | Set of per-document markup restrictions based on go/eucd-indexing-design. Used for EUCD and global preview compliance. Next ID: 20 | boolean |
| isEucdDomain | QualityDniDocPreviewRestrictions | Set of per-document markup restrictions based on go/eucd-indexing-design. Used for EUCD and global preview compliance. Next ID: 20 | boolean | |
| maxSnippetLength | The max number of snippet characters allowed. Based on document markup. No limit if value is less than 0, Google could use any length of snippets. Default value 0 is the strictest restriction, to avoid violating mistakenly If not set, there is no snippet length policy to enforce. Features must first check has_max_snippet_length to avoid applying an overly strict policy. | QualityDniDocPreviewRestrictions | Set of per-document markup restrictions based on go/eucd-indexing-design. Used for EUCD and global preview compliance. Next ID: 20 | integer |
| maxSnippetLengthFromPublisher | Same as the max_snippet_length, max_thumbnail_size, max_video_preview_secs listed above. But values are based on publisher’s preferences from Search Console’s robots meta tag tool. | QualityDniDocPreviewRestrictions | Set of per-document markup restrictions based on go/eucd-indexing-design. Used for EUCD and global preview compliance. Next ID: 20 | integer |
| maxSnippetLengthPublisherDefault | QualityDniDocPreviewRestrictions | Set of per-document markup restrictions based on go/eucd-indexing-design. Used for EUCD and global preview compliance. Next ID: 20 | integer | |
| maxThumbnailSize | The max thumbnail size allowed. Based on document markup Default value NONE is the strictest restriction, to avoid violating mistakenly. If not set, there is no thumbnail policy to enforce. | QualityDniDocPreviewRestrictions | Set of per-document markup restrictions based on go/eucd-indexing-design. Used for EUCD and global preview compliance. Next ID: 20 | String |
| maxThumbnailSizeFromPublisher | QualityDniDocPreviewRestrictions | Set of per-document markup restrictions based on go/eucd-indexing-design. Used for EUCD and global preview compliance. Next ID: 20 | String | |
| maxThumbnailSizePublisherDefault | QualityDniDocPreviewRestrictions | Set of per-document markup restrictions based on go/eucd-indexing-design. Used for EUCD and global preview compliance. Next ID: 20 | integer | |
| maxVideoPreviewSecs | The max seconds of video preview allowed. Based on document markup. No limit if value is less than 0, Google could show any seconds of video. Default value 0 is the strictest restriction, to avoid violating mistakenly If not set, there is no preview length policy to enforce. Features must first check has_max_video_preview_secs to avoid applying an overly strict policy. | QualityDniDocPreviewRestrictions | Set of per-document markup restrictions based on go/eucd-indexing-design. Used for EUCD and global preview compliance. Next ID: 20 | integer |
| maxVideoPreviewSecsFromPublisher | QualityDniDocPreviewRestrictions | Set of per-document markup restrictions based on go/eucd-indexing-design. Used for EUCD and global preview compliance. Next ID: 20 | integer | |
| maxVideoPreviewSecsPublisherDefault | QualityDniDocPreviewRestrictions | Set of per-document markup restrictions based on go/eucd-indexing-design. Used for EUCD and global preview compliance. Next ID: 20 | integer | |
| snippetLengthSource | Source of snippet length. | QualityDniDocPreviewRestrictions | Set of per-document markup restrictions based on go/eucd-indexing-design. Used for EUCD and global preview compliance. Next ID: 20 | String |
| thumbnailSizeSource | Source of thumbnail size. | QualityDniDocPreviewRestrictions | Set of per-document markup restrictions based on go/eucd-indexing-design. Used for EUCD and global preview compliance. Next ID: 20 | String |
| videoPreviewSecsSource | Source of video preview seconds. | QualityDniDocPreviewRestrictions | Set of per-document markup restrictions based on go/eucd-indexing-design. Used for EUCD and global preview compliance. Next ID: 20 | String |
| desnippetedCountryCode | List of countries that desnippet the publisher. ISO 3166-1-alpha-2 country code (such as FR). See go/iiuse#region-identifiers. Used in V1. | QualityDniExtendedNewsPreviews | When making changes to this proto, make sure to run: blaze test commerce/datastore/tools/codegen:code_generator_test blaze run commerce/datastore/tools/codegen:code_generator See http://go/cds-schema-council for details. LINT.IfChange | list(String) |
| policyCriteriaBase64 | Search Console Signals that modifies how policy are calculated. Didn’t add `wmconsole.EnpDesnippetingOverrideRules` direcly to avoid cicular dependency issue: go/enp-v2#bookmark=id.dvb1qcltabv9 ENPv2 proto (EnpDesnippetingOverrideRules): google3/crawler/wmconsole/proto/config_enp_desnippeting_override_rules.proto | QualityDniExtendedNewsPreviews | When making changes to this proto, make sure to run: blaze test commerce/datastore/tools/codegen:code_generator_test blaze run commerce/datastore/tools/codegen:code_generator See http://go/cds-schema-council for details. LINT.IfChange | String |
| status | ENP status. | QualityDniExtendedNewsPreviews | When making changes to this proto, make sure to run: blaze test commerce/datastore/tools/codegen:code_generator_test blaze run commerce/datastore/tools/codegen:code_generator See http://go/cds-schema-council for details. LINT.IfChange | String |
| version | The default version is V0 (for backward compatibility). | QualityDniExtendedNewsPreviews | When making changes to this proto, make sure to run: blaze test commerce/datastore/tools/codegen:code_generator_test blaze run commerce/datastore/tools/codegen:code_generator See http://go/cds-schema-council for details. LINT.IfChange | String |
| encodedCalibratedFringeSitePriorScore | QualityFringeFringeQueryPriorPerDocData | PerDocData for fringe-query-prior (built into the shards for eventual consumption at Fringe classification time). Not stored in DocJoins. NEXT ID: 16 | integer | |
| encodedChardXlqHoaxPrediction | An encoding of the Chard XLQ-hoax prediction in [0,1]. | QualityFringeFringeQueryPriorPerDocData | PerDocData for fringe-query-prior (built into the shards for eventual consumption at Fringe classification time). Not stored in DocJoins. NEXT ID: 16 | integer |
| encodedChardXlqTranslatedPrediction | An encoding of the Chard XLQ prediction on translated content in [0,1]. | QualityFringeFringeQueryPriorPerDocData | PerDocData for fringe-query-prior (built into the shards for eventual consumption at Fringe classification time). Not stored in DocJoins. NEXT ID: 16 | integer |
| encodedChardXlqYmylPrediction | An encoding of the Chard XLQ-YMYL prediction in [0,1]. | QualityFringeFringeQueryPriorPerDocData | PerDocData for fringe-query-prior (built into the shards for eventual consumption at Fringe classification time). Not stored in DocJoins. NEXT ID: 16 | integer |
| encodedDaftScore | An encoding of the Document About Fringe Topic (daft) score in [0, 1]. | QualityFringeFringeQueryPriorPerDocData | PerDocData for fringe-query-prior (built into the shards for eventual consumption at Fringe classification time). Not stored in DocJoins. NEXT ID: 16 | integer |
| encodedDocumentFringeVulnerability | An estimate of the vulnerability of this doc to show fringe content, based on the context around the document. Can be interpreted as a ‘safe’ QScore threshold to use (see go/doc-fringe-vulnerability for more info). Encoded for compactness and to restrict visibility. Please contact fringe-ranking@ to get access to quality_fringe::DocumentFringeVulnerabilityEncoding to decode this field. | QualityFringeFringeQueryPriorPerDocData | PerDocData for fringe-query-prior (built into the shards for eventual consumption at Fringe classification time). Not stored in DocJoins. NEXT ID: 16 | integer |
| encodedEntityPriorScore | Highest entity prior seen for document’s Headline and SingleTopic entities (see go/topicality-score for definitions of entity topicalities). Represents probability that a query is fringe, given that the entity is in the result set with topicality >= Headline. Scores scaled to integers between 0 and 1000 for compactness. Scores must be interpreted through FringeQueryPriorEncoding::Decode API. | QualityFringeFringeQueryPriorPerDocData | PerDocData for fringe-query-prior (built into the shards for eventual consumption at Fringe classification time). Not stored in DocJoins. NEXT ID: 16 | integer |
| encodedFringePriorScore | Probability that a query is fringe, given this document is in the result set. Scores scaled to integers between 0 and 1000 for compactness. Scores must be interpreted through FringeQueryPriorEncoding::Decode API. | QualityFringeFringeQueryPriorPerDocData | PerDocData for fringe-query-prior (built into the shards for eventual consumption at Fringe classification time). Not stored in DocJoins. NEXT ID: 16 | integer |
| encodedFringeSitePriorScore | Probability that a query is fringe, given this document’s site is in the result set. Scores scaled to integers between 0 and 1000 for compactness. Scores must be interpreted through FringeQueryPriorEncoding::Decode API. | QualityFringeFringeQueryPriorPerDocData | PerDocData for fringe-query-prior (built into the shards for eventual consumption at Fringe classification time). Not stored in DocJoins. NEXT ID: 16 | integer |
| encodedFringeSitePriorScoreForQfsTraining | Probability that a query is fringe, given this document’s site is in the result set. Does not use signals with a dependency on the QueryFringeScore of a document. Scores scaled to integers between 0 and 1000 for compactness. Scores must be interpreted through FringeQueryPriorEncoding::Decode API. Will NOT be present if the fringe_site_prior_score_for_qfs_training is not significantly different from the site_prior_score. | QualityFringeFringeQueryPriorPerDocData | PerDocData for fringe-query-prior (built into the shards for eventual consumption at Fringe classification time). Not stored in DocJoins. NEXT ID: 16 | integer |
| encodedPredictedXlqScoreAndConfidence | A combined encoding of the pXLQ score in [0,1] and the confidence with which that score should be interpreted in [0,1]. | QualityFringeFringeQueryPriorPerDocData | PerDocData for fringe-query-prior (built into the shards for eventual consumption at Fringe classification time). Not stored in DocJoins. NEXT ID: 16 | integer |
| encodedProximityScore | A score in [0, 1] representing the similarity of this doc to known fringe-vulnerable ‘seeds’. See go/fringe-proximity for more information. Encoded for compactness and to restrict visibility. | QualityFringeFringeQueryPriorPerDocData | PerDocData for fringe-query-prior (built into the shards for eventual consumption at Fringe classification time). Not stored in DocJoins. NEXT ID: 16 | integer |
| encodedPseudoraterPxlqScore | An encoding of the XLQ pseudorater severity score translated into pXLQ score space in [0,1]. The encoding includes the pseudorater version and confidence. | QualityFringeFringeQueryPriorPerDocData | PerDocData for fringe-query-prior (built into the shards for eventual consumption at Fringe classification time). Not stored in DocJoins. NEXT ID: 16 | integer |
| sensitiveEntitiesIndices | Indices on the repository_webref::WebrefEntities::entity field of entities that represent a person or a group of people (aka sensitive entities). Will be deprecated once sensitive_entities_mids is fully launched (see b/290268614). | QualityFringeFringeQueryPriorPerDocData | PerDocData for fringe-query-prior (built into the shards for eventual consumption at Fringe classification time). Not stored in DocJoins. NEXT ID: 16 | list(integer) |
| sensitiveEntitiesMids | MIDs of entities that represent a person or a group of people (aka sensitive entities). See b/290268614 for reference why this is needed in replacement to sensitive_entities_indices. | QualityFringeFringeQueryPriorPerDocData | PerDocData for fringe-query-prior (built into the shards for eventual consumption at Fringe classification time). Not stored in DocJoins. NEXT ID: 16 | list(String) |
| entities | QualityGenieComplexQueriesComplexQueriesOutputRewrite | list(QualityGenieComplexQueriesComplexQueriesOutputRewriteEntity) | ||
| rewriteType | QualityGenieComplexQueriesComplexQueriesOutputRewrite | String | ||
| textualRewrite | QualityGenieComplexQueriesComplexQueriesOutputRewrite | String | ||
| mid | QualityGenieComplexQueriesComplexQueriesOutputRewriteEntity | String | ||
| name | QualityGenieComplexQueriesComplexQueriesOutputRewriteEntity | String | ||
| brainlocVersion | QualityGeoBrainlocBrainlocAttachment | Compressed version of quality_geo_brainloc.goldmine.BrainlocAnnotation for indexing. (See BrainlocAnnotation for detailed documentation.) Next ID: 10 | integer | |
| topCitiesRawScores | QualityGeoBrainlocBrainlocAttachment | Compressed version of quality_geo_brainloc.goldmine.BrainlocAnnotation for indexing. (See BrainlocAnnotation for detailed documentation.) Next ID: 10 | list(integer) | |
| topCitiesVocabIds | Compressed top locations and their scores. *Locations are stored using their model vocab IDs. *Location scores are stored using 14 bits of precision (2 bytes). | QualityGeoBrainlocBrainlocAttachment | Compressed version of quality_geo_brainloc.goldmine.BrainlocAnnotation for indexing. (See BrainlocAnnotation for detailed documentation.) Next ID: 10 | list(integer) |
| topCountiesRawScores | QualityGeoBrainlocBrainlocAttachment | Compressed version of quality_geo_brainloc.goldmine.BrainlocAnnotation for indexing. (See BrainlocAnnotation for detailed documentation.) Next ID: 10 | list(integer) | |
| topCountiesVocabIds | QualityGeoBrainlocBrainlocAttachment | Compressed version of quality_geo_brainloc.goldmine.BrainlocAnnotation for indexing. (See BrainlocAnnotation for detailed documentation.) Next ID: 10 | list(integer) | |
| topCountriesRawScores | QualityGeoBrainlocBrainlocAttachment | Compressed version of quality_geo_brainloc.goldmine.BrainlocAnnotation for indexing. (See BrainlocAnnotation for detailed documentation.) Next ID: 10 | list(integer) | |
| topCountriesVocabIds | QualityGeoBrainlocBrainlocAttachment | Compressed version of quality_geo_brainloc.goldmine.BrainlocAnnotation for indexing. (See BrainlocAnnotation for detailed documentation.) Next ID: 10 | list(integer) | |
| topStatesRawScores | QualityGeoBrainlocBrainlocAttachment | Compressed version of quality_geo_brainloc.goldmine.BrainlocAnnotation for indexing. (See BrainlocAnnotation for detailed documentation.) Next ID: 10 | list(integer) | |
| topStatesVocabIds | QualityGeoBrainlocBrainlocAttachment | Compressed version of quality_geo_brainloc.goldmine.BrainlocAnnotation for indexing. (See BrainlocAnnotation for detailed documentation.) Next ID: 10 | list(integer) | |
| label | QualityLabelsGoogleLabelData | list(QualityLabelsGoogleLabelDataLabel) | ||
| confidence | If global_label_value is present, confidence is ignored. confidence is DEPRECATED. | QualityLabelsGoogleLabelDataLabel | number | |
| globalLabelBucket | A byte-size value representing 64 * (1 + global_label_value). Use this instead of global_label_value to save on label storage. See quality_prose::LabelValueToBucket() for more info. | QualityLabelsGoogleLabelDataLabel | integer | |
| globalLabelValue | QualityLabelsGoogleLabelDataLabel | number | ||
| labelId | At least one of label_id and label_name must be filled in | QualityLabelsGoogleLabelDataLabel | integer | |
| labelName | QualityLabelsGoogleLabelDataLabel | String | ||
| provider | QualityLabelsGoogleLabelDataLabel | list(QualityLabelsGoogleLabelDataLabelProvider) | ||
| providerId | QualityLabelsGoogleLabelDataLabel | list(String) | ||
| feed | This field is intended to be deprecated. If id == 0 and feed is true it means this label is from a feed. If id == 0 and feed is false, this label is from “Google” If id != 0, feed is meaningless. | QualityLabelsGoogleLabelDataLabelProvider | If Provider group is not present the provider is the legacy classifiers (with id 0) and the label_value provided by Google is the global_label_value. | boolean |
| id | We are currently using this field to indicate an id of the set of classifiers that produced this label. This deviates from the original intention. Also see ClassifierDescription and refer to http://go/genre-labels-provider-id for further info. | QualityLabelsGoogleLabelDataLabelProvider | If Provider group is not present the provider is the legacy classifiers (with id 0) and the label_value provided by Google is the global_label_value. | String |
| labelBucket | A byte-size value representing 64 * (1 + global_label_value). Use it instead of global_label_value to save on label storage. | QualityLabelsGoogleLabelDataLabelProvider | If Provider group is not present the provider is the legacy classifiers (with id 0) and the label_value provided by Google is the global_label_value. | integer |
| labelValue | QualityLabelsGoogleLabelDataLabelProvider | If Provider group is not present the provider is the legacy classifiers (with id 0) and the label_value provided by Google is the global_label_value. | number | |
| name | This name will only sometimes be filled in! Frontends can in general expect this to be filled in, but it will not usually be stored in backends. | QualityLabelsGoogleLabelDataLabelProvider | If Provider group is not present the provider is the legacy classifiers (with id 0) and the label_value provided by Google is the global_label_value. | String |
| absoluteImpressions | Thus far this field is only used for host level unsquashed impressions. When compressed (e.g., in perdocdata.proto, CompressedQualitySignals), this value is represented individually and thus is generally incompatible with the other values which are compressed as click-ratios. | QualityNavboostCrapsCrapsClickSignals | Click / impression signals for craps. The tag numbers are the same as they were in the original CrapsData (below). This is deliberate. | float |
| badClicks | QualityNavboostCrapsCrapsClickSignals | Click / impression signals for craps. The tag numbers are the same as they were in the original CrapsData (below). This is deliberate. | float | |
| clicks | QualityNavboostCrapsCrapsClickSignals | Click / impression signals for craps. The tag numbers are the same as they were in the original CrapsData (below). This is deliberate. | float | |
| goodClicks | QualityNavboostCrapsCrapsClickSignals | Click / impression signals for craps. The tag numbers are the same as they were in the original CrapsData (below). This is deliberate. | float | |
| impressions | QualityNavboostCrapsCrapsClickSignals | Click / impression signals for craps. The tag numbers are the same as they were in the original CrapsData (below). This is deliberate. | float | |
| lastLongestClicks | QualityNavboostCrapsCrapsClickSignals | Click / impression signals for craps. The tag numbers are the same as they were in the original CrapsData (below). This is deliberate. | float | |
| unicornClicks | The subset of clicks that are associated with an event from a Unicorn user. | QualityNavboostCrapsCrapsClickSignals | Click / impression signals for craps. The tag numbers are the same as they were in the original CrapsData (below). This is deliberate. | float |
| unsquashedClicks | This is not being populated for the current format – instead two instances of CrapsClickSignals (squashed/unsquashed) are used. We are migrating to the new format where this field will be populated. | QualityNavboostCrapsCrapsClickSignals | Click / impression signals for craps. The tag numbers are the same as they were in the original CrapsData (below). This is deliberate. | float |
| unsquashedImpressions | This is not being populated for the current format – instead two instances of CrapsClickSignals (squashed/unsquashed) are used. We are migrating to the new format where this field will be populated. | QualityNavboostCrapsCrapsClickSignals | Click / impression signals for craps. The tag numbers are the same as they were in the original CrapsData (below). This is deliberate. | float |
| unsquashedLastLongestClicks | QualityNavboostCrapsCrapsClickSignals | Click / impression signals for craps. The tag numbers are the same as they were in the original CrapsData (below). This is deliberate. | float | |
| badClicks | QualityNavboostCrapsCrapsData | NEXT TAG: 28 | float | |
| clicks | QualityNavboostCrapsCrapsData | NEXT TAG: 28 | float | |
| country | The two-letter uppercase country slice of the CrapsData. Examples: “US”, “FR”, “BR” | QualityNavboostCrapsCrapsData | NEXT TAG: 28 | String |
| device | The device interface and os slice of the CrapsData. | QualityNavboostCrapsCrapsData | NEXT TAG: 28 | QualityNavboostCrapsCrapsDevice |
| features | Contains CrapsClickSignals for specific features. (i.e. for mobile, US, metro id – 123″) | QualityNavboostCrapsCrapsData | NEXT TAG: 28 | list(QualityNavboostCrapsFeatureCrapsData) |
| goodClicks | QualityNavboostCrapsCrapsData | NEXT TAG: 28 | float | |
| impressions | These fields may become legacy fields; we may retire them and use the squashed field (below) instead, to allow for some nesting. | QualityNavboostCrapsCrapsData | NEXT TAG: 28 | float |
| language | The language slice of the CrapsData. Examples: “en”, “fr”, “pt-BR”, | QualityNavboostCrapsCrapsData | NEXT TAG: 28 | String |
| lastLongestClicks | The number of clicks that were last and longest in related user queries. | QualityNavboostCrapsCrapsData | NEXT TAG: 28 | float |
| mobileData | DO NOT USE: Use the above mobile_signals fields instead. DO NOT REMOVE: Field is present in legacy protos in golden tests. | QualityNavboostCrapsCrapsData | NEXT TAG: 28 | QualityNavboostCrapsCrapsData |
| mobileSignals | The portion of this CrapsData aggregated on data from tier 1/2 mobile interfaces in QSessions. | QualityNavboostCrapsCrapsData | NEXT TAG: 28 | QualityNavboostCrapsCrapsClickSignals |
| packedIpAddress | Contains a packed string in network byte order, as expected by CrapsIpPrior. Only populated if we looked up the ip_prior_bad_fraction at retrieval time. | QualityNavboostCrapsCrapsData | NEXT TAG: 28 | String |
| patternLevel | Level of pattern. More general patterns get higher values. For URL patterns this field = 0. For example, if we have “http://abc.def.ghi/xyz.html” level 0 pattern will be “http://abc.def.ghi/xyz.html” level 1 pattern will be “p://abc.def.ghi” level 2 pattern will be “p://def.ghi” | QualityNavboostCrapsCrapsData | NEXT TAG: 28 | integer |
| patternSccStats | For pattern data, this will contain stats of the SCC’s of the individual urls contributing to the pattern. | QualityNavboostCrapsCrapsData | NEXT TAG: 28 | QualityNavboostCrapsStatsWithWeightsProto |
| query | QualityNavboostCrapsCrapsData | NEXT TAG: 28 | String | |
| sliceTag | This field can be used by the craps pipeline to slice up signals by various attributes such as device type, country, locale etc. The slice_tag can be an arbitrary string, and the CrapsData values for each slice_tag are aggregated separately, together with the default empty slice_tag. | QualityNavboostCrapsCrapsData | NEXT TAG: 28 | String |
| squashed | Not used yet – we will probably move the impressions / clicks / good_clicks bad clicks / last longest clicks into here from top level, and rename those fields to legacy. | QualityNavboostCrapsCrapsData | NEXT TAG: 28 | QualityNavboostCrapsCrapsClickSignals |
| unscaledIpPriorBadFraction | Used to assign a prior based on IP address. See quality/navboost/craps/craps-ip-prior.h. This value is prior to the linear transformation (scaling / offset / min / max) that’s applied in craps-penalty.cc. | QualityNavboostCrapsCrapsData | NEXT TAG: 28 | float |
| unsquashed | We will start using this one for the retuning rollout. | QualityNavboostCrapsCrapsData | NEXT TAG: 28 | QualityNavboostCrapsCrapsClickSignals |
| unsquashedMobileSignals | QualityNavboostCrapsCrapsData | NEXT TAG: 28 | QualityNavboostCrapsCrapsClickSignals | |
| url | QualityNavboostCrapsCrapsData | NEXT TAG: 28 | String | |
| voterTokenCount | The number of distinct voter tokens (a lower bound on the number of distinct users that contributed to the entry, used for privacy-related filtering). | QualityNavboostCrapsCrapsData | NEXT TAG: 28 | integer |
| os | QualityNavboostCrapsCrapsDevice | CrapsDevice has the gws interface, gws tier and operating system for events from QSessions. | String | |
| uxInterface | An enum taken from GWSLogEntryProto that indicates what type of device a request came from. This includes an entry for DESKTOP(1), MOBILE(2), and TABLET(3) devices. Reference: – gwslog(608): GWSLogEntryProto.ux_interface | QualityNavboostCrapsCrapsDevice | CrapsDevice has the gws interface, gws tier and operating system for events from QSessions. | integer |
| uxTier | Indicates the device browser tier for the given request. 1 means modern browsers, 3 means very old browsers, and 2 is everything in the middle. See Reference: – gwslog(609): GWSLogEntryProto.ux_tier | QualityNavboostCrapsCrapsDevice | CrapsDevice has the gws interface, gws tier and operating system for events from QSessions. | integer |
| country | Country, like “us”. If not present, it’s an aggregation for all countries. This is the same format as one used in Glue. | QualityNavboostCrapsFeatureCrapsData | String | |
| device | Device, like “m”. If not present, it’s an aggregation for all devices. “m” – mobile devices. “d” – destop devices. | QualityNavboostCrapsFeatureCrapsData | String | |
| language | Language, like “en”. If not present, it’s an aggregation for all languages. This is the same format as one used in Glue. | QualityNavboostCrapsFeatureCrapsData | String | |
| locationId | Location id for metro and city. If not present, it’s an aggregation for all locations within current country. | QualityNavboostCrapsFeatureCrapsData | integer | |
| signals | CRAPS Signals for the locale. | QualityNavboostCrapsFeatureCrapsData | QualityNavboostCrapsCrapsClickSignals | |
| voterTokenBitmap | The set of voter tokens of the sessions that contributed to this feature’s stats. Voter tokens are not unique per user, so it is a lower bound on the number of distinct users. Used for privacy-related filtering. | QualityNavboostCrapsFeatureCrapsData | QualityNavboostGlueVoterTokenBitmapMessage | |
| hi | QualityNavboostCrapsStatsWithWeightsProto | float | ||
| kind | QualityNavboostCrapsStatsWithWeightsProto | integer | ||
| lo | QualityNavboostCrapsStatsWithWeightsProto | float | ||
| mean | QualityNavboostCrapsStatsWithWeightsProto | float | ||
| median | QualityNavboostCrapsStatsWithWeightsProto | float | ||
| n | QualityNavboostCrapsStatsWithWeightsProto | integer | ||
| pc10 | QualityNavboostCrapsStatsWithWeightsProto | float | ||
| pc25 | QualityNavboostCrapsStatsWithWeightsProto | float | ||
| pc75 | QualityNavboostCrapsStatsWithWeightsProto | float | ||
| pc90 | QualityNavboostCrapsStatsWithWeightsProto | float | ||
| stdError | QualityNavboostCrapsStatsWithWeightsProto | float | ||
| stddev | QualityNavboostCrapsStatsWithWeightsProto | float | ||
| varOfMean | QualityNavboostCrapsStatsWithWeightsProto | float | ||
| variance | QualityNavboostCrapsStatsWithWeightsProto | float | ||
| weightedN | QualityNavboostCrapsStatsWithWeightsProto | float | ||
| subRange | QualityNavboostGlueVoterTokenBitmapMessage | Used for aggregating query unique voter_token during merging. We use 4 uint64(s) as a 256-bit bitmap to aggregate distinct voter_tokens in Glue model pipeline. Number of elements should always be either 0 or 4. As an optimization, we store the voter_token as a single uint64 if only one bit is set. See quality/navboost/speedy_glue/util/voter_token_bitmap.h for the class that manages operations on these bitmaps. | list(String) | |
| voterToken | QualityNavboostGlueVoterTokenBitmapMessage | Used for aggregating query unique voter_token during merging. We use 4 uint64(s) as a 256-bit bitmap to aggregate distinct voter_tokens in Glue model pipeline. Number of elements should always be either 0 or 4. As an optimization, we store the voter_token as a single uint64 if only one bit is set. See quality/navboost/speedy_glue/util/voter_token_bitmap.h for the class that manages operations on these bitmaps. | String | |
| versionedSignals | QualityNsrExperimentalNsrTeamData | Experimental NsrTeam data. This is a proto containing versioned signals which can be used to run live experiments. This proto will not be propagated to MDU shards, but it will be populated at query time by go/web-signal-joins inside the CompressedQualitySignals subproto of PerDocData proto. See go/0DayLEs for the design doc. Note how this is only meant to be used during LEs, it should *not* be used for launches. | list(QualityNsrExperimentalNsrTeamScoringSignal) | |
| valueBool | QualityNsrExperimentalNsrTeamScoringSignal | The versioned signals used by the ExperimentalNsrTeamData proto. | boolean | |
| valueDouble | QualityNsrExperimentalNsrTeamScoringSignal | The versioned signals used by the ExperimentalNsrTeamData proto. | float | |
| valueFloat | QualityNsrExperimentalNsrTeamScoringSignal | The versioned signals used by the ExperimentalNsrTeamData proto. | number | |
| valueInt32 | QualityNsrExperimentalNsrTeamScoringSignal | The versioned signals used by the ExperimentalNsrTeamData proto. | integer | |
| valueString | QualityNsrExperimentalNsrTeamScoringSignal | The versioned signals used by the ExperimentalNsrTeamData proto. | String | |
| valueUint32 | QualityNsrExperimentalNsrTeamScoringSignal | The versioned signals used by the ExperimentalNsrTeamData proto. | integer | |
| versionId | QualityNsrExperimentalNsrTeamScoringSignal | The versioned signals used by the ExperimentalNsrTeamData proto. | integer | |
| experimentalNsrTeamData | QualityNsrExperimentalNsrTeamWSJData | This is a wrapper needed for the WSJ corpus. We want the WSJ RPCs to inject both the experimental_data and the keys, and as of June 2022 these need to be first level members of the proto. | QualityNsrExperimentalNsrTeamData | |
| lookupKey | The key used to lookup this data in the WSJ corpus. The WSJ data is sitechunk-level, however the documents in the MDU shards are simply urls. WSJ does a mapping from url -> {primary_chunk, secondary, fallbacks, etc.} and retrieves all the keys from the corpus. This lookup key field will keep track of which key was used for this particular lookup. | QualityNsrExperimentalNsrTeamWSJData | This is a wrapper needed for the WSJ corpus. We want the WSJ RPCs to inject both the experimental_data and the keys, and as of June 2022 these need to be first level members of the proto. | String |
| siteFrac | What fraction of the site went into the computation of the site_score. Should be a number in (0, 1]. | QualityNsrKetoKetoVersionedData | Data populated to NsrData and hence propagated to docjoins/ascorer/superroot/etc. | number |
| siteScore | Site-level aggregated keto score. | QualityNsrKetoKetoVersionedData | Data populated to NsrData and hence propagated to docjoins/ascorer/superroot/etc. | number |
| versionId | Unique id of the version. | QualityNsrKetoKetoVersionedData | Data populated to NsrData and hence propagated to docjoins/ascorer/superroot/etc. | integer |
| primaryChunk | Primary NSR sitechunk. In most of the cases it’s same as HOST_LEVEL_V3 sitechunked canonical url of the document. In rare, but important cases it’s based on page markup (see quality/nsr/util/sitechunker.h for details). | QualityNsrNsrChunksProto | The NsrChunksProto corresponds to the NSRChunks class. The data saved by the proto and the class is the same. We provide utilities to go from one to the other. | String |
| secondaryChunks | Secondary NSR sitechunk. When present, it provides more granular chunking than primary sitechunks (see quality/nsr/util/sitechunker.h for details). Note that the NSRChunks class does not store trivial secondary chunks. Be aware of this when constructing NsrChunksProto from scratch. | QualityNsrNsrChunksProto | The NsrChunksProto corresponds to the NSRChunks class. The data saved by the proto and the class is the same. We provide utilities to go from one to the other. | list(String) |
| nsrChunks | QualityNsrNsrChunksWithSourceInfo | QualityNsrNsrChunksProto | ||
| siteChunkSource | Annotated in the SitechunksAnnotator and copied over in NsrAnnotator. | QualityNsrNsrChunksWithSourceInfo | String | |
| ugcScore | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number | |
| spambrainLavcScores | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | list(QualityNsrVersionedFloatSignal) | |
| titlematchScore | Titlematch score of the site, a signal that tells how well titles are matching user queries. | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number |
| site2vecEmbeddingEncoded | Encoded site2vec embedding (to be used in superroot) since the full embeddings take too much space. | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | list(QualityNsrNsrDataEncodedEmbedding) |
| smallPersonalSite | Score of small personal site promotion go/promoting-personal-blogs-v1 | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number |
| pnavClicks | denominator for the pnav computation | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number |
| siteChunkSource | These are only annotated in the Goldmine NSR annotator. | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | String |
| clusterUplift | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | QualityNsrNsrDataClusterUplift | |
| siteAutopilotScore | Aggregated value of url autopilot scores for this sitechunk. | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number |
| isVideoFocusedSite | Bit to determine whether the site has mostly video content, but is not hosted on any known video-hosting domains. Site is considered to be video-focused, if it has > 50% of the URLs with watch pages (with smoothing prior). ariane/4045246 | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | boolean |
| metadata | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | QualityNsrNsrDataMetadata | |
| chromeInTotal | Site-level Chrome views. | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number |
| chardVariance | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number | |
| chardScoreVariance | Site-level Chard Variance for all pages of a site. | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | list(QualityNsrVersionedFloatSignal) |
| chardScoreEncoded | Site-level Chard (encoded as an int). | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | list(QualityNsrVersionedIntSignal) |
| nsrdataFromFallbackPatternKey | If true indicates that we do not have NSR data computed for the chunk, and instead the data is coming from an average of other host chunks. | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | boolean |
| siteQualityStddevs | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | list(QualityNsrVersionedFloatSignal) | |
| clusterId | An id for defining clusters of sites. Used in ecosystem experiments (project Tundra). | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | integer |
| videoScore | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number | |
| shoppingScore | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number | |
| nsr | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number | |
| localityScore | Locality score of the site, i.e. the locality component of the LocalAuthority signal (see go/pq-localauthority). | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number |
| siteChunk | Primary NSR sitechunk. In most of the cases it’s same as HOST_LEVEL_V3 sitechunked canonical url of the document. In rare, but important cases it’s based on page markup (see quality/nsr/util/sitechunker.h for details). | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | String |
| i18nBucket | Currently corresponds to i18n_g42_bucket. | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | integer |
| chardEncoded | Site-level chard score: site quality predictor based on content. | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | integer |
| articleScoreV2 | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number | |
| nsrEpoch | The epoch from which this NSR value is coming from. | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | String |
| tofu | Site-level tofu score: site quality predictor based on content. | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number |
| siteLinkOut | Aggregated value of url link out scores for this sitechunk. | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number |
| nsrOverrideBid | This signal is used to unconditionally override NSR as a bid in Q*. Should only be used in case of emergency (see go/nsr-override-bid). To have any effect, the value should be present and greater than 0.001. | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number |
| language | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | integer | |
| clutterScores | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | list(QualityNsrVersionedFloatSignal) | |
| host | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | String | |
| isCovidLocalAuthority | Bit to determine whether the site has the local authority covid signal, as computed by go/covid-local-authority | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | boolean |
| pnav | Fractional signals. | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number |
| siteQualityStddev | Estimate of site’s PQ rating stddev–spread of the page-level PQ ratings of a site. Note this is different from nsr_variance which predicts error of NSR itself from the aggregated site-level rating. | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number |
| impressions | Site-level impressions. | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number |
| directFrac | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number | |
| vlq | Score of the Video LQ model. | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number |
| racterScores | Site-level AGC classification score (see also go/project-racter-overview). | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | list(QualityNsrVersionedFloatSignal) |
| spambrainLavcScore | The SpamBrain LAVC score, as of July 2022. See more information at go/cloverfield-lavc-deck. | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number |
| url | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | String | |
| secondarySiteChunk | Secondary NSR sitechunk. When present, it provides more granular chunking than primary sitechunks (see quality/nsr/util/sitechunker.h for details). | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | String |
| articleScore | Score from article classification of the site. | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number |
| site2vecEmbedding | Site2vec embeddings. | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | list(QualityNsrNsrDataEmbedding) |
| versionedData | Versioned map of NSR values for experimenting with the next release. | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | list(QualityNsrNSRVersionedData) |
| siteLinkIn | Average value of the site_link_in for pages in the sitechunk. | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number |
| ketoVersionedData | Keto data. | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | list(QualityNsrKetoKetoVersionedData) |
| ymylNewsV2Score | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number | |
| isElectionAuthority | Bit to determine whether the site has the election authority signal, as computed by go/election-authority | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | boolean |
| sitePr | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number | |
| priorAdjustedNsr | NSR – prior. Estimate of whether the site is above/below average NSR in its slice. | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | list(QualityNsrVersionedFloatSignal) |
| healthScore | Categorical signals. | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number |
| clutterScore | Delta site-level signal in Q* penalizing sites with a large number of distracting/annoying resources loaded by the site (see go/clutter-v0). | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number |
| vlqNsr | NSR from a headroom model targeting low-quality video sites. | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number |
| nsrVariance | QualityNsrNsrData | NOTE: When adding a new field to be propagated to Raffia check if NsrPatternSignalSpec needs to be updated. Next ID: 63 | number | |
| local | Score for the local sites arm. | QualityNsrNsrDataClusterUplift | The uplift-per-cluster values used in Tundra’s uplift arm. | number |
| small | Score for the small sites arm. | QualityNsrNsrDataClusterUplift | The uplift-per-cluster values used in Tundra’s uplift arm. | number |
| version | QualityNsrNsrDataEmbedding | integer | ||
| x | QualityNsrNsrDataEmbedding | list(number) | ||
| data | QualityNsrNsrDataEncodedEmbedding | String | ||
| version | QualityNsrNsrDataEncodedEmbedding | integer | ||
| encodedLookupInformation | Encoded lookup information. The fields set above are expensive to store. Storing them in docjoins is fine, but we cannot store them in MDU shards. In order for the MDU shards to display field provenance information, we store them as a bitfield. For details about the encoding and decoding scheme, see quality_nsr::util::EncodeMetadataLookupInformation. We expect this to occupy 8 bytes as long as there are less than 64 fields in NsrData proto, 12 bytes between 64 and 92 fields, etc. | QualityNsrNsrDataMetadata | Contains meta information about this data. This field is only available in docjoins (and potentially MDU shards), it is not populated offline. NOTE: This is a new field (Nov 2022) and we do not want clients to depend on this; please contact qscore-team@ if you want to use this information. | String |
| goldmineLookupKeyPerField | Same as raffia_lookup_key_per_field. Note that the goldmine_lookups have priority; if a field appears in both goldmine and raffia entries, it means it was taken from goldmine. If it’s missing here but present in raffia_lookup_key_per_field, it was taken from raffia. | QualityNsrNsrDataMetadata | Contains meta information about this data. This field is only available in docjoins (and potentially MDU shards), it is not populated offline. NOTE: This is a new field (Nov 2022) and we do not want clients to depend on this; please contact qscore-team@ if you want to use this information. | map |
| goldmineLookupKeys | The lookup keys attempted by goldmine. Note that goldmine only runs for urls which can be chunked differently than raffia; in those cases, goldmine related fields are empty. | QualityNsrNsrDataMetadata | Contains meta information about this data. This field is only available in docjoins (and potentially MDU shards), it is not populated offline. NOTE: This is a new field (Nov 2022) and we do not want clients to depend on this; please contact qscore-team@ if you want to use this information. | list(String) |
| lastTimeProcessedGoldmineInSeconds | QualityNsrNsrDataMetadata | Contains meta information about this data. This field is only available in docjoins (and potentially MDU shards), it is not populated offline. NOTE: This is a new field (Nov 2022) and we do not want clients to depend on this; please contact qscore-team@ if you want to use this information. | String | |
| lastTimeProcessedMduInSeconds | This field is populated only during MDU population, so it’s *not* present in docjoins, but it’s present in production so that it can be displayed. | QualityNsrNsrDataMetadata | Contains meta information about this data. This field is only available in docjoins (and potentially MDU shards), it is not populated offline. NOTE: This is a new field (Nov 2022) and we do not want clients to depend on this; please contact qscore-team@ if you want to use this information. | String |
| lastTimeProcessedRaffiaInSeconds | Records the last time each system has processed the proto. These are recorded as seconds from the unix epoch. Ideally these fields would be google.protobuf.Timestamp, but the scoring bundle (which depends on this proto) does not understand proto3 syntax. See cl/500942047 for details. | QualityNsrNsrDataMetadata | Contains meta information about this data. This field is only available in docjoins (and potentially MDU shards), it is not populated offline. NOTE: This is a new field (Nov 2022) and we do not want clients to depend on this; please contact qscore-team@ if you want to use this information. | String |
| nsrChunksWithSourceInfo | Stores the NSRChunks (computed by goldmine) which were used to populate the data. | QualityNsrNsrDataMetadata | Contains meta information about this data. This field is only available in docjoins (and potentially MDU shards), it is not populated offline. NOTE: This is a new field (Nov 2022) and we do not want clients to depend on this; please contact qscore-team@ if you want to use this information. | QualityNsrNsrChunksWithSourceInfo |
| raffiaLookupKey | QualityNsrNsrDataMetadata | Contains meta information about this data. This field is only available in docjoins (and potentially MDU shards), it is not populated offline. NOTE: This is a new field (Nov 2022) and we do not want clients to depend on this; please contact qscore-team@ if you want to use this information. | String | |
| raffiaLookupKeyPerField | Returns the raffia lookup key per each field in the NsrData proto (with exclusion of the Metadata sub-message (i.e. this)). It contains information like 3 : 1, meaning that the field inside NsrData with id ‘3’ (in this case ‘host’) has been taken by raffia from the raffia lookup key at index 1. | QualityNsrNsrDataMetadata | Contains meta information about this data. This field is only available in docjoins (and potentially MDU shards), it is not populated offline. NOTE: This is a new field (Nov 2022) and we do not want clients to depend on this; please contact qscore-team@ if you want to use this information. | map |
| raffiaLookupKeys | This is an internal field set by Raffia, to indicate which lookup keys have been attempted to populate the NsrData for this document. This will allow us to determine which key has been used to populate each field in the proto. The keys are ordered by lookup priority; raffia will give priority to earlier keys, and only take fields from later keys if they are missing. | QualityNsrNsrDataMetadata | Contains meta information about this data. This field is only available in docjoins (and potentially MDU shards), it is not populated offline. NOTE: This is a new field (Nov 2022) and we do not want clients to depend on this; please contact qscore-team@ if you want to use this information. | list(String) |
| raffiaSignalMergerUrl | The url used by NsrSignalMerger (http://google3/indexing/signals/signal-merger.h;l=1801;rcl=509297232) to select which NsrData value to keep. The SignalMerger merges all the NsrData coming from the dup url cluster, and select the NsrData value to return by choosing a single url in the cluster (see NsrSignalMerger class for details). NOTE: This field is populated only when there *is* a cluster. If there is no cluster, this is empty and the key used is the canonical (and only) url. | QualityNsrNsrDataMetadata | Contains meta information about this data. This field is only available in docjoins (and potentially MDU shards), it is not populated offline. NOTE: This is a new field (Nov 2022) and we do not want clients to depend on this; please contact qscore-team@ if you want to use this information. | String |
| value | The corresponding NSR value. | QualityNsrNSRVersionedData | Versioned NSR score data. | number |
| versionId | The unique id of the version, preferably just scaled: 19.1 x 10 = 191. | QualityNsrNSRVersionedData | Versioned NSR score data. | integer |
| chard | URL-level chard prediction (encoded as an int). | QualityNsrPQData | Next id: 22 | integer |
| chardScoreEncoded | URL-level Chard (encoded as an int). | QualityNsrPQData | Next id: 22 | list(QualityNsrVersionedIntSignal) |
| contentEffort | LLM-based effort estimation for article pages (see landspeeder/4311817). | QualityNsrPQData | Next id: 22 | list(QualityNsrVersionedFloatSignal) |
| deltaAutopilotScore | QualityNsrPQData | Next id: 22 | number | |
| deltaLinkIncoming | QualityNsrPQData | Next id: 22 | number | |
| deltaLinkOutgoing | QualityNsrPQData | Next id: 22 | number | |
| deltaSubchunkAdjustment | Total deltaNSR adjustment based on subchunks. This is a page-level adjustment (subchunks are retrieved based on the page classification). | QualityNsrPQData | Next id: 22 | number |
| keto | Keto score. | QualityNsrPQData | Next id: 22 | list(QualityNsrVersionedFloatSignal) |
| linkIncoming | QualityNsrPQData | Next id: 22 | number | |
| linkOutgoing | QualityNsrPQData | Next id: 22 | number | |
| numOffdomainAnchors | The total number of offdomain anchors seen by the NSR pipeline for this page. | QualityNsrPQData | Next id: 22 | number |
| page2vecLq | QualityNsrPQData | Next id: 22 | number | |
| predictedDefaultNsr | Predicted default NSR score computed in Goldmine via the NSR default predictor (go/default-nsr-predictor). | QualityNsrPQData | Next id: 22 | list(QualityNsrVersionedFloatSignal) |
| rhubarb | Site-URL delta signals based quality score computed in Goldmine via the Rhubarb model (go/rhubarb-dd). | QualityNsrPQData | Next id: 22 | list(QualityNsrVersionedFloatSignal) |
| subchunkData | QualityNsrPQData | Next id: 22 | list(QualityNsrPQDataSubchunkData) | |
| tofu | URL-level tofu prediction. | QualityNsrPQData | Next id: 22 | number |
| unversionedRhubarb | The delta score of the URL-level quality predictor. | QualityNsrPQData | Next id: 22 | number |
| urlAutopilotScore | QualityNsrPQData | Next id: 22 | number | |
| vlq | URL-level score of the VLQ model. | QualityNsrPQData | Next id: 22 | number |
| confidence | Confidence associated with the chunk. | QualityNsrPQDataSubchunkData | Data used to compute delta_subchunk_adjustment. (I.e, the subchunks looked up, with their confidences and weights). This data is not propagated to ascorer. | number |
| deltaNsr | Subchunk delta in nsr. | QualityNsrPQDataSubchunkData | Data used to compute delta_subchunk_adjustment. (I.e, the subchunks looked up, with their confidences and weights). This data is not propagated to ascorer. | number |
| pageWeight | Weight with which this document belong to this subchunk (greater than 0). | QualityNsrPQDataSubchunkData | Data used to compute delta_subchunk_adjustment. (I.e, the subchunks looked up, with their confidences and weights). This data is not propagated to ascorer. | number |
| type | Type of this chunk. Eg, ymyl_health, d2v, etc. | QualityNsrPQDataSubchunkData | Data used to compute delta_subchunk_adjustment. (I.e, the subchunks looked up, with their confidences and weights). This data is not propagated to ascorer. | String |
| value | The corresponding float value. | QualityNsrVersionedFloatSignal | A versioned float value. See VersionedFloatSignal functions in google3/quality/nsr/proto/proto_util.h | number |
| versionId | Unique version id. | QualityNsrVersionedFloatSignal | A versioned float value. See VersionedFloatSignal functions in google3/quality/nsr/proto/proto_util.h | String |
| value | The corresponding int value. | QualityNsrVersionedIntSignal | A versioned int value. See VersionedIntSignal functions in google3/quality/nsr/proto/proto_util.h | String |
| versionId | Unique version id. | QualityNsrVersionedIntSignal | A versioned int value. See VersionedIntSignal functions in google3/quality/nsr/proto/proto_util.h | String |
| belowThresholdIntents | Same as above, but for intents below triggering threshold. It can be assumed that any intent in this list has trigger=false. Most intents do not have below-threshold annotations. | QualityOrbitAsteroidBeltDocumentIntentScores | Next ID: 7 | list(String) |
| belowThresholdScores | QualityOrbitAsteroidBeltDocumentIntentScores | Next ID: 7 | list(integer) | |
| intents | The ‘intents’ and ‘scores’ fields are stored as parallel lists for compactness. The ‘scores’ field should not be accessed directly, but instead through the functions in document_intent_scores_utils. | QualityOrbitAsteroidBeltDocumentIntentScores | Next ID: 7 | list(String) |
| scores | The intent scores, scaled to integers between 0 and 100 for compactness. | QualityOrbitAsteroidBeltDocumentIntentScores | Next ID: 7 | list(integer) |
| version | DEPRECATED. DO NOT USE IT FOR ANY REASON! contact orbit@ if necessary. | QualityOrbitAsteroidBeltDocumentIntentScores | Next ID: 7 | integer |
| intents | The unique identifier for an Asteroid Belt document intent is being reused here | QualityOrbitAsteroidBeltImageIntentScores | These scores are for image scores *in the context of a landing page*, which is now a discouraged path of building image classifications. See go/orbit-for-images-v2 for an alternative. | list(String) |
| scores | The intent scores, scaled to integers between 0 and 100 for compactness. | QualityOrbitAsteroidBeltImageIntentScores | These scores are for image scores *in the context of a landing page*, which is now a discouraged path of building image classifications. See go/orbit-for-images-v2 for an alternative. | list(integer) |
| imageIntent | Intent of this proto instance. | QualityOrbitOrbitImageIntent | Stores information for a single image-only orbit intent. See go/orbit-for-images-v2 for more details. | String |
| missingInputs | QualityOrbitOrbitImageIntent | Stores information for a single image-only orbit intent. See go/orbit-for-images-v2 for more details. | list(String) | |
| reach | QualityOrbitOrbitImageIntent | Stores information for a single image-only orbit intent. See go/orbit-for-images-v2 for more details. | String | |
| remove | Whether this intent should be removed when backfilling new classifications to the index. When backfilling a new version of a classifier to production we have cases where we actually want to *remove* an intent that was present in production because the new version might have moved the intent to below logging threshold. This bit should be used to signal this case so that merging logic can remove the intent for the image. This should *never* be set in a production callsite, it is only intended for backfilling operations. | QualityOrbitOrbitImageIntent | Stores information for a single image-only orbit intent. See go/orbit-for-images-v2 for more details. | boolean |
| score | Score of the intent. | QualityOrbitOrbitImageIntent | Stores information for a single image-only orbit intent. See go/orbit-for-images-v2 for more details. | number |
| trigger | Whether the intent triggered with the default threshold or not. | QualityOrbitOrbitImageIntent | Stores information for a single image-only orbit intent. See go/orbit-for-images-v2 for more details. | boolean |
| intents | Intents with non-trivial scores. | QualityOrbitOrbitImageIntents | Image-only orbit intents (See: go/orbit-for-images-v2) | list(QualityOrbitOrbitImageIntent) |
| version | Represents the version. Filled in Amarna (main version controller). | QualityOrbitOrbitImageIntents | Image-only orbit intents (See: go/orbit-for-images-v2) | String |
| isVulgar | Whether this snippet is a vulgar candidate. | QualityPreviewChosenSnippetInfo | Information for chosen snippet. Next ID: 8 | boolean |
| leadingTextType | QualityPreviewChosenSnippetInfo | Information for chosen snippet. Next ID: 8 | String | |
| snippetHtml | The rendered snippet html. | QualityPreviewChosenSnippetInfo | Information for chosen snippet. Next ID: 8 | String |
| snippetType | QualityPreviewChosenSnippetInfo | Information for chosen snippet. Next ID: 8 | String | |
| source | Source of the chosen snippet, decided in PORC. String value of quality.porc.TextSnippetCandidate.TextSnippetSource defined at google3/quality/porc/proto/text_snippet.proto | QualityPreviewChosenSnippetInfo | Information for chosen snippet. Next ID: 8 | String |
| tidbits | QualityPreviewChosenSnippetInfo | Information for chosen snippet. Next ID: 8 | list(QualityPreviewChosenSnippetInfoTidbitInfo) | |
| trailingEllipsis | Whether this snippet has trailing ellipsis. | QualityPreviewChosenSnippetInfo | Information for chosen snippet. Next ID: 8 | boolean |
| sectionName | Section name of current snippet. | QualityPreviewChosenSnippetInfoTidbitInfo | Information to identify tidbits. | String |
| separator | Separator to put before this tidbit. | QualityPreviewChosenSnippetInfoTidbitInfo | Information to identify tidbits. | String |
| tidbitText | Tidbit text for validation. | QualityPreviewChosenSnippetInfoTidbitInfo | Information to identify tidbits. | String |
| tokenBegin | Tidbit token range in the section. | QualityPreviewChosenSnippetInfoTidbitInfo | Information to identify tidbits. | String |
| tokenEnd | QualityPreviewChosenSnippetInfoTidbitInfo | Information to identify tidbits. | String | |
| brainFeatures | Features from SnippetFlow in Superroot. | QualityPreviewRanklabSnippet | Snippet candidate related information and signal scores. This message is used for both snippet scoring and ranklab features recording. Next ID: 12 ================== Features populated in production ======================= | QualityPreviewSnippetBrainFeatures |
| documentFeatures | QualityPreviewRanklabSnippet | Snippet candidate related information and signal scores. This message is used for both snippet scoring and ranklab features recording. Next ID: 12 ================== Features populated in production ======================= | QualityPreviewSnippetDocumentFeatures | |
| experimentalFeatures | For experimental usage, not populated yet. | QualityPreviewRanklabSnippet | Snippet candidate related information and signal scores. This message is used for both snippet scoring and ranklab features recording. Next ID: 12 ================== Features populated in production ======================= | QualityPreviewSnippetExperimentalFeatures |
| finalScore | The final score of this candidate. | QualityPreviewRanklabSnippet | Snippet candidate related information and signal scores. This message is used for both snippet scoring and ranklab features recording. Next ID: 12 ================== Features populated in production ======================= | number |
| isMuppetSelectedSnippet | Is this the candidate chosen by Muppet scorer. | QualityPreviewRanklabSnippet | Snippet candidate related information and signal scores. This message is used for both snippet scoring and ranklab features recording. Next ID: 12 ================== Features populated in production ======================= | boolean |
| originalQueryTermCoverageFeatures | Query term (original terms only) coverage features. | QualityPreviewRanklabSnippet | Snippet candidate related information and signal scores. This message is used for both snippet scoring and ranklab features recording. Next ID: 12 ================== Features populated in production ======================= | QualityPreviewSnippetQueryTermCoverageFeatures |
| qualityFeatures | QualityPreviewRanklabSnippet | Snippet candidate related information and signal scores. This message is used for both snippet scoring and ranklab features recording. Next ID: 12 ================== Features populated in production ======================= | QualityPreviewSnippetQualityFeatures | |
| queryFeatures | Core set of snippet features. | QualityPreviewRanklabSnippet | Snippet candidate related information and signal scores. This message is used for both snippet scoring and ranklab features recording. Next ID: 12 ================== Features populated in production ======================= | QualityPreviewSnippetQueryFeatures |
| queryTermCoverageFeatures | Query term (including synonyms) coverage features. | QualityPreviewRanklabSnippet | Snippet candidate related information and signal scores. This message is used for both snippet scoring and ranklab features recording. Next ID: 12 ================== Features populated in production ======================= | QualityPreviewSnippetQueryTermCoverageFeatures |
| radishFeatures | Radish related information. | QualityPreviewRanklabSnippet | Snippet candidate related information and signal scores. This message is used for both snippet scoring and ranklab features recording. Next ID: 12 ================== Features populated in production ======================= | QualityPreviewSnippetRadishFeatures |
| snippetInfo | Information to identify current chosen snippet. | QualityPreviewRanklabSnippet | Snippet candidate related information and signal scores. This message is used for both snippet scoring and ranklab features recording. Next ID: 12 ================== Features populated in production ======================= | QualityPreviewChosenSnippetInfo |
| perTypeRank | Rank of this title among titles of the same `data_source_type`. | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | integer |
| goldmineLocationFactor | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| sourceGeneratedTitle | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | boolean | |
| sourceOffdomainAnchor | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | boolean | |
| goldmineReadabilityScore | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| queryMatch | The number of (different) terms with a query match. It may include the match with any SQuery node (e.g., synonyms). | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | integer |
| goldmineUrlMatchFactor | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| percentBodyTitleTokensCovered | Numbers of body title tokens covered by this title, in range of [0, 1]. Not set if body title is considered “bad”. | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number |
| goldmineGeometryFactor | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| goldmineOnPageDemotionFactor | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| goldmineOtherBoostFeatureCount | The number of BoostFeatures present in AlternativeTitlesGeneator but not populated above. | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | integer |
| percentTokensCoveredByBodyTitle | Numbers of tokens covered by body title, in range of [0, 1]. Not set if body title is considered “bad”. | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number |
| hasSiteInfo | Whether a title contains site information. | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | boolean |
| goldmineHeadingFactor | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| goldmineSiteNameMarkupFactor | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| goldmineSubHeading | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| goldmineFinalScore | Deprecated: use `goldmine_page_score` instead. | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number |
| testRank | The ranking index of this candidate (starting from 0) in test. | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | integer |
| goldmineHeaderIsH1 | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| goldmineSitenameFactor | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| goldmineHasBoilerplateInTitle | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| isValid | Whether a title is valid (i.e., not empty). | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | boolean |
| goldmineTitleTagFactor | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| goldmineTrustFactor | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| sourceHeadingTag | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | boolean | |
| sourceTransliteratedTitle | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | boolean | |
| dupTokens | Numbers of duplicated tokens. For example, duplicated tokens for a title “dog cat cat cat” is 2 (for 2 extra “cat”). | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | integer |
| text | Title text to display. Populated for debugging purpose only, and won’t be used for model inferences. This represetns the exact display text in SERP, with modifications like truncations or site-title appending involved. | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | String |
| goldmineSiteQueryFactor | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| goldmineSalientTermFactor | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| goldmineAnchorSupportOnly | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| sourceGeometry | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | boolean | |
| forcedExperimentScore | A score assigned for candidates forced by experiments. | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | integer |
| baseRank | The ranking index of this candidate (starting from 0) in base. | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | integer |
| baseGoldmineFinalScore | `goldmine_final_score` value in base. | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number |
| goldmineIsBadTitle | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| goldmineIsTruncated | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| sourceLocalTitle | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | boolean | |
| goldmineHasTitleNgram | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| isTruncated | Whether this title candidate is truncated or not. | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | boolean |
| docLang | Document language for this title. It is used for model inference and hence flattened into RanklabTitle instead of RanklabDoc. | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | String |
| testGoldmineFinalScore | `goldmine_final_score` value in test. | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number |
| queryRelevance | Deprecated experimental features. | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number |
| goldmineOgTitleFactor | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| sourceTitleTag | !ERROR! B10036 -> Formula Error: An unexpected error occurred | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | boolean |
| sourceOndomainAnchor | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | boolean | |
| goldmineIsHeadingTag | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| queryMatchFraction | A number of matched query terms divided by the number of all terms in query. Synonyms or other terms that appear in squery but not in the raw query are excluded. Takes values in [0, 1]. | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number |
| perTypeQuality | How good or bad this title is as a `data_source_type` title type. | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | String |
| goldmineAnchorFactor | !ERROR! B10041 -> Formula Error: An unexpected error occurred | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number |
| goldmineNavboostFactor | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| sourceOnsiteAnchor | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | boolean | |
| goldmineBodyFactor | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| goldmineIsTitleTag | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| widthFraction | A rendered width of this title divided by the max allowed width for title. Takes values in [0, 1]. | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number |
| dataSourceType | Title source type. | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | String |
| goldmineLocalTitleFactor | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| docRelevance | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| goldmineForeign | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| goldminePageScore | The score for the `text` computed in Goldmine (AlternativeTitlesAnnotator). | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number |
| goldmineAdjustedScore | The score for `text` computed in Goldmine (AlternativeTitlesAnnotator) with additional scoring adjustments applied. Currently includes Blockbert scoring. | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number |
| goldmineBlockbertFactor | QualityPreviewRanklabTitle | A collection of data corresponding to a single title candidate. This will be used as: – a collection of signals to score and select titles in production – an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 70 | number | |
| isSnippetBrainBoldingTriggered | Is the bolding triggered. | QualityPreviewSnippetBrainFeatures | Snippet brain scores. | boolean |
| modelScore | The score by SnippetBrain model. | QualityPreviewSnippetBrainFeatures | Snippet brain scores. | number |
| experimentalTitleSalientTermsScore | QualityPreviewSnippetDocumentFeatures | Document related features used in snippets scoring. Next ID: 10 | number | |
| leadingtextDistanceScore | QualityPreviewSnippetDocumentFeatures | Document related features used in snippets scoring. Next ID: 10 | number | |
| metaBoostScore | QualityPreviewSnippetDocumentFeatures | Document related features used in snippets scoring. Next ID: 10 | number | |
| salientPositionBoostScore | QualityPreviewSnippetDocumentFeatures | Document related features used in snippets scoring. Next ID: 10 | number | |
| salientTermsScore | QualityPreviewSnippetDocumentFeatures | Document related features used in snippets scoring. Next ID: 10 | number | |
| schemaOrgDescriptionBoostScore | QualityPreviewSnippetDocumentFeatures | Document related features used in snippets scoring. Next ID: 10 | number | |
| unstableTokensScore | QualityPreviewSnippetDocumentFeatures | Document related features used in snippets scoring. Next ID: 10 | number | |
| isLikelyHomepage | QualityPreviewSnippetExperimentalFeatures | boolean | ||
| numQueryItems | QualityPreviewSnippetExperimentalFeatures | integer | ||
| numTidbits | QualityPreviewSnippetExperimentalFeatures | integer | ||
| numVisibleTokens | QualityPreviewSnippetExperimentalFeatures | integer | ||
| radish | QualityPreviewSnippetExperimentalFeatures | QualityPreviewSnippetRadishFeatures | ||
| foreignMetaScore | QualityPreviewSnippetQualityFeatures | Quality related features used in snippets scoring. Next ID: 10 | number | |
| hiddenRatioScore | QualityPreviewSnippetQualityFeatures | Quality related features used in snippets scoring. Next ID: 10 | number | |
| numTidbitsScore | QualityPreviewSnippetQualityFeatures | Quality related features used in snippets scoring. Next ID: 10 | number | |
| numVisibleTokensScore | QualityPreviewSnippetQualityFeatures | Quality related features used in snippets scoring. Next ID: 10 | number | |
| outlinkScore | QualityPreviewSnippetQualityFeatures | Quality related features used in snippets scoring. Next ID: 10 | number | |
| redundancyScore | QualityPreviewSnippetQualityFeatures | Quality related features used in snippets scoring. Next ID: 10 | number | |
| sentenceStartScore | QualityPreviewSnippetQualityFeatures | Quality related features used in snippets scoring. Next ID: 10 | number | |
| experimentalQueryTitleScore | QualityPreviewSnippetQueryFeatures | Query related features used in snippets scoring. Next ID: 7 | number | |
| passageembedScore | QualityPreviewSnippetQueryFeatures | Query related features used in snippets scoring. Next ID: 7 | number | |
| queryHasPassageembedEmbeddings | QualityPreviewSnippetQueryFeatures | Query related features used in snippets scoring. Next ID: 7 | boolean | |
| queryScore | QualityPreviewSnippetQueryFeatures | Query related features used in snippets scoring. Next ID: 7 | number | |
| radishScore | QualityPreviewSnippetQueryFeatures | Query related features used in snippets scoring. Next ID: 7 | number | |
| snippetQueryTermCoverage | QualityPreviewSnippetQueryTermCoverageFeatures | Snippet query term coverage features. | number | |
| titleQueryTermCoverage | QualityPreviewSnippetQueryTermCoverageFeatures | Snippet query term coverage features. | number | |
| titleSnippetQueryTermCoverage | QualityPreviewSnippetQueryTermCoverageFeatures | Snippet query term coverage features. | number | |
| answerScore | Answer score of the passage for this `navboost_query`. | QualityPreviewSnippetRadishFeatures | number | |
| navboostQuery | Navboost query for this radish signal. | QualityPreviewSnippetRadishFeatures | String | |
| passageCoverage | The ratio of overlapping tokens between the radish passage and snippet candidate. | QualityPreviewSnippetRadishFeatures | number | |
| passageType | Integer value of indexing::annotations::wa_passages::Passage::Type. | QualityPreviewSnippetRadishFeatures | integer | |
| queryPassageIdx | The index of this passage under `navboost_query`. | QualityPreviewSnippetRadishFeatures | integer | |
| similarityMethod | How the similarity score is computed. Integer value of mustang_repos_www_snippets::RadishSignalScoringInfo::SimilarityMethod. | QualityPreviewSnippetRadishFeatures | integer | |
| similarityScore | Similarity score between this `navboost_query` and the incoming query. | QualityPreviewSnippetRadishFeatures | number | |
| snippetCoverage | QualityPreviewSnippetRadishFeatures | number | ||
| locale | Data for each locale. | QualityProductProductSiteData | Protocol message for data related to product sites. This data is stored as signals data in docjoins. | list(QualityProductProductSiteDataLocaleData) |
| boostFactor | Site boosting multiplier. | QualityProductProductSiteDataLocaleData | Data for one locale. | number |
| gobiSite | Whether this is a gobi site, ie, a site from a gobi domain that should be boosted for a category query with this gobi domain. For example, amazon.com is a gobi store domain for category query [hdtv] but some sites (like askville.amazon.com) from amazon.com should not be boosted. | QualityProductProductSiteDataLocaleData | Data for one locale. | boolean |
| locale | Locale for this data. | QualityProductProductSiteDataLocaleData | Data for one locale. | String |
| cseId | There were defined back in 2007, but were never used. optional string label = 2; optional uint64 user = 3; optional float score = 4; | QualityProseCSEUrlInfo | String | |
| dataSources | QualityQrewriteAccountProvenance | Used to annotate the source of cross-account personal data. See go/cross-account-understanding. | list(String) | |
| googleAccount | QualityQrewriteAccountProvenance | Used to annotate the source of cross-account personal data. See go/cross-account-understanding. | QualityQrewriteAccountProvenanceGoogleAccount | |
| thirdPartyAccount | Note google_account and third_party_account could both exist. For example, a user could share her Spotify account with other users registered on the same device. | QualityQrewriteAccountProvenance | Used to annotate the source of cross-account personal data. See go/cross-account-understanding. | QualityQrewriteAccountProvenanceThirdPartyAccount |
| QualityQrewriteAccountProvenanceGoogleAccount | The Google account the annotated personal data belongs to. | String | ||
| gaiaId | QualityQrewriteAccountProvenanceGoogleAccount | The Google account the annotated personal data belongs to. | String | |
| isDasherAccount | QualityQrewriteAccountProvenanceGoogleAccount | The Google account the annotated personal data belongs to. | boolean | |
| isSecondaryAccount | QualityQrewriteAccountProvenanceGoogleAccount | The Google account the annotated personal data belongs to. | boolean | |
| Email address of the linked account (eg [email protected]). | QualityQrewriteAccountProvenanceThirdPartyAccount | The 3P account the annotated personal data belongs to. | String | |
| thirdPartyProviderId | Unique identifier for the third party provider. Defined by Google via AoG. | QualityQrewriteAccountProvenanceThirdPartyAccount | The 3P account the annotated personal data belongs to. | String |
| matchSignal | QualityQrewriteAlternativeNameInfo | Alternative names with info like RecognitionAlternateSource indicating where is it from. | AssistantVerticalsCommonContactMatchSignal | |
| name | QualityQrewriteAlternativeNameInfo | Alternative names with info like RecognitionAlternateSource indicating where is it from. | String | |
| source | QualityQrewriteAlternativeNameInfo | Alternative names with info like RecognitionAlternateSource indicating where is it from. | String | |
| calendarAlias | QualityQrewriteCalendarReference | QualityQrewriteQRewriteAccountAwareCalendarAliasWrapper | ||
| contactCalendarName | QualityQrewriteCalendarReference | QualityQrewriteContactCalendarName | ||
| familyCalendarAlias | QualityQrewriteCalendarReference | QualityQrewriteFamilyCalendarAlias | ||
| primaryCalendarAlias | QualityQrewriteCalendarReference | QualityQrewritePrimaryCalendarAlias | ||
| contact | QualityQrewriteContactCalendarName | NlpSemanticParsingModelsPersonPerson | ||
| familyCalendarId | QualityQrewriteFamilyCalendarAlias | String | ||
| accountProvenance | Tracks the account owner of this contact. See go/cross-account-understanding. | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | QualityQrewriteAccountProvenance |
| additionalContactMetadata | 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. | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | list(map) |
| commonNameAliasConfidence | Populated only if matched_name_type is GIVEN_NAME_ALIAS or FULL_NAME_ALIAS. | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | number |
| conceptId | Concept id for relationships in query language, e.g. “Mother” in English, “Mère” in French. It’s only populated for source = RELATIONSHIP. | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | String |
| conceptIdEn | 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. | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | String |
| displayName | 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. | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | String |
| familyName | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | String | |
| ffracScore | The ffrac score of the suggested contact from Starlight. | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | float |
| gaiaId | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | String | |
| givenName | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | String | |
| hasAddressForDeviceContacts | 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 | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | boolean |
| hasGplusProfile | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | boolean | |
| isFromOnDeviceLookup | If the contact data is from on device lookup. | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | boolean |
| isTransliteratedMatch | Indicate the contact matches the transliterated query. | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | boolean |
| isVisibleToGuestsRelationship | 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. | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | boolean |
| lookupNameSource | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | String | |
| matchSignal | Populate only if AlternateSource is not NONE. | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | AssistantVerticalsCommonContactMatchSignal |
| matchedNameType | 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) | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | String |
| matchedRecognitionAlternateName | Alternate name from recognition that has contact matched. Need this to make name correction history log consistent. | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | String |
| personData | Metadata such as name, email, phone, etc. | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | AppsPeopleOzExternalMergedpeopleapiPerson |
| personalContactDataLog | 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. | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | AssistantLogsCommunicationPersonalContactDataLog |
| pkgPerson | 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. | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | NlpSemanticParsingQRefAnnotation |
| pkgReferenceType | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | String | |
| recognitionAlternateScore | Populate only if AlternateSource is not NONE. | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | number |
| recognitionAlternateSource | If not none, then it indicates the personal contact data is alternate and how the alternate is fulfilled. | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | String |
| relationshipLexicalInfo | Lexical information for relationships in query language, e.g. “Mother” in English, “Mère” in French. It’s only populated for source = RELATIONSHIP. | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | CopleyLexicalMetadata |
| relationshipMemory | 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. | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | list(QualityQrewriteRelationshipMemoryData) |
| sharedContactOwnerGaiaId | 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. | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | String |
| source | 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. | QualityQrewritePersonalContactData | Contact metadata Next Id: 36 | String |
| contactPointer | The contact pointer. See http://go/assistant-contact-id. | QualityQrewriteRelationshipMemoryData | Relationship->contact data provided by Assistant Memory. | FocusBackendContactPointer |
| value | The contact name copied from UserAttribute.value. | QualityQrewriteRelationshipMemoryData | Relationship->contact data provided by Assistant Memory. | String |
| additionalFixedPointEncodings | Each of the repeated elements in this field has the same scheme as ‘fixed_point_encoding’; See go/rankembed-astro-rule-set-dd | QualityRankembedMustangMustangRankEmbedInfo | Used as Mustang attachment DO NOT: – ACCESS THE PROTO FIELDS DIRECTLY – USE THE DECODING LIBRARY IN quality/rankembed/mustang/fixed_point_decoding_helpers.h INSTEAD. – USE HARDCODED MustangRankEmbedInfo TEXT PROTOS IN TESTS! USE quality/rankembed/test_utils/mustang_rankembed_info_utils.h INSTEAD. | list(String) |
| compressedDocumentEmbedding | Each uint64 encodes 8 8-bit values for the quantized document embedding | QualityRankembedMustangMustangRankEmbedInfo | Used as Mustang attachment DO NOT: – ACCESS THE PROTO FIELDS DIRECTLY – USE THE DECODING LIBRARY IN quality/rankembed/mustang/fixed_point_decoding_helpers.h INSTEAD. – USE HARDCODED MustangRankEmbedInfo TEXT PROTOS IN TESTS! USE quality/rankembed/test_utils/mustang_rankembed_info_utils.h INSTEAD. | QualityRankembedMustangMustangRankEmbedInfoCompressedEmbedding |
| fixedPointEncoding | This field replaces the above 3 “per-encoding-type-fields”, where the encoding type (and the embedding type) are part of the encoding, and is stored in the first byte. The remaining bytes are the same as the previous 3 fields, but shifted by 1 byte. – byte[0]: encoding type & embedding type – byte[1….]: similar to the above depending on the encoding type. | QualityRankembedMustangMustangRankEmbedInfo | Used as Mustang attachment DO NOT: – ACCESS THE PROTO FIELDS DIRECTLY – USE THE DECODING LIBRARY IN quality/rankembed/mustang/fixed_point_decoding_helpers.h INSTEAD. – USE HARDCODED MustangRankEmbedInfo TEXT PROTOS IN TESTS! USE quality/rankembed/test_utils/mustang_rankembed_info_utils.h INSTEAD. | String |
| scaledFixedPoint4Encoding | – byte[0]: version – bytes[1…4]: scalar – bytes[5,…]: the values, one byte per 2 values | QualityRankembedMustangMustangRankEmbedInfo | Used as Mustang attachment DO NOT: – ACCESS THE PROTO FIELDS DIRECTLY – USE THE DECODING LIBRARY IN quality/rankembed/mustang/fixed_point_decoding_helpers.h INSTEAD. – USE HARDCODED MustangRankEmbedInfo TEXT PROTOS IN TESTS! USE quality/rankembed/test_utils/mustang_rankembed_info_utils.h INSTEAD. | String |
| scaledFixedPoint8Encoding | – byte[0]: version – bytes[1…4]: scalar – bytes[5,…]: the values, one byte per value | QualityRankembedMustangMustangRankEmbedInfo | Used as Mustang attachment DO NOT: – ACCESS THE PROTO FIELDS DIRECTLY – USE THE DECODING LIBRARY IN quality/rankembed/mustang/fixed_point_decoding_helpers.h INSTEAD. – USE HARDCODED MustangRankEmbedInfo TEXT PROTOS IN TESTS! USE quality/rankembed/test_utils/mustang_rankembed_info_utils.h INSTEAD. | String |
| scaledShiftedFixedPoint4Encoding | – byte[0]: version – bytes[1…4]: scalar – bytes[5…8]: shift – bytes[9,…]: the values, one byte per 2 values | QualityRankembedMustangMustangRankEmbedInfo | Used as Mustang attachment DO NOT: – ACCESS THE PROTO FIELDS DIRECTLY – USE THE DECODING LIBRARY IN quality/rankembed/mustang/fixed_point_decoding_helpers.h INSTEAD. – USE HARDCODED MustangRankEmbedInfo TEXT PROTOS IN TESTS! USE quality/rankembed/test_utils/mustang_rankembed_info_utils.h INSTEAD. | String |
| versionAndImprovInfo | First 7 bits encode the version, then each chunk of 5 bits encode the index of a potential improv query (lsb to msb) ——-|—–|—–|—–|—–|—– version| id1 | id2 | id3 | id4 | id5 where id1 is the index of the first improv query in the improv debug table. As of cl/270008220, this field only contains the version info. For backward compatibility, version still only uses the first 7 bits, and is still prepended by 5 1 bits. | QualityRankembedMustangMustangRankEmbedInfo | Used as Mustang attachment DO NOT: – ACCESS THE PROTO FIELDS DIRECTLY – USE THE DECODING LIBRARY IN quality/rankembed/mustang/fixed_point_decoding_helpers.h INSTEAD. – USE HARDCODED MustangRankEmbedInfo TEXT PROTOS IN TESTS! USE quality/rankembed/test_utils/mustang_rankembed_info_utils.h INSTEAD. | integer |
| packedValue | using fixed64 instead of uint64 saves ~14% is storage | QualityRankembedMustangMustangRankEmbedInfoCompressedEmbedding | list(String) | |
| value | QualityRankembedMustangMustangRankEmbedInfoCompressedEmbedding | list(String) | ||
| indexStatus | QualityRichsnippetsAppsProtosLaunchableAppPerDocData | A subset of LaunchableApplication, which is stored in the PerDocData proto (indexer/perdocdata/perdocdata.proto) and thus stored in the Search Mustang index. It is used to identify documents containing app links at serving time by SuperRoot. A subset of LaunchableApplication is used to save on storage requirements. | String | |
| packageIdFingerprint | Android package id of the application associated with this document (example: ‘com.imdb.mobile’), encoded with the Fingerprint2011() function. | QualityRichsnippetsAppsProtosLaunchableAppPerDocData | A subset of LaunchableApplication, which is stored in the PerDocData proto (indexer/perdocdata/perdocdata.proto) and thus stored in the Search Mustang index. It is used to identify documents containing app links at serving time by SuperRoot. A subset of LaunchableApplication is used to save on storage requirements. | String |
| perAppInfoEncoded | A subset of the data in the PerAppInfo message, encoded to save on space. See quality/calypso/utils/app_info_utils.h for encoding/decoding. | QualityRichsnippetsAppsProtosLaunchableAppPerDocData | A subset of LaunchableApplication, which is stored in the PerDocData proto (indexer/perdocdata/perdocdata.proto) and thus stored in the Search Mustang index. It is used to identify documents containing app links at serving time by SuperRoot. A subset of LaunchableApplication is used to save on storage requirements. | String |
| app | QualityRichsnippetsAppsProtosLaunchAppInfoPerDocData | list(QualityRichsnippetsAppsProtosLaunchableAppPerDocData) | ||
| country | 2-letter country format. | QualitySalientCountriesSalientCountry | This is a measure of how salient this country is for the document. | String |
| salience | How salient this country is for the document. [0,1] range. | QualitySalientCountriesSalientCountry | This is a measure of how salient this country is for the document. | number |
| packedCountry | Packed Country and salience optimized for index storage | QualitySalientCountriesSalientCountrySet | Set of SalientCountry for a document. | list(integer) |
| packedSalience | QualitySalientCountriesSalientCountrySet | Set of SalientCountry for a document. | list(integer) | |
| salientCountry | QualitySalientCountriesSalientCountrySet | Set of SalientCountry for a document. | list(QualitySalientCountriesSalientCountry) | |
| confidence | confidence is a measurement of how much data we had to compute the SalientTermSet. Range: [0.0, 1.0] | QualitySalientTermsDocData | DocData contains additional salient-term-set-level information that complements a SalientTermSet. | number |
| headVolumeRatio | head_volume_ratio is the ratio of the sum of term frequency of the top K terms over the volume of all terms. Range: [0.0, 1.0]. K is defined by Accumulator2Params::head_size. | QualitySalientTermsDocData | DocData contains additional salient-term-set-level information that complements a SalientTermSet. | number |
| language | language is the main language of this SalientTermSet. | QualitySalientTermsDocData | DocData contains additional salient-term-set-level information that complements a SalientTermSet. | String |
| signalData | signal_data contains signal-specific (e.g., body, anchors, clicks) data for this SalientTermSet. | QualitySalientTermsDocData | DocData contains additional salient-term-set-level information that complements a SalientTermSet. | list(QualitySalientTermsSignalData) |
| virtualVolume | virtual_volume is a measurement of how much data we had to compute the SalientTermSet. Range: [0.0, +infinity)]. | QualitySalientTermsDocData | DocData contains additional salient-term-set-level information that complements a SalientTermSet. | number |
| idf | idf of the original_term. Used by Accumulator2. This field is only available in debug mode. | QualitySalientTermsSalientTerm | 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). | number |
| label | 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). | QualitySalientTermsSalientTerm | 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). | String |
| originalTerm | 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. | QualitySalientTermsSalientTerm | 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). | list(QualitySalientTermsSalientTerm) |
| salience | 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. | QualitySalientTermsSalientTerm | 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). | number |
| signalTerm | signal_term contains extra signal-specific (e.g., body, anchors, clicks) data for this term. | QualitySalientTermsSalientTerm | 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). | list(QualitySalientTermsSignalTermData) |
| virtualTf | virtual_tf is the accumulated corrected term frequency from all the signals. This field is only available in debug mode. | QualitySalientTermsSalientTerm | 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). | number |
| weight | 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. | QualitySalientTermsSalientTerm | 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). | integer |
| docData | doc_data contain additional salient-term-set-level data. | QualitySalientTermsSalientTermSet | SalientTermSet is a collection of terms (unigrams and bigrams) with associated weights that can describe something. The “salient terms”. | QualitySalientTermsDocData |
| salientTerm | salient_term is the list of terms that are good descriptors, sorted in decreasing order of weight. | QualitySalientTermsSalientTermSet | SalientTermSet is a collection of terms (unigrams and bigrams) with associated weights that can describe something. The “salient terms”. | list(QualitySalientTermsSalientTerm) |
| version | version is the Salient Terms version used to create the SalientTermSet. This is specific to web documents salient terms. | QualitySalientTermsSalientTermSet | SalientTermSet is a collection of terms (unigrams and bigrams) with associated weights that can describe something. The “salient terms”. | String |
| bias | A fixed bias for this signal, the higher the stronger. This can be used to balance the weight of signals independently of the confidence we give it. This field is only available in debug mode. | QualitySalientTermsSignalData | SignalData stores signal-specific salient-term-set-level information. Stores mostly internal data as it is one of the primary data structures used in the populators. | number |
| confidence | The measurement of how much we trust this signal. Range: [0.0, 1.0] This field is available is both debug and non-debug mode. | QualitySalientTermsSignalData | SignalData stores signal-specific salient-term-set-level information. Stores mostly internal data as it is one of the primary data structures used in the populators. | number |
| halfSalience | Raw saliences equal to half_salience will be equal to 0.5 normalized. Range: [0, volume]. This field is only available in debug mode. | QualitySalientTermsSignalData | SignalData stores signal-specific salient-term-set-level information. Stores mostly internal data as it is one of the primary data structures used in the populators. | number |
| noiseCorrection | The minimum TF for a term not to be considered noise. While the possible range of values for this field is [0, observed_volume], it is expected to be a somewhat small percentage of observed_volume (e.g. 5%). This field is only available in debug mode. | QualitySalientTermsSignalData | SignalData stores signal-specific salient-term-set-level information. Stores mostly internal data as it is one of the primary data structures used in the populators. | number |
| observedConfidence | The measurement of how much we trust this signal, calculated using the observed volume. Range: [0.0, 1.0] This field is only available in debug mode. | QualitySalientTermsSignalData | SignalData stores signal-specific salient-term-set-level information. Stores mostly internal data as it is one of the primary data structures used in the populators. | number |
| observedVolume | The amount of signal we observed for a document. Range: [0.0, +infinity) This field is only available in debug mode. | QualitySalientTermsSignalData | SignalData stores signal-specific salient-term-set-level information. Stores mostly internal data as it is one of the primary data structures used in the populators. | number |
| rawVolume | The amount of raw signal we observed for a document. Range: [0.0, +infinity) This field is only available in debug mode. | QualitySalientTermsSignalData | SignalData stores signal-specific salient-term-set-level information. Stores mostly internal data as it is one of the primary data structures used in the populators. | number |
| source | source is the type of the signal of this SignalData. | QualitySalientTermsSignalData | SignalData stores signal-specific salient-term-set-level information. Stores mostly internal data as it is one of the primary data structures used in the populators. | String |
| volume | The amount of signal left after applying all corrections. Range: [0.0, +infinity) This field is only available in debug mode. | QualitySalientTermsSignalData | SignalData stores signal-specific salient-term-set-level information. Stores mostly internal data as it is one of the primary data structures used in the populators. | number |
| bigramDiscountTf | The deduction of bigram counts from its unigram children. This field is only available in debug mode. | QualitySalientTermsSignalTermData | SignalTermData is signal-specific term-level information. Stores mostly internal data as it is one of the primary data structures used in the populators. | number |
| bigramness | How much we trust this bigram. For bigrams only. Range: [0.0, 1.0] This field is only available in debug mode. | QualitySalientTermsSignalTermData | SignalTermData is signal-specific term-level information. Stores mostly internal data as it is one of the primary data structures used in the populators. | number |
| centrality | Measures how topical this term is to a particular signal. A term like “lincoln” in the Abraham Lincoln’s Wikipedia page should have a centrality close to 1.0 while non-central terms like “florida” should have a centrality close to 0.0. Range: [0.0, 1.0] This field is only available in debug mode. | QualitySalientTermsSignalTermData | SignalTermData is signal-specific term-level information. Stores mostly internal data as it is one of the primary data structures used in the populators. | number |
| correctedTf | The final term frequency for a particular term. This field is only available in debug mode. | QualitySalientTermsSignalTermData | SignalTermData is signal-specific term-level information. Stores mostly internal data as it is one of the primary data structures used in the populators. | number |
| expectedTf | The term frequency we were expecting for a term given its IDF. Range: [0, observed_volume] This field is only available in debug mode. | QualitySalientTermsSignalTermData | SignalTermData is signal-specific term-level information. Stores mostly internal data as it is one of the primary data structures used in the populators. | number |
| globalNpmi | Global NPMI. For bigrams only. This is a measure of the quality of bigrams calculated using IDF. Range: [-1.0, 1.0] This field is only available in debug mode. | QualitySalientTermsSignalTermData | SignalTermData is signal-specific term-level information. Stores mostly internal data as it is one of the primary data structures used in the populators. | number |
| idf | The IDF of the label of a particular term. For a canonical term, this is the mean IDF of its originals, weighted by their observed TF. This field is only available in debug mode. | QualitySalientTermsSignalTermData | SignalTermData is signal-specific term-level information. Stores mostly internal data as it is one of the primary data structures used in the populators. | number |
| isBigram | Whether or not this term is a bigram. This field is only available in debug mode. | QualitySalientTermsSignalTermData | SignalTermData is signal-specific term-level information. Stores mostly internal data as it is one of the primary data structures used in the populators. | boolean |
| label | Raw string that identifies a particular term. This field is only available in debug mode. | QualitySalientTermsSignalTermData | SignalTermData is signal-specific term-level information. Stores mostly internal data as it is one of the primary data structures used in the populators. | String |
| localNpmi | Local NPMI (normalized pointwise mutual information). For bigrams only. This is a measure of the quality of bigrams calculated using observed TF. Range: [-1.0, 1.0] This field is only available in debug mode. | QualitySalientTermsSignalTermData | SignalTermData is signal-specific term-level information. Stores mostly internal data as it is one of the primary data structures used in the populators. | number |
| observedTf | The observed term frequency in a particular signal. This field is only available in debug mode. | QualitySalientTermsSignalTermData | SignalTermData is signal-specific term-level information. Stores mostly internal data as it is one of the primary data structures used in the populators. | number |
| originalTerm | The list of the original terms for a canonical. This is used in the pipeline and it is not present in the final output. This field is only available in debug mode. | QualitySalientTermsSignalTermData | SignalTermData is signal-specific term-level information. Stores mostly internal data as it is one of the primary data structures used in the populators. | list(QualitySalientTermsSignalTermData) |
| rawTf | The raw term frequency in a particular signal. This field is only available in debug mode. | QualitySalientTermsSignalTermData | SignalTermData is signal-specific term-level information. Stores mostly internal data as it is one of the primary data structures used in the populators. | number |
| salience | The measure of how important this term is in this signal. Range: [0.0, 1.0] This field is only available in debug mode. | QualitySalientTermsSignalTermData | SignalTermData is signal-specific term-level information. Stores mostly internal data as it is one of the primary data structures used in the populators. | number |
| source | source is the type of the signal of this SignalTermData. | QualitySalientTermsSignalTermData | SignalTermData is signal-specific term-level information. Stores mostly internal data as it is one of the primary data structures used in the populators. | String |
| item | QualitySherlockKnexAnnotation | list(QualitySherlockKnexAnnotationItem) | ||
| calibratedScore | in [0, 1]. | QualitySherlockKnexAnnotationItem | number | |
| debugName | QualitySherlockKnexAnnotationItem | String | ||
| equivalentMid | in /m/ or /g/. | QualitySherlockKnexAnnotationItem | String | |
| score | in [0, 1]. | QualitySherlockKnexAnnotationItem | number | |
| version | QualitySherlockKnexAnnotationItem | integer | ||
| datasetModelArticleScore | Score from the blockbert article classifier model. go/article-understanding-project | QualityShoppingShoppingAttachment | This proto is a lightweight version of ShoppingAnnotation in docjoin attachment. We’re doing a deep copy of protos defined in ShoppingAnnotation so that we can control individual fields that will sit in Muppet. Data here will be used for scoring organic shopping web results and previews. Many shopping related signals, e.g., product review score, are also served from this attachment. DEPRECATED: Please use UDR (go/udr) instead. | integer |
| datasetModelBuyingGuideScore | QualityShoppingShoppingAttachment | This proto is a lightweight version of ShoppingAnnotation in docjoin attachment. We’re doing a deep copy of protos defined in ShoppingAnnotation so that we can control individual fields that will sit in Muppet. Data here will be used for scoring organic shopping web results and previews. Many shopping related signals, e.g., product review score, are also served from this attachment. DEPRECATED: Please use UDR (go/udr) instead. | integer | |
| datasetModelForumListScore | From forum and qna confidence score * 100, http://go/sdu-ugc-page-intro | QualityShoppingShoppingAttachment | This proto is a lightweight version of ShoppingAnnotation in docjoin attachment. We’re doing a deep copy of protos defined in ShoppingAnnotation so that we can control individual fields that will sit in Muppet. Data here will be used for scoring organic shopping web results and previews. Many shopping related signals, e.g., product review score, are also served from this attachment. DEPRECATED: Please use UDR (go/udr) instead. | integer |
| datasetModelForumSingleScore | QualityShoppingShoppingAttachment | This proto is a lightweight version of ShoppingAnnotation in docjoin attachment. We’re doing a deep copy of protos defined in ShoppingAnnotation so that we can control individual fields that will sit in Muppet. Data here will be used for scoring organic shopping web results and previews. Many shopping related signals, e.g., product review score, are also served from this attachment. DEPRECATED: Please use UDR (go/udr) instead. | integer | |
| datasetModelInStoreOnlyScore | QualityShoppingShoppingAttachment | This proto is a lightweight version of ShoppingAnnotation in docjoin attachment. We’re doing a deep copy of protos defined in ShoppingAnnotation so that we can control individual fields that will sit in Muppet. Data here will be used for scoring organic shopping web results and previews. Many shopping related signals, e.g., product review score, are also served from this attachment. DEPRECATED: Please use UDR (go/udr) instead. | integer | |
| datasetModelIndirectAvailabilityScore | QualityShoppingShoppingAttachment | This proto is a lightweight version of ShoppingAnnotation in docjoin attachment. We’re doing a deep copy of protos defined in ShoppingAnnotation so that we can control individual fields that will sit in Muppet. Data here will be used for scoring organic shopping web results and previews. Many shopping related signals, e.g., product review score, are also served from this attachment. DEPRECATED: Please use UDR (go/udr) instead. | integer | |
| datasetModelMultiProductScore | From indexing.ml.PageType.confidence * 100 (DatasetModelAnnotation in cdoc) go/sdu-shopping-page-intro | QualityShoppingShoppingAttachment | This proto is a lightweight version of ShoppingAnnotation in docjoin attachment. We’re doing a deep copy of protos defined in ShoppingAnnotation so that we can control individual fields that will sit in Muppet. Data here will be used for scoring organic shopping web results and previews. Many shopping related signals, e.g., product review score, are also served from this attachment. DEPRECATED: Please use UDR (go/udr) instead. | integer |
| datasetModelProductComparisonScore | QualityShoppingShoppingAttachment | This proto is a lightweight version of ShoppingAnnotation in docjoin attachment. We’re doing a deep copy of protos defined in ShoppingAnnotation so that we can control individual fields that will sit in Muppet. Data here will be used for scoring organic shopping web results and previews. Many shopping related signals, e.g., product review score, are also served from this attachment. DEPRECATED: Please use UDR (go/udr) instead. | integer | |
| datasetModelProductReviewScore | QualityShoppingShoppingAttachment | This proto is a lightweight version of ShoppingAnnotation in docjoin attachment. We’re doing a deep copy of protos defined in ShoppingAnnotation so that we can control individual fields that will sit in Muppet. Data here will be used for scoring organic shopping web results and previews. Many shopping related signals, e.g., product review score, are also served from this attachment. DEPRECATED: Please use UDR (go/udr) instead. | integer | |
| datasetModelProductTopnScore | QualityShoppingShoppingAttachment | This proto is a lightweight version of ShoppingAnnotation in docjoin attachment. We’re doing a deep copy of protos defined in ShoppingAnnotation so that we can control individual fields that will sit in Muppet. Data here will be used for scoring organic shopping web results and previews. Many shopping related signals, e.g., product review score, are also served from this attachment. DEPRECATED: Please use UDR (go/udr) instead. | integer | |
| datasetModelQnaListScore | QualityShoppingShoppingAttachment | This proto is a lightweight version of ShoppingAnnotation in docjoin attachment. We’re doing a deep copy of protos defined in ShoppingAnnotation so that we can control individual fields that will sit in Muppet. Data here will be used for scoring organic shopping web results and previews. Many shopping related signals, e.g., product review score, are also served from this attachment. DEPRECATED: Please use UDR (go/udr) instead. | integer | |
| datasetModelQnaSingleScore | QualityShoppingShoppingAttachment | This proto is a lightweight version of ShoppingAnnotation in docjoin attachment. We’re doing a deep copy of protos defined in ShoppingAnnotation so that we can control individual fields that will sit in Muppet. Data here will be used for scoring organic shopping web results and previews. Many shopping related signals, e.g., product review score, are also served from this attachment. DEPRECATED: Please use UDR (go/udr) instead. | integer | |
| datasetModelSingleProductScore | QualityShoppingShoppingAttachment | This proto is a lightweight version of ShoppingAnnotation in docjoin attachment. We’re doing a deep copy of protos defined in ShoppingAnnotation so that we can control individual fields that will sit in Muppet. Data here will be used for scoring organic shopping web results and previews. Many shopping related signals, e.g., product review score, are also served from this attachment. DEPRECATED: Please use UDR (go/udr) instead. | integer | |
| datasetModelSoldOutScore | QualityShoppingShoppingAttachment | This proto is a lightweight version of ShoppingAnnotation in docjoin attachment. We’re doing a deep copy of protos defined in ShoppingAnnotation so that we can control individual fields that will sit in Muppet. Data here will be used for scoring organic shopping web results and previews. Many shopping related signals, e.g., product review score, are also served from this attachment. DEPRECATED: Please use UDR (go/udr) instead. | integer | |
| expiredShoppingPageScore | From indexing.badpages.CollapserInfo.expired_shopping_page_score * 100 | QualityShoppingShoppingAttachment | This proto is a lightweight version of ShoppingAnnotation in docjoin attachment. We’re doing a deep copy of protos defined in ShoppingAnnotation so that we can control individual fields that will sit in Muppet. Data here will be used for scoring organic shopping web results and previews. Many shopping related signals, e.g., product review score, are also served from this attachment. DEPRECATED: Please use UDR (go/udr) instead. | integer |
| multiProductScore | From MagicPageTypeAnnotation.multiplicity.confidence_score * 100 Deprecated as of July 2020 when dataset_model_multi_product_score and dataset_model_single_product_score were added. | QualityShoppingShoppingAttachment | This proto is a lightweight version of ShoppingAnnotation in docjoin attachment. We’re doing a deep copy of protos defined in ShoppingAnnotation so that we can control individual fields that will sit in Muppet. Data here will be used for scoring organic shopping web results and previews. Many shopping related signals, e.g., product review score, are also served from this attachment. DEPRECATED: Please use UDR (go/udr) instead. | integer |
| product | QualityShoppingShoppingAttachment | This proto is a lightweight version of ShoppingAnnotation in docjoin attachment. We’re doing a deep copy of protos defined in ShoppingAnnotation so that we can control individual fields that will sit in Muppet. Data here will be used for scoring organic shopping web results and previews. Many shopping related signals, e.g., product review score, are also served from this attachment. DEPRECATED: Please use UDR (go/udr) instead. | list(QualityShoppingShoppingAttachmentProduct) | |
| shoppingSiteScore | From ShoppingSiteClassifier.score * 100 | QualityShoppingShoppingAttachment | This proto is a lightweight version of ShoppingAnnotation in docjoin attachment. We’re doing a deep copy of protos defined in ShoppingAnnotation so that we can control individual fields that will sit in Muppet. Data here will be used for scoring organic shopping web results and previews. Many shopping related signals, e.g., product review score, are also served from this attachment. DEPRECATED: Please use UDR (go/udr) instead. | integer |
| shoppingSiteScoreShopfab | From ShoppingSiteClassifierShopfab.score * 100 | QualityShoppingShoppingAttachment | This proto is a lightweight version of ShoppingAnnotation in docjoin attachment. We’re doing a deep copy of protos defined in ShoppingAnnotation so that we can control individual fields that will sit in Muppet. Data here will be used for scoring organic shopping web results and previews. Many shopping related signals, e.g., product review score, are also served from this attachment. DEPRECATED: Please use UDR (go/udr) instead. | integer |
| singleProductScore | QualityShoppingShoppingAttachment | This proto is a lightweight version of ShoppingAnnotation in docjoin attachment. We’re doing a deep copy of protos defined in ShoppingAnnotation so that we can control individual fields that will sit in Muppet. Data here will be used for scoring organic shopping web results and previews. Many shopping related signals, e.g., product review score, are also served from this attachment. DEPRECATED: Please use UDR (go/udr) instead. | integer | |
| languageId | Use integers for fast scoring. Note: 26 is UNKNOWN_LANGUAGE_ID, 0 is UNKNOWN region, see i18n::languages::Language and StableInternalRegionconverter Use -1 as default for both. | QualityShoppingShoppingAttachmentLocale | integer | |
| regionId | QualityShoppingShoppingAttachmentLocale | integer | ||
| facetId | QualityShoppingShoppingAttachmentMokaFacetValue | Moka product attribute facet (go/gx). | String | |
| measureValue | QualityShoppingShoppingAttachmentMokaFacetValue | Moka product attribute facet (go/gx). | float | |
| tagId | QualityShoppingShoppingAttachmentMokaFacetValue | Moka product attribute facet (go/gx). | String | |
| condition | QualityShoppingShoppingAttachmentOffer | String | ||
| controlType | QualityShoppingShoppingAttachmentOffer | String | ||
| fingerprintOfOfferUrls | fingerprint of original offer item_urland mobile_offer_url (if present) to be able to understand if offer data came from different url. | QualityShoppingShoppingAttachmentOffer | list(String) | |
| gtinValue | Global trade item number (GTIN). | QualityShoppingShoppingAttachmentOffer | list(String) | |
| imageId | image_id is sorted and distinct for efficient search during serving. | QualityShoppingShoppingAttachmentOffer | list(String) | |
| inferredImages | inferred_images are sorted by inferred_image_id for efficient search during serving. | QualityShoppingShoppingAttachmentOffer | list(ShoppingWebentityShoppingAnnotationInferredImage) | |
| isLensBuildable | Is the offer Lens buildable. The corresponding field in Shopping Annotation is SurfaceSelection. | QualityShoppingShoppingAttachmentOffer | boolean | |
| matchingType | information about methods used to match offer with indexed url. See shopping_annotation.proto | QualityShoppingShoppingAttachmentOffer | String | |
| merchantAccountId | account_id of the merchant in shopping systems. | QualityShoppingShoppingAttachmentOffer | String | |
| merchantItemId | merchant_item_id is meaningless without the merchant_account_id. | QualityShoppingShoppingAttachmentOffer | String | |
| nonDisplayableBrandMerchantRelationship | direct to consumer brand merchant relationship | QualityShoppingShoppingAttachmentOffer | String | |
| nonDisplayableCurrency | QualityShoppingShoppingAttachmentOffer | String | ||
| nonDisplayableOrganicScoreMillis | Normalized riskiness score for Organic destinations. It’s in range [1,1000] with 1 being the worst score and 1000 being the best. | QualityShoppingShoppingAttachmentOffer | integer | |
| nonDisplayableStaleAvailability | This is experimental, not filled in yet and not intended to be used. Please contact buyable-corpus@ before considering using this field. | QualityShoppingShoppingAttachmentOffer | ShoppingWebentityShoppingAnnotationOfferAvailabilityInfo | |
| offerDocid | QualityShoppingShoppingAttachmentOffer | String | ||
| refType | QualityShoppingShoppingAttachmentOffer | String | ||
| soriVersionId | QualityShoppingShoppingAttachmentOffer | ShoppingWebentityShoppingAnnotationSoriVersionId | ||
| fullTitle | Field full_title may contain duplicate info from title and list_title. | QualityShoppingShoppingAttachmentPBlock | Next ID: 18 | String |
| imageDocid | Ordering for `image_docid`, and `image_info` are the same. | QualityShoppingShoppingAttachmentPBlock | Next ID: 18 | list(String) |
| imageInfo | QualityShoppingShoppingAttachmentPBlock | Next ID: 18 | list(QualityShoppingShoppingAttachmentPBlockImageInfo) | |
| isFreeDelivery | QualityShoppingShoppingAttachmentPBlock | Next ID: 18 | boolean | |
| isFreeReturn | QualityShoppingShoppingAttachmentPBlock | Next ID: 18 | boolean | |
| listTitle | QualityShoppingShoppingAttachmentPBlock | Next ID: 18 | String | |
| maxPriceValue | QualityShoppingShoppingAttachmentPBlock | Next ID: 18 | number | |
| minPriceValue | QualityShoppingShoppingAttachmentPBlock | Next ID: 18 | number | |
| price | QualityShoppingShoppingAttachmentPBlock | Next ID: 18 | String | |
| priceCurrency | QualityShoppingShoppingAttachmentPBlock | Next ID: 18 | String | |
| priceValue | QualityShoppingShoppingAttachmentPBlock | Next ID: 18 | number | |
| title | Product info extracted by Product Blocks go/sdu-shopping-page-intro and go/product-block-extraction. Here is an example of a page with a ## list_title (Shoes) and 3 blocks with their own titles: | Shoes | | ———————| | * For Running | | ———————| | * Men’s Hiking | | ———————| ## | * Dress Shoes | The field full_title is what we constructed to best describe the product in the block. For example, for the above 3 blocks, their full_titles will contain info from list_title: “Shoes For Running”, “Shoes Men’s Hiking”, “Dress Shoes”. Note that the list_title is not repeated for the 3rd block Real sample pages: http://screen/6UaoBtwWsLfbSKg http://screen/BDHRgDonKG3KcXu, http://screen/53tLwNaX8mmYzDz | QualityShoppingShoppingAttachmentPBlock | Next ID: 18 | String |
| height | QualityShoppingShoppingAttachmentPBlockImageInfo | integer | ||
| width | QualityShoppingShoppingAttachmentPBlockImageInfo | integer | ||
| aggregateRating | QualityShoppingShoppingAttachmentProduct | ShoppingWebentityShoppingAnnotationProductRating | ||
| brandEntityId | QualityShoppingShoppingAttachmentProduct | String | ||
| catalogId | QualityShoppingShoppingAttachmentProduct | String | ||
| globalProductClusterId | QualityShoppingShoppingAttachmentProduct | String | ||
| images | QualityShoppingShoppingAttachmentProduct | list(ShoppingWebentityShoppingAnnotationProductImage) | ||
| locale | QualityShoppingShoppingAttachmentProduct | QualityShoppingShoppingAttachmentLocale | ||
| mokaFacet | QualityShoppingShoppingAttachmentProduct | list(QualityShoppingShoppingAttachmentMokaFacetValue) | ||
| nonDisplayableDescription | QualityShoppingShoppingAttachmentProduct | String | ||
| nonDisplayableTitle | QualityShoppingShoppingAttachmentProduct | String | ||
| offer | QualityShoppingShoppingAttachmentProduct | QualityShoppingShoppingAttachmentOffer | ||
| outlinkDomainRelationship | Whether an outlink points to the same domain or off-domain. Only added if the relationship is known, and the Offer has ref_type of OUTLINK. | QualityShoppingShoppingAttachmentProduct | String | |
| pblock | Client needs to make decision on which field to use when both non_displayable_title and pblock.final_title are present. | QualityShoppingShoppingAttachmentProduct | QualityShoppingShoppingAttachmentPBlock | |
| productBrowseonomyIds | Product level Browseonomy ids from shopping_annotation.product.browseonomy. | QualityShoppingShoppingAttachmentProduct | list(integer) | |
| productClusterMid | QualityShoppingShoppingAttachmentProduct | String | ||
| relevanceEmbedding | Relevance embedding from ShoppingAnnotation.Product | QualityShoppingShoppingAttachmentProduct | list(QualityRankembedMustangMustangRankEmbedInfo) | |
| weakGlobalProductClusterId | Matched/Inferred weak product identity – set only if the global_product_cluster_id is missing | QualityShoppingShoppingAttachmentProduct | String | |
| docs | QualitySitemapBreadcrumbTarget | Sitelink candidates that is generated from breadcrumbs. | list(QualitySitemapBreadcrumbTargetDoc) | |
| count | The number of web pages that contains the url in their breadcrumbs. | QualitySitemapBreadcrumbTargetDoc | integer | |
| title | QualitySitemapBreadcrumbTargetDoc | String | ||
| url | QualitySitemapBreadcrumbTargetDoc | String | ||
| docs | QualitySitemapCoClickTarget | list(QualitySitemapCoClickTargetDoc) | ||
| language | QualitySitemapCoClickTarget | String | ||
| coClickByLocale | QualitySitemapCoClickTargetDoc | list(QualitySitemapCoClickTargetDocCoClickByLocale) | ||
| title | QualitySitemapCoClickTargetDoc | String | ||
| url | QualitySitemapCoClickTargetDoc | String | ||
| coClicks | QualitySitemapCoClickTargetDocCoClickByLocale | number | ||
| coClicksCapped | QualitySitemapCoClickTargetDocCoClickByLocale | number | ||
| coClicksParent | QualitySitemapCoClickTargetDocCoClickByLocale | number | ||
| locale | QualitySitemapCoClickTargetDocCoClickByLocale | String | ||
| annotations | QualitySitemapScoringSignals | Scoring signals for computing the sitelink score. This message is currently intended only for debugging. Accordingly, this is populated in CDoc but not in MDU. It is enforced by the [(exclude_from_mdu) = true] annotation of the corresponding fields in Target and TargetGroup. | list(String) | |
| chromeTransCount | QualitySitemapScoringSignals | Scoring signals for computing the sitelink score. This message is currently intended only for debugging. Accordingly, this is populated in CDoc but not in MDU. It is enforced by the [(exclude_from_mdu) = true] annotation of the corresponding fields in Target and TargetGroup. | String | |
| chromeTransProb | QualitySitemapScoringSignals | Scoring signals for computing the sitelink score. This message is currently intended only for debugging. Accordingly, this is populated in CDoc but not in MDU. It is enforced by the [(exclude_from_mdu) = true] annotation of the corresponding fields in Target and TargetGroup. | number | |
| chromeWeight | QualitySitemapScoringSignals | Scoring signals for computing the sitelink score. This message is currently intended only for debugging. Accordingly, this is populated in CDoc but not in MDU. It is enforced by the [(exclude_from_mdu) = true] annotation of the corresponding fields in Target and TargetGroup. | number | |
| country | QualitySitemapScoringSignals | Scoring signals for computing the sitelink score. This message is currently intended only for debugging. Accordingly, this is populated in CDoc but not in MDU. It is enforced by the [(exclude_from_mdu) = true] annotation of the corresponding fields in Target and TargetGroup. | list(String) | |
| countryConfidence | QualitySitemapScoringSignals | Scoring signals for computing the sitelink score. This message is currently intended only for debugging. Accordingly, this is populated in CDoc but not in MDU. It is enforced by the [(exclude_from_mdu) = true] annotation of the corresponding fields in Target and TargetGroup. | list(number) | |
| impressions | QualitySitemapScoringSignals | Scoring signals for computing the sitelink score. This message is currently intended only for debugging. Accordingly, this is populated in CDoc but not in MDU. It is enforced by the [(exclude_from_mdu) = true] annotation of the corresponding fields in Target and TargetGroup. | String | |
| langConfidence | QualitySitemapScoringSignals | Scoring signals for computing the sitelink score. This message is currently intended only for debugging. Accordingly, this is populated in CDoc but not in MDU. It is enforced by the [(exclude_from_mdu) = true] annotation of the corresponding fields in Target and TargetGroup. | list(number) | |
| language | QualitySitemapScoringSignals | Scoring signals for computing the sitelink score. This message is currently intended only for debugging. Accordingly, this is populated in CDoc but not in MDU. It is enforced by the [(exclude_from_mdu) = true] annotation of the corresponding fields in Target and TargetGroup. | list(String) | |
| localCountryIdentifier | QualitySitemapScoringSignals | Scoring signals for computing the sitelink score. This message is currently intended only for debugging. Accordingly, this is populated in CDoc but not in MDU. It is enforced by the [(exclude_from_mdu) = true] annotation of the corresponding fields in Target and TargetGroup. | list(String) | |
| longClicks | QualitySitemapScoringSignals | Scoring signals for computing the sitelink score. This message is currently intended only for debugging. Accordingly, this is populated in CDoc but not in MDU. It is enforced by the [(exclude_from_mdu) = true] annotation of the corresponding fields in Target and TargetGroup. | String | |
| longCtr | QualitySitemapScoringSignals | Scoring signals for computing the sitelink score. This message is currently intended only for debugging. Accordingly, this is populated in CDoc but not in MDU. It is enforced by the [(exclude_from_mdu) = true] annotation of the corresponding fields in Target and TargetGroup. | number | |
| navboostScore | QualitySitemapScoringSignals | Scoring signals for computing the sitelink score. This message is currently intended only for debugging. Accordingly, this is populated in CDoc but not in MDU. It is enforced by the [(exclude_from_mdu) = true] annotation of the corresponding fields in Target and TargetGroup. | number | |
| navmenuScore | QualitySitemapScoringSignals | Scoring signals for computing the sitelink score. This message is currently intended only for debugging. Accordingly, this is populated in CDoc but not in MDU. It is enforced by the [(exclude_from_mdu) = true] annotation of the corresponding fields in Target and TargetGroup. | number | |
| pagerank | QualitySitemapScoringSignals | Scoring signals for computing the sitelink score. This message is currently intended only for debugging. Accordingly, this is populated in CDoc but not in MDU. It is enforced by the [(exclude_from_mdu) = true] annotation of the corresponding fields in Target and TargetGroup. | integer | |
| recentLongCtr | QualitySitemapScoringSignals | Scoring signals for computing the sitelink score. This message is currently intended only for debugging. Accordingly, this is populated in CDoc but not in MDU. It is enforced by the [(exclude_from_mdu) = true] annotation of the corresponding fields in Target and TargetGroup. | number | |
| targetCdocLanguages | QualitySitemapScoringSignals | Scoring signals for computing the sitelink score. This message is currently intended only for debugging. Accordingly, this is populated in CDoc but not in MDU. It is enforced by the [(exclude_from_mdu) = true] annotation of the corresponding fields in Target and TargetGroup. | list(integer) | |
| titleScore | QualitySitemapScoringSignals | Scoring signals for computing the sitelink score. This message is currently intended only for debugging. Accordingly, this is populated in CDoc but not in MDU. It is enforced by the [(exclude_from_mdu) = true] annotation of the corresponding fields in Target and TargetGroup. | number | |
| oslScore | Score for normal oneline sitelink | QualitySitemapSporcSignals | MESSAGE SHOULD ONLY BE POPULATED DURING ONLINE/SERVING TIME. | number |
| scrolltoScore | Score for scroll-to sitelink | QualitySitemapSporcSignals | MESSAGE SHOULD ONLY BE POPULATED DURING ONLINE/SERVING TIME. | number |
| tocScore | Score for table of contents sitelink | QualitySitemapSporcSignals | MESSAGE SHOULD ONLY BE POPULATED DURING ONLINE/SERVING TIME. | number |
| docid | QualitySitemapSubresult | Information about a single sub-result. | String | |
| itemMetadata | QualitySitemapSubresult | Information about a single sub-result. | QualitySitemapThirdPartyCarouselsListItemMuppetMetadata | |
| subresult | QualitySitemapSubresultList | A container for encapsulating a list of sub-results. | list(QualitySitemapSubresult) | |
| DEPRECATEDSnippet | QualitySitemapTarget | Represents a single sitelink target, contains basic information used to display the target (such as url and title) and to, maybe, dynamically change the way targets are selected and/or ranked (such as score and is_mobile). Please update the TargetInternal message if you make a change to this proto. See “Note on adding new fields”. | list(String) | |
| isGoodForMobile | QualitySitemapTarget | Represents a single sitelink target, contains basic information used to display the target (such as url and title) and to, maybe, dynamically change the way targets are selected and/or ranked (such as score and is_mobile). Please update the TargetInternal message if you make a change to this proto. See “Note on adding new fields”. | boolean | |
| isMobileN1dup | QualitySitemapTarget | Represents a single sitelink target, contains basic information used to display the target (such as url and title) and to, maybe, dynamically change the way targets are selected and/or ranked (such as score and is_mobile). Please update the TargetInternal message if you make a change to this proto. See “Note on adding new fields”. | boolean | |
| languages | The languages of the document, taken from its cdoc.properties().languages() | QualitySitemapTarget | Represents a single sitelink target, contains basic information used to display the target (such as url and title) and to, maybe, dynamically change the way targets are selected and/or ranked (such as score and is_mobile). Please update the TargetInternal message if you make a change to this proto. See “Note on adding new fields”. | list(integer) |
| salientImage | The image data will be copied from the DocInfo response, and will be retrieved online, so this field should not be populated during indexing. This is a temporary field for experimentation. | QualitySitemapTarget | Represents a single sitelink target, contains basic information used to display the target (such as url and title) and to, maybe, dynamically change the way targets are selected and/or ranked (such as score and is_mobile). Please update the TargetInternal message if you make a change to this proto. See “Note on adding new fields”. | WWWResultInfoSubImageDocInfo |
| score | QualitySitemapTarget | Represents a single sitelink target, contains basic information used to display the target (such as url and title) and to, maybe, dynamically change the way targets are selected and/or ranked (such as score and is_mobile). Please update the TargetInternal message if you make a change to this proto. See “Note on adding new fields”. | number | |
| scoringSignals | QualitySitemapTarget | Represents a single sitelink target, contains basic information used to display the target (such as url and title) and to, maybe, dynamically change the way targets are selected and/or ranked (such as score and is_mobile). Please update the TargetInternal message if you make a change to this proto. See “Note on adding new fields”. | QualitySitemapScoringSignals | |
| sectionTexts | Section texts used for Page Anchors Preview (go/page-anchor-preview-dd). | QualitySitemapTarget | Represents a single sitelink target, contains basic information used to display the target (such as url and title) and to, maybe, dynamically change the way targets are selected and/or ranked (such as score and is_mobile). Please update the TargetInternal message if you make a change to this proto. See “Note on adding new fields”. | list(String) |
| snippetResponse | The snippet response for the target document for an empty query. | QualitySitemapTarget | Represents a single sitelink target, contains basic information used to display the target (such as url and title) and to, maybe, dynamically change the way targets are selected and/or ranked (such as score and is_mobile). Please update the TargetInternal message if you make a change to this proto. See “Note on adding new fields”. | GenericSnippetResponse |
| sourceAnchor | QualitySitemapTarget | Represents a single sitelink target, contains basic information used to display the target (such as url and title) and to, maybe, dynamically change the way targets are selected and/or ranked (such as score and is_mobile). Please update the TargetInternal message if you make a change to this proto. See “Note on adding new fields”. | boolean | |
| sporcSignals | FIELD SHOULD ONLY BE POPULATED DURING ONLINE/SERVING TIME. Thus it should have no impact on cdoc/mdu. | QualitySitemapTarget | Represents a single sitelink target, contains basic information used to display the target (such as url and title) and to, maybe, dynamically change the way targets are selected and/or ranked (such as score and is_mobile). Please update the TargetInternal message if you make a change to this proto. See “Note on adding new fields”. | QualitySitemapSporcSignals |
| title | QualitySitemapTarget | Represents a single sitelink target, contains basic information used to display the target (such as url and title) and to, maybe, dynamically change the way targets are selected and/or ranked (such as score and is_mobile). Please update the TargetInternal message if you make a change to this proto. See “Note on adding new fields”. | String | |
| twoLevelScore | QualitySitemapTarget | Represents a single sitelink target, contains basic information used to display the target (such as url and title) and to, maybe, dynamically change the way targets are selected and/or ranked (such as score and is_mobile). Please update the TargetInternal message if you make a change to this proto. See “Note on adding new fields”. | number | |
| url | QualitySitemapTarget | Represents a single sitelink target, contains basic information used to display the target (such as url and title) and to, maybe, dynamically change the way targets are selected and/or ranked (such as score and is_mobile). Please update the TargetInternal message if you make a change to this proto. See “Note on adding new fields”. | String | |
| DEPRECATEDCountry | QualitySitemapTargetGroup | Represents a set of targets. The group may have a label field to uniquely identify this target group among others – for instance, if these targets’ titles were generated using an alternative title algorithm, the label can be “newtitles”. See “Note on adding new fields”. | integer | |
| Target | QualitySitemapTargetGroup | Represents a set of targets. The group may have a label field to uniquely identify this target group among others – for instance, if these targets’ titles were generated using an alternative title algorithm, the label can be “newtitles”. See “Note on adding new fields”. | list(QualitySitemapTarget) | |
| allTargetsNamedAnchors | If all the targets in this group are named anchors on the source page. | QualitySitemapTargetGroup | Represents a set of targets. The group may have a label field to uniquely identify this target group among others – for instance, if these targets’ titles were generated using an alternative title algorithm, the label can be “newtitles”. See “Note on adding new fields”. | boolean |
| allTargetsNamedTopictagsScrollto | If all the targets in this group are named topictags_scrollto on the source page. | QualitySitemapTargetGroup | Represents a set of targets. The group may have a label field to uniquely identify this target group among others – for instance, if these targets’ titles were generated using an alternative title algorithm, the label can be “newtitles”. See “Note on adding new fields”. | boolean |
| breadcrumbTarget | QualitySitemapTargetGroup | Represents a set of targets. The group may have a label field to uniquely identify this target group among others – for instance, if these targets’ titles were generated using an alternative title algorithm, the label can be “newtitles”. See “Note on adding new fields”. | QualitySitemapBreadcrumbTarget | |
| coClickTarget | QualitySitemapTargetGroup | Represents a set of targets. The group may have a label field to uniquely identify this target group among others – for instance, if these targets’ titles were generated using an alternative title algorithm, the label can be “newtitles”. See “Note on adding new fields”. | list(QualitySitemapCoClickTarget) | |
| countryCode | QualitySitemapTargetGroup | Represents a set of targets. The group may have a label field to uniquely identify this target group among others – for instance, if these targets’ titles were generated using an alternative title algorithm, the label can be “newtitles”. See “Note on adding new fields”. | String | |
| label | QualitySitemapTargetGroup | Represents a set of targets. The group may have a label field to uniquely identify this target group among others – for instance, if these targets’ titles were generated using an alternative title algorithm, the label can be “newtitles”. See “Note on adding new fields”. | String | |
| language | QualitySitemapTargetGroup | Represents a set of targets. The group may have a label field to uniquely identify this target group among others – for instance, if these targets’ titles were generated using an alternative title algorithm, the label can be “newtitles”. See “Note on adding new fields”. | integer | |
| modifiedByHostcardHandler | QualitySitemapTargetGroup | Represents a set of targets. The group may have a label field to uniquely identify this target group among others – for instance, if these targets’ titles were generated using an alternative title algorithm, the label can be “newtitles”. See “Note on adding new fields”. | boolean | |
| scoringSignals | QualitySitemapTargetGroup | Represents a set of targets. The group may have a label field to uniquely identify this target group among others – for instance, if these targets’ titles were generated using an alternative title algorithm, the label can be “newtitles”. See “Note on adding new fields”. | QualitySitemapScoringSignals | |
| topUrl | A list of top urls with highest two_level_score, i.e., chrome_trans_clicks. | QualitySitemapTargetGroup | Represents a set of targets. The group may have a label field to uniquely identify this target group among others – for instance, if these targets’ titles were generated using an alternative title algorithm, the label can be “newtitles”. See “Note on adding new fields”. | list(QualitySitemapTopURL) |
| twoLevelTarget | QualitySitemapTargetGroup | Represents a set of targets. The group may have a label field to uniquely identify this target group among others – for instance, if these targets’ titles were generated using an alternative title algorithm, the label can be “newtitles”. See “Note on adding new fields”. | list(QualitySitemapTwoLevelTarget) | |
| urlFoundOnPage | DEPRECATED. No longer populated, and not used anywhere. | QualitySitemapThirdPartyCarouselsListItemMuppetMetadata | A set of metadata about a list item that is passed on to Muppet from indexing. | boolean |
| score | QualitySitemapTopURL | number | ||
| url | QualitySitemapTopURL | String | ||
| firstLevelTarget | QualitySitemapTwoLevelTarget | QualitySitemapTarget | ||
| secondLevelTarget | QualitySitemapTwoLevelTarget | list(QualitySitemapTarget) | ||
| begin | Bolded range [begin, end) | QualitySnippetsTruncationSnippetBoldedRange | A bolded range in printed snippet lines. | QualitySnippetsTruncationSnippetBoldedRangePosition |
| end | QualitySnippetsTruncationSnippetBoldedRange | A bolded range in printed snippet lines. | QualitySnippetsTruncationSnippetBoldedRangePosition | |
| text | Only populated for debugging. | QualitySnippetsTruncationSnippetBoldedRange | A bolded range in printed snippet lines. | String |
| type | QualitySnippetsTruncationSnippetBoldedRange | A bolded range in printed snippet lines. | String | |
| byteOffset | QualitySnippetsTruncationSnippetBoldedRangePosition | integer | ||
| index | QualitySnippetsTruncationSnippetBoldedRangePosition | integer | ||
| petacatScores | QualityTimebasedDateUnreliability | Unreliable dates signals per URL. go/unreliable-dates-dd | list(QualityTimebasedPetacatDateUnreliability) | |
| unreliableDatesScore | If scores are missing, the date is reliable by default. max(petacat.unreliable_dates_score) | QualityTimebasedDateUnreliability | Unreliable dates signals per URL. go/unreliable-dates-dd | number |
| unreliableDatesScoreExposureAdjusted | max(petacat.unreliable_dates_score * petacat.date_exposure_score) | QualityTimebasedDateUnreliability | Unreliable dates signals per URL. go/unreliable-dates-dd | number |
| adjustmentInfo | This is stored only for debugging purposes. Please consult dates@ team before making a dependency on this field. | QualityTimebasedLastSignificantUpdate | QualityTimebasedLastSignificantUpdateAdjustments | |
| date | LastSignificantUpdate as UNIX timestamp in seconds. This is the new signal (go/lsu-dd) from LSU Selector V2 (once that is enabled, see b/171879888 for status), falling back to the legacy V1 signal if the HIGH_PRECISION signal does not exist. Please use the ‘source’ field to determine where the value comes from. | QualityTimebasedLastSignificantUpdate | String | |
| dateUnreliabilityInfo | QualityTimebasedLastSignificantUpdate | QualityTimebasedDateUnreliability | ||
| source | The source the signal comes from. | QualityTimebasedLastSignificantUpdate | String | |
| adjustmentSource | If the selected LSU has been adjusted, i.e. the maximum passage timestamp, firstseen or contentage were assigned to LSU, the adjustment source is stored here. | QualityTimebasedLastSignificantUpdateAdjustments | String | |
| isUpperboundTimestampPrecise | The timestamp is precise when it’s derived from existing (>March 2022) passage timestamp. | QualityTimebasedLastSignificantUpdateAdjustments | boolean | |
| unboundedTimestampInSeconds | The timestamp that was picked up by the component indicated in the LastSignificantUpdateSource but was dropped due to exceeding the upper bound. Set only if it is not equal to final LSU. | QualityTimebasedLastSignificantUpdateAdjustments | String | |
| unboundedTimestampSource | The source that produced the unbounded timestamp. | QualityTimebasedLastSignificantUpdateAdjustments | String | |
| upperboundTimestampInSeconds | The upperbound value derived from passage timestamps. If present, the LSU date should never exceed this value. Design doc: go/lsu-max-passage-timestamp | QualityTimebasedLastSignificantUpdateAdjustments | String | |
| isForumPage | Set to true if this page is classified as a forum page. | QualityTimebasedPageType | boolean | |
| isPageWithFreshRepeatedDates | Set to true if this page has a fresh repeated date sequence. | QualityTimebasedPageType | boolean | |
| isQnaPage | Set to true if this page is classified as a question answers page. | QualityTimebasedPageType | boolean | |
| contentageReliability | QualityTimebasedPetacatDateUnreliability | Unreliable dates signals per Domain+Petacat. go/unreliable-dates-dd NOTE(tomwesolowski): As of now, we can safely keep up to 8 4-bytes fields in this proto due to Laelaps constraint of max. 50k bytes per single value. We keep all the petacats categories for a domain under the same key. The largest sites (Youtube, Wikipedia, Facebook) have up to 1.5k different petacat verticals. 1500 * 4 * 8 / 1024 bytes = 46.9k bytes | number | |
| dateExposure | QualityTimebasedPetacatDateUnreliability | Unreliable dates signals per Domain+Petacat. go/unreliable-dates-dd NOTE(tomwesolowski): As of now, we can safely keep up to 8 4-bytes fields in this proto due to Laelaps constraint of max. 50k bytes per single value. We keep all the petacats categories for a domain under the same key. The largest sites (Youtube, Wikipedia, Facebook) have up to 1.5k different petacat verticals. 1500 * 4 * 8 / 1024 bytes = 46.9k bytes | number | |
| dateExposureScore | This is date_exposure after sigmoid transformation. | QualityTimebasedPetacatDateUnreliability | Unreliable dates signals per Domain+Petacat. go/unreliable-dates-dd NOTE(tomwesolowski): As of now, we can safely keep up to 8 4-bytes fields in this proto due to Laelaps constraint of max. 50k bytes per single value. We keep all the petacats categories for a domain under the same key. The largest sites (Youtube, Wikipedia, Facebook) have up to 1.5k different petacat verticals. 1500 * 4 * 8 / 1024 bytes = 46.9k bytes | number |
| dateVsContentageDistributionSkew | Auxiliary scores. The unreliable_dates_score is a product of these scores excl. date_exposure. The definition for each of the scores you can find at go/unreliable-dates-dd | QualityTimebasedPetacatDateUnreliability | Unreliable dates signals per Domain+Petacat. go/unreliable-dates-dd NOTE(tomwesolowski): As of now, we can safely keep up to 8 4-bytes fields in this proto due to Laelaps constraint of max. 50k bytes per single value. We keep all the petacats categories for a domain under the same key. The largest sites (Youtube, Wikipedia, Facebook) have up to 1.5k different petacat verticals. 1500 * 4 * 8 / 1024 bytes = 46.9k bytes | number |
| isForumQnaSocialMediaProbability | QualityTimebasedPetacatDateUnreliability | Unreliable dates signals per Domain+Petacat. go/unreliable-dates-dd NOTE(tomwesolowski): As of now, we can safely keep up to 8 4-bytes fields in this proto due to Laelaps constraint of max. 50k bytes per single value. We keep all the petacats categories for a domain under the same key. The largest sites (Youtube, Wikipedia, Facebook) have up to 1.5k different petacat verticals. 1500 * 4 * 8 / 1024 bytes = 46.9k bytes | number | |
| petacatId | go/verticals4 | QualityTimebasedPetacatDateUnreliability | Unreliable dates signals per Domain+Petacat. go/unreliable-dates-dd NOTE(tomwesolowski): As of now, we can safely keep up to 8 4-bytes fields in this proto due to Laelaps constraint of max. 50k bytes per single value. We keep all the petacats categories for a domain under the same key. The largest sites (Youtube, Wikipedia, Facebook) have up to 1.5k different petacat verticals. 1500 * 4 * 8 / 1024 bytes = 46.9k bytes | integer |
| unreliableDatesScore | This is a final score excl. date exposure component. | QualityTimebasedPetacatDateUnreliability | Unreliable dates signals per Domain+Petacat. go/unreliable-dates-dd NOTE(tomwesolowski): As of now, we can safely keep up to 8 4-bytes fields in this proto due to Laelaps constraint of max. 50k bytes per single value. We keep all the petacats categories for a domain under the same key. The largest sites (Youtube, Wikipedia, Facebook) have up to 1.5k different petacat verticals. 1500 * 4 * 8 / 1024 bytes = 46.9k bytes | number |
| bylineDate | The following field is set only when the byline date is different from the “date” field above. Currently this happens when the byline date is within the 24 hours of the crawl time, or close but not exactly the same as blog post date due to time zone. The syntactic date is never later than the crawl time. NOTE: If this field is set, use_as_byline_date will be meaningless, and better to be cleared. | QualityTimebasedSyntacticDate | Next ID: 21 | String |
| date | The number of seconds since epoch (Jan 1, 1970). This can be negative to indicate a publication date that is before 1970. For example, the ones from NY Times archive: “http://select.nytimes.com/gst/abstract.html?res=F10B13FB3D5A10728FDDAF089” “4DD405B8588F1D3&scp=91&sq=world+war+II&st=p” | QualityTimebasedSyntacticDate | Next ID: 21 | String |
| daterange | QualityTimebasedSyntacticDate | Next ID: 21 | QualityTimebasedSyntacticDateDateRange | |
| debugInfo | QualityTimebasedSyntacticDate | Next ID: 21 | String | |
| fromExplicitTimeZone | If set to true, the source of the date has explicit time zone specification. Note: This is only used internally and should not be populated in docjoins. | QualityTimebasedSyntacticDate | Next ID: 21 | boolean |
| info | Used to store extra information about the syntactic date. For now only two bits are set. Please refer to the encoding/decoding functions provided in: quality/timebased/syntacticdate/util.h Bit 1 = High confidence byline. This bit is set if the syntactic date has a byline date and this date is considered to be high confidence. Bit 2 = High confidence byline without content age. This bit is set if the syntactic date has a byline date and this date is considered to be high confidence without support from content age. | QualityTimebasedSyntacticDate | Next ID: 21 | integer |
| position | QualityTimebasedSyntacticDate | Next ID: 21 | QualityTimebasedSyntacticDatePosition | |
| precisionMark | The precision mark should be of type PRECISION_MARK. | QualityTimebasedSyntacticDate | Next ID: 21 | integer |
| syntacticDateNotForRestrict | If this is true, do not use syntactic date in date restricts. | QualityTimebasedSyntacticDate | Next ID: 21 | boolean |
| timeZoneOffsetSeconds | Indicates the time zone offset in seconds applied to derive `date’ in UTC. Example: Annotation: “1pm PST” (UTC-8) => -8 * 3600 = -28800 Note: This is only used internally and should not be populated in docjoins. | QualityTimebasedSyntacticDate | Next ID: 21 | String |
| trustSyntacticDateInRanking | This bit is set if we believe that the syntactic date is really high confidence, but does not qualify as a byline date. | QualityTimebasedSyntacticDate | Next ID: 21 | boolean |
| useAsBylineDate | Whether this date is good for display as the snippet byline date. | QualityTimebasedSyntacticDate | Next ID: 21 | boolean |
| useInTimeZoneGuessingMode | This bit is set if the syntactic date is good to be used in site-level timezone guessing statistics calculation. (The date should be absolute date having a timestamp with hour and minute level information. It can come with or without time zone information, which is indicated in from_explicit_time_zone field defined below.) | QualityTimebasedSyntacticDate | Next ID: 21 | boolean |
| useRangeInsteadOfDateForRestrict | If true, the DateRange is used as date restrict, if false, the date is used as date restrict. Has no effect if syntactic_date_not_for_restrict is true. | QualityTimebasedSyntacticDate | Next ID: 21 | boolean |
| end | QualityTimebasedSyntacticDateDateRange | If the single date (plus the precision mark) is still not good enough, we will use the following fields for a date range. In this case, the fields above may all be empty. | String | |
| start | QualityTimebasedSyntacticDateDateRange | If the single date (plus the precision mark) is still not good enough, we will use the following fields for a date range. In this case, the fields above may all be empty. | String | |
| begin | QualityTimebasedSyntacticDatePosition | The following positions are the byte offset in doc body, which is consistent with the date annotations. (See google3/repository/annotations/proto/annotations.proto) These are given when we want to use the date as a byline date, so the snippet generating code will know the positions. | integer | |
| end | QualityTimebasedSyntacticDatePosition | The following positions are the byte offset in doc body, which is consistent with the date annotations. (See google3/repository/annotations/proto/annotations.proto) These are given when we want to use the date as a byline date, so the snippet generating code will know the positions. | integer | |
| i18n | QualityTravelGoodSitesData | Protocol message for data related to good travel sites. This data is stored as signals data in docjoins. | list(QualityTravelGoodSitesDataI18n) | |
| isAggr | QualityTravelGoodSitesData | Protocol message for data related to good travel sites. This data is stored as signals data in docjoins. | boolean | |
| isAttractionOfficial | QualityTravelGoodSitesData | Protocol message for data related to good travel sites. This data is stored as signals data in docjoins. | boolean | |
| isEntity | QualityTravelGoodSitesData | Protocol message for data related to good travel sites. This data is stored as signals data in docjoins. | boolean | |
| isHotelOfficial | QualityTravelGoodSitesData | Protocol message for data related to good travel sites. This data is stored as signals data in docjoins. | boolean | |
| normalizationFactor | Factor that determines how local anchor credit is scaled before being added to global anchors. | QualityTravelGoodSitesData | Protocol message for data related to good travel sites. This data is stored as signals data in docjoins. | number |
| signal | QualityTravelGoodSitesData | Protocol message for data related to good travel sites. This data is stored as signals data in docjoins. | list(QualityTravelGoodSitesDataSignal) | |
| site | QualityTravelGoodSitesData | Protocol message for data related to good travel sites. This data is stored as signals data in docjoins. | String | |
| totalScore | Site quality score, which determines the site type. | QualityTravelGoodSitesData | Protocol message for data related to good travel sites. This data is stored as signals data in docjoins. | number |
| type | QualityTravelGoodSitesData | Protocol message for data related to good travel sites. This data is stored as signals data in docjoins. | String | |
| locale | QualityTravelGoodSitesDataI18n | String | ||
| type | QualityTravelGoodSitesDataI18n | String | ||
| name | QualityTravelGoodSitesDataSignal | Raw signals that determine the site quality score. | String | |
| value | QualityTravelGoodSitesDataSignal | Raw signals that determine the site quality score. | number | |
| language | Audio language of video classified by Automatic Language Identification. It corresponds to the first language (the highest confidence) in ALIResults.lang_results. | QualityVidyaVideoLanguageVideoLanguage | Audio-based language information about a Watch Page. For more information: https://g3doc.corp.google.com/video/timedtext/g3doc/ali.md | String |
| speechClass | Type of detected speech. | QualityVidyaVideoLanguageVideoLanguage | Audio-based language information about a Watch Page. For more information: https://g3doc.corp.google.com/video/timedtext/g3doc/ali.md | String |
| clusterId | The cluster_id represents the id of the set entity that WebRef provides. | QualityViewsExtractionClusterInfo | Stores cluster scoring information for an entity Next Id: 6 | String |
| clusterSetScore | Cluster set qref confidence score. | QualityViewsExtractionClusterInfo | Stores cluster scoring information for an entity Next Id: 6 | number |
| clusterSiblingMid | The mids of cluster members that are part of the same cluster. Note that cluster members may end up having their own interpretation (EntityInfo which includes a ClusterInfo) or not (eg because they do not explain the full query, and so aqua does not output an interpretation for them). The latter case (a cluster member is output only as part of this field), is equivalent to its score being 0. | QualityViewsExtractionClusterInfo | Stores cluster scoring information for an entity Next Id: 6 | list(String) |
| score | The score represents the score of the entity within the cluster. | QualityViewsExtractionClusterInfo | Stores cluster scoring information for an entity Next Id: 6 | number |
| subCluster | QualityViewsExtractionClusterInfo | Stores cluster scoring information for an entity Next Id: 6 | list(QualityViewsExtractionClusterInfo) | |
| videoTranscriptAnnotations | QualityWebanswersTranscriptAnnotations | Wraps other annotations that are run over auto-generated video captions. | list(QualityWebanswersVideoTranscriptAnnotations) | |
| amarnaDocid | Should precisely match the amarna_docid in ContentBasedVideoMetadata. | QualityWebanswersVideoTranscriptAnnotations | String | |
| asrRepair | The results of ASR transcript quality analysis. | QualityWebanswersVideoTranscriptAnnotations | IndexingVideosAsrTranscriptRepairAnnotation | |
| lang | The language of the transcript as recorded in Amarna. | QualityWebanswersVideoTranscriptAnnotations | String | |
| punctuatedTranscript | QualityWebanswersVideoTranscriptAnnotations | String | ||
| saftDocument | QualityWebanswersVideoTranscriptAnnotations | NlpSaftDocument | ||
| saftSentenceBoundary | QualityWebanswersVideoTranscriptAnnotations | SentenceBoundaryAnnotations | ||
| timingInfo | Timing information that maps sentence boundaries in the punctuated transcript with timing offsets for the start and end of those sentences. | QualityWebanswersVideoTranscriptAnnotations | QualityWebanswersVideoYouTubeCaptionTimingInfoAnnotations | |
| transcriptSource | QualityWebanswersVideoTranscriptAnnotations | String | ||
| webrefEntities | QualityWebanswersVideoTranscriptAnnotations | RepositoryWebrefWebrefEntities | ||
| durationMs | QualityWebanswersVideoYouTubeCaptionTimingInfoAnnotations | YouTube caption timing information for http://go/video-answers. | integer | |
| instances | QualityWebanswersVideoYouTubeCaptionTimingInfoAnnotations | YouTube caption timing information for http://go/video-answers. | list(QualityWebanswersVideoYouTubeCaptionTimingInfoAnnotationsInstance) | |
| uploaderName | QualityWebanswersVideoYouTubeCaptionTimingInfoAnnotations | YouTube caption timing information for http://go/video-answers. | String | |
| begin | Byte offsets in HTML. begin is inclusive and end is exclusive. | QualityWebanswersVideoYouTubeCaptionTimingInfoAnnotationsInstance | Byte-offset and timing information in videos. In CompositeDoc, we will store the instance per sentence. | integer |
| end | QualityWebanswersVideoYouTubeCaptionTimingInfoAnnotationsInstance | Byte-offset and timing information in videos. In CompositeDoc, we will store the instance per sentence. | integer | |
| videoBeginMs | QualityWebanswersVideoYouTubeCaptionTimingInfoAnnotationsInstance | Byte-offset and timing information in videos. In CompositeDoc, we will store the instance per sentence. | integer | |
| videoEndMs | QualityWebanswersVideoYouTubeCaptionTimingInfoAnnotationsInstance | Byte-offset and timing information in videos. In CompositeDoc, we will store the instance per sentence. | integer | |
| createdDate | This is the number of days since January 1st 1995 that this domain was last created. This should always fit in 15 bits. | RegistrationInfo | Domain registration information for the document. NEXT ID TO USE: 3 | integer |
| expiredDate | This is the number of days since January 1st 1995 that this domain last expired. This should always fit in 15 bits. Jan 1st 1995 was chosen by the history project as a special epoch date. Both the registrationinfo dates and the linkage dates are measured in days since this epoch. | RegistrationInfo | Domain registration information for the document. NEXT ID TO USE: 3 | integer |
| clusterList | Token information of the embedding vector if available. | ReneEmbedding | Message to represent an embedding vector with clusters. | ReneEmbeddingClusterList |
| compressedValue | Compressed value of the embedding. For example, different versions of starburst signals use different compressor to generate the value. | ReneEmbedding | Message to represent an embedding vector with clusters. | String |
| denseFeatureFloatValues | Optional feature map output from the model. Note: this is not applicable to some models. | ReneEmbedding | Message to represent an embedding vector with clusters. | list(number) |
| floatValues | Values of the embedding vector. | ReneEmbedding | Message to represent an embedding vector with clusters. | list(number) |
| floatValuesBeforeProjection | Optional embedding vector prior to projection. Note: this is not applicable to some models. | ReneEmbedding | Message to represent an embedding vector with clusters. | list(number) |
| id | Id of the cluster. | ReneEmbeddingCluster | Message to represent a cluster of the embedding space. | integer |
| squaredDistance | Squared distance of the current embedding to the cluster center. | ReneEmbeddingCluster | Message to represent a cluster of the embedding space. | number |
| clusters | Clusters. | ReneEmbeddingClusterList | Message to represent a list of clusters. | list(ReneEmbeddingCluster) |
| address | Stores parent/container information containing city, province & country. | RepositoryAnnotationsGeoTopic | GeoTopicality of a document is a set of GeoTopics ordered by their normalized scores. | GeostoreAddressProto |
| componentScores | The raw scores used to calculate the normalized_score. Note that not all these scores may be exposed to the users. | RepositoryAnnotationsGeoTopic | GeoTopicality of a document is a set of GeoTopics ordered by their normalized scores. | list(RepositoryAnnotationsGeoTopicalityScore) |
| confidence | A score [0, 1] indicating the confidence. | RepositoryAnnotationsGeoTopic | GeoTopicality of a document is a set of GeoTopics ordered by their normalized scores. | number |
| denseCity | Is this a dense city (e.g., population > 100k)? | RepositoryAnnotationsGeoTopic | GeoTopicality of a document is a set of GeoTopics ordered by their normalized scores. | boolean |
| establishmentType | Sub type for POI types like ESTABLISHMENT_POI, ESTABLISHMENT_GROUNDS & ESTABLISHMENT_BUILDING | RepositoryAnnotationsGeoTopic | GeoTopicality of a document is a set of GeoTopics ordered by their normalized scores. | integer |
| latE7 | Latitude and Longitude of the location. | RepositoryAnnotationsGeoTopic | GeoTopicality of a document is a set of GeoTopics ordered by their normalized scores. | integer |
| lngE7 | RepositoryAnnotationsGeoTopic | GeoTopicality of a document is a set of GeoTopics ordered by their normalized scores. | integer | |
| locationName | Name of the Geographic location. This is the normalized name. | RepositoryAnnotationsGeoTopic | GeoTopicality of a document is a set of GeoTopics ordered by their normalized scores. | String |
| normalizedScore | A score [0, 1] indicating the likelihood of the location being the GeoTopicality. | RepositoryAnnotationsGeoTopic | GeoTopicality of a document is a set of GeoTopics ordered by their normalized scores. | number |
| oysterId | Oyster Feature ID of the location. | RepositoryAnnotationsGeoTopic | GeoTopicality of a document is a set of GeoTopics ordered by their normalized scores. | GeostoreFeatureIdProto |
| oysterType | Oyster Feature Type | RepositoryAnnotationsGeoTopic | GeoTopicality of a document is a set of GeoTopics ordered by their normalized scores. | integer |
| sumContainedPoiNormalizedScores | The sum of the normalized scores of POIs contained within a particular locality. | RepositoryAnnotationsGeoTopic | GeoTopicality of a document is a set of GeoTopics ordered by their normalized scores. | number |
| geotopics | The geotopics are ordered by normalized_score in descending order. | RepositoryAnnotationsGeoTopicality | list(RepositoryAnnotationsGeoTopic) | |
| rawScore | RepositoryAnnotationsGeoTopicalityScore | number | ||
| type | RepositoryAnnotationsGeoTopicalityScore | String | ||
| deprecatedMagnitude | Deprecated: use snippet_score instead | RepositoryAnnotationsMustangSentimentSnippetAnnotations | A conceptual structure for storing sentiment snippet information in mustang. Essentially an adaptation of PhraseAnnotationProperties from //repository/annotations/proto/annotations.proto. | number |
| deprecatedPolarity | Deprecated: use snippet_score instead | RepositoryAnnotationsMustangSentimentSnippetAnnotations | A conceptual structure for storing sentiment snippet information in mustang. Essentially an adaptation of PhraseAnnotationProperties from //repository/annotations/proto/annotations.proto. | number |
| end | RepositoryAnnotationsMustangSentimentSnippetAnnotations | A conceptual structure for storing sentiment snippet information in mustang. Essentially an adaptation of PhraseAnnotationProperties from //repository/annotations/proto/annotations.proto. | integer | |
| isTruncated | RepositoryAnnotationsMustangSentimentSnippetAnnotations | A conceptual structure for storing sentiment snippet information in mustang. Essentially an adaptation of PhraseAnnotationProperties from //repository/annotations/proto/annotations.proto. | boolean | |
| phraseType | RepositoryAnnotationsMustangSentimentSnippetAnnotations | A conceptual structure for storing sentiment snippet information in mustang. Essentially an adaptation of PhraseAnnotationProperties from //repository/annotations/proto/annotations.proto. | String | |
| snippetScore | RepositoryAnnotationsMustangSentimentSnippetAnnotations | A conceptual structure for storing sentiment snippet information in mustang. Essentially an adaptation of PhraseAnnotationProperties from //repository/annotations/proto/annotations.proto. | integer | |
| snippetText | This protobuffer is serving double duty as both a Mustang attachment and the response proto that gets returned by Mustang in the WWWSnippetResponse’s info MessageSet. When stored as an attachment, this field will always be empty. However, when returned with the WWWSnippetResponse, Mustang will print and store the actual sentiment snippet’s text here. | RepositoryAnnotationsMustangSentimentSnippetAnnotations | A conceptual structure for storing sentiment snippet information in mustang. Essentially an adaptation of PhraseAnnotationProperties from //repository/annotations/proto/annotations.proto. | String |
| start | begin and end are token offsets. | RepositoryAnnotationsMustangSentimentSnippetAnnotations | A conceptual structure for storing sentiment snippet information in mustang. Essentially an adaptation of PhraseAnnotationProperties from //repository/annotations/proto/annotations.proto. | integer |
| crumb | Each crumb represents one link of the breadcrumb chain. | RepositoryAnnotationsRdfaBreadcrumbs | list(RepositoryAnnotationsRdfaCrumb) | |
| url | The URL of the document from which this breadcrumb trail was extracted. | RepositoryAnnotationsRdfaBreadcrumbs | String | |
| title | The text that represented this crumb in the document. | RepositoryAnnotationsRdfaCrumb | The information contained in a single crumb. | String |
| url | The URL linked from this crumb. | RepositoryAnnotationsRdfaCrumb | The information contained in a single crumb. | String |
| rating | Ratings and reviews Either for this version only or for all versions to be displayed. | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | String |
| operatingSystems | See google3/quality/richsnippets/schema/data/operating_systems_rules.txt for possible values. | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | list(String) |
| inAppPurchase | Whether the app offers in-app purchase. | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | boolean |
| screenUrlThumbnail | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | list(String) | |
| rankData | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | RepositoryAnnotationsRdfaRdfaRichSnippetsApplicationRankData | |
| name | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | String | |
| iconUrlHref | Icon and Screenshots | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | String |
| totalRating | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | number | |
| liveOpDetails | Unified proto for android LiveOps and iOS LiveEvents. | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | QualityCalypsoAppsUniversalAuLiveOpsDetailInfo |
| popularScore | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | number | |
| applicationUrl | Fields for internal use | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | String |
| langLocale | locale for the localized data, such as name, description and screenshots | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | String |
| vendorUrl | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | String | |
| platformTags | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | list(String) | |
| extractedIconColors | Top 10 of extracted icon colors. r = (rgb >> 16) & 0xff; g = (rgb >> 8) & 0xff; b = rgb & 0xff; | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | list(integer) |
| isDefaultLangLocale | Indicates if the localized data comes from default locale. This is needed because the default localized data does not specify its locale. If this is true, lang_locale may not be the correct locale and should be ignored. | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | boolean |
| description | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | String | |
| extractedIconColor | Top 1 of extracted icon colors. We keep this field for backward compatibility. | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | integer |
| reviewCount | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | String | |
| supportsChromecast | Whether this App supports Google Cast. | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | boolean |
| reviewAuthor | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | String | |
| physicalDeviceTags | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | list(String) | |
| screenUrlHref | TODO(b/260128276) deprecate this field in favor of image_data. | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | list(String) |
| size | bytes or numeric with MB or GB | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | String |
| price | Price | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | String |
| numDownloads | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | String | |
| supportsAndroidTv | Whether this App supports Android TV. Note that some App supports more than one platforms. So we would use boolean for a platform. | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | boolean |
| hasEditorsChoiceBadge | Whether the app has editors choice tag | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | boolean |
| vendorCanonicalUrl | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | String | |
| version | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | String | |
| countriesSupported | These are currently used only for Google Play. | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | list(String) |
| imageData | Copied from google3/contentads/shared/boulder/mobile-app-data-image-data.proto. | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | QualityCalypsoAppsUniversalImageData |
| genre | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | list(String) | |
| vendor | Vendor | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | String |
| optionalResult | Whether this App is optional result for Grid UI. | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | boolean |
| currency | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | String | |
| ratingCount | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | String | |
| iconUrlThumbnail | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | String | |
| countryPrices | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | list(RepositoryAnnotationsRdfaRdfaRichSnippetsApplicationCountryPrice) | |
| subcategory | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | list(String) | |
| appTypeData | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | RepositoryAnnotationsRdfaRdfaRichSnippetsApplicationAppTypeData | |
| marketplace | Market Android or itunes | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | String |
| devConsoleId | Developer console ID of the app if it exists. The ID is available for an app registered to Google Developers Console, not Play Developer Console. | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | String |
| lastUpdated | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | String | |
| category | Application information. | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | list(String) |
| releaseDate | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | String | |
| originalRating | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | String | |
| localizedTrustedGenome | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | RepositoryAnnotationsRdfaRdfaRichSnippetsApplicationLocalizedTrustedGenome | |
| totalRatingCount | Rating_count including all versions of this application. | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | integer |
| breadcrumbs | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | RepositoryAnnotationsRdfaBreadcrumbs | |
| filteringTag | Tags to be indexed for filtering, e.g. “ft_popular_score_gt_1m”. | RepositoryAnnotationsRdfaRdfaRichSnippetsApplication | This structure holds data for application information for rich snippets Next ID: 53 | list(String) |
| playStoreAppType | Top level app category type (GAME or APPLICATION). Copied from playwright. | RepositoryAnnotationsRdfaRdfaRichSnippetsApplicationAppTypeData | String | |
| countryCode | RepositoryAnnotationsRdfaRdfaRichSnippetsApplicationCountryPrice | String | ||
| currencyCode | ISO 4217 currency code. | RepositoryAnnotationsRdfaRdfaRichSnippetsApplicationCountryPrice | String | |
| price | Price string converted from double value in a standard currency unit, like ‘199.35’ or ‘1400’. | RepositoryAnnotationsRdfaRdfaRichSnippetsApplicationCountryPrice | String | |
| language | The chosen language | RepositoryAnnotationsRdfaRdfaRichSnippetsApplicationLocalizedTrustedGenome | String | |
| localizedTg | The TG tags matching the locale of the doc, if available | RepositoryAnnotationsRdfaRdfaRichSnippetsApplicationLocalizedTrustedGenome | VendingConsumerProtoTrustedGenomeAnnotation | |
| appStoreLink | RepositoryAnnotationsRdfaRdfaRichSnippetsApplicationRank | String | ||
| categoryId | RepositoryAnnotationsRdfaRdfaRichSnippetsApplicationRank | String | ||
| categoryName | RepositoryAnnotationsRdfaRdfaRichSnippetsApplicationRank | String | ||
| chartType | RepositoryAnnotationsRdfaRdfaRichSnippetsApplicationRank | String | ||
| rank | RepositoryAnnotationsRdfaRdfaRichSnippetsApplicationRank | String | ||
| playwrightCategoryId | Copied from the category_id field from Playwright docs. It helps decide which category to show in app ranking info. | RepositoryAnnotationsRdfaRdfaRichSnippetsApplicationRankData | list(String) | |
| rank | RepositoryAnnotationsRdfaRdfaRichSnippetsApplicationRankData | list(RepositoryAnnotationsRdfaRdfaRichSnippetsApplicationRank) | ||
| entityScore | RepositoryWebrefAggregatedEntityNameScores | Represents the aggregated score of the entities for a given name, aggregated over all sources. Next available tag: 3. | list(RepositoryWebrefEntityNameScore) | |
| index | The set of indices in the Anchors::anchor() array that belong to the collapsed anchors. | RepositoryWebrefAnchorIndices | Identifies a set of anchors in the CompositeDoc. Typically these anchors were collapsed by WebRef into a single anchor and they were treated by the annotator as equivalent. They all contain the same mentions (at the same offsets). | list(integer) |
| collectionHrid | The collection hrid for the category. | RepositoryWebrefAnnotatedCategoryInfo | Information about a category annotation on a name. | String |
| mid | The mid of the entity representing the category. | RepositoryWebrefAnnotatedCategoryInfo | Information about a category annotation on a name. | String |
| description | Only use for debugging, this should not be displayed to user or used for any kind of logic/processing. | RepositoryWebrefAnnotationDebugInfo | Debug info about the concept annotations. Note that it might not be present in the output. | String |
| docLevelRelevanceRatings | RepositoryWebrefAnnotationRatings | Human ratings of webref annotations (document-level ratings, mention-level ratings, etc.). | RepositoryWebrefDocLevelRelevanceRatings | |
| avgOpenWorld | The average score for the open world for: – all ranges of this segment_type; – all capitalized ranges of this segment_type; – all uncapitalized ranges of this segment_type. | RepositoryWebrefAnnotationStatsPerType | Annotation statistics for each token type. Next available tag: 8. | number |
| avgOpenWorldCap | RepositoryWebrefAnnotationStatsPerType | Annotation statistics for each token type. Next available tag: 8. | number | |
| avgOpenWorldUncap | RepositoryWebrefAnnotationStatsPerType | Annotation statistics for each token type. Next available tag: 8. | number | |
| numRangesWithCandidates | The number of ranges with candidates that made it past primary pruning for: – all ranges of this segment_type; – all capitalized ranges of this segment_type; – all uncapitalized ranges of this segment_type. | RepositoryWebrefAnnotationStatsPerType | Annotation statistics for each token type. Next available tag: 8. | String |
| numRangesWithCandidatesCap | RepositoryWebrefAnnotationStatsPerType | Annotation statistics for each token type. Next available tag: 8. | String | |
| numRangesWithCandidatesUncap | RepositoryWebrefAnnotationStatsPerType | Annotation statistics for each token type. Next available tag: 8. | String | |
| tokenType | The segment type. | RepositoryWebrefAnnotationStatsPerType | Annotation statistics for each token type. Next available tag: 8. | String |
| fingerprint | RepositoryWebrefAnnotatorCheckpointFprint | Holds annotator checkpoints which record the state of the annotations. This is useful for tracking down the source of diffs, in particular for non-determinism. | String | |
| label | RepositoryWebrefAnnotatorCheckpointFprint | Holds annotator checkpoints which record the state of the annotations. This is useful for tracking down the source of diffs, in particular for non-determinism. | String | |
| numCandidateMentions | RepositoryWebrefAnnotatorProfile | A message to collect annotator performance data. | integer | |
| numEntities | RepositoryWebrefAnnotatorProfile | A message to collect annotator performance data. | integer | |
| numMentions | RepositoryWebrefAnnotatorProfile | A message to collect annotator performance data. | integer | |
| numTokens | RepositoryWebrefAnnotatorProfile | A message to collect annotator performance data. | integer | |
| processorTimingsRoot | Root/total of the timings from all the processors that worked on the given document or query. | RepositoryWebrefAnnotatorProfile | A message to collect annotator performance data. | RepositoryWebrefProcessorTiming |
| bookEditionIsbn | Use varint encoding to save space. | RepositoryWebrefBookEditionMetadata | Book editions metadata for a book entity. This metadata is a pair of “/book/book_edition” mid and its ISBN number. | String |
| bookEditionMid | RepositoryWebrefBookEditionMetadata | Book editions metadata for a book entity. This metadata is a pair of “/book/book_edition” mid and its ISBN number. | String | |
| scoreRatio | RepositoryWebrefBootstrappingScore | number | ||
| browsyTopic | Experimental scores to be used by Discover. | RepositoryWebrefCategoryAnnotation | High level category annotations for documents and queries. | RepositoryWebrefCategoryAnnotationBrowsyTopic |
| debugString | Title of the category. Eg “Politics”, “Technology”. | RepositoryWebrefCategoryAnnotation | High level category annotations for documents and queries. | String |
| hitcat | Sources asserting the category. In the future we may have one calibrated confidence score. | RepositoryWebrefCategoryAnnotation | High level category annotations for documents and queries. | RepositoryWebrefCategoryAnnotationHitCatSource |
| mid | Mid representation of the category. Eg “/m/05qt0”. WARNING: In UDR this field is not populated, use document_entity.entity.mid instead of document_entity.category.mid. | RepositoryWebrefCategoryAnnotation | High level category annotations for documents and queries. | String |
| shopping | Qprime asserting this category. | RepositoryWebrefCategoryAnnotation | High level category annotations for documents and queries. | RepositoryWebrefCategoryAnnotationShoppingSignals |
| confidence | RepositoryWebrefCategoryAnnotationBrowsyTopic | Experimental scores for browsy topics, see * go/example-docs-with-implicit-fashion-styles * go/browsy-entities | number | |
| confidence | Confidence of the category in the range [0.0, 1.0). If a page has the category “NBA” with high confidence we also expect it to have the “Basketball” with high confidence. Categories with a confidence lower than 0.05 are omitted. This can be interpreted as a confidence of 0, i.e. a strong signal that the category is not relevant for the page. For some categories this score is calibrated per-category to estimate the true precision. E.g., 70% of documents retrieved within the confidence range [0.7 – eps, 0.7 + eps] will be relevant when eps is close to 0. | RepositoryWebrefCategoryAnnotationHitCatSource | The HitCat page classifier. See go/hitcat2 If you use any HitCat score, please: 1. Add your use-case to go/hits-clients. 2. Subscribe to hits-users@ to receive general updates. | number |
| cumulativeConfidence | Calibrated cumulative confidence guaranteeing maxmial recall for a precision target. E.g., At least 90% of documents retrieved with cumulative_confidence >= 0.9 will be relevant. This score is always calibrated per-category to estimate the true cumulative precision and is not set for uncalibrated categories. | RepositoryWebrefCategoryAnnotationHitCatSource | The HitCat page classifier. See go/hitcat2 If you use any HitCat score, please: 1. Add your use-case to go/hits-clients. 2. Subscribe to hits-users@ to receive general updates. | number |
| experimentalConfidence | Note: For testing the next version. May change at any time. Experimental confidence of the category in the range (0.0, 1.0). | RepositoryWebrefCategoryAnnotationHitCatSource | The HitCat page classifier. See go/hitcat2 If you use any HitCat score, please: 1. Add your use-case to go/hits-clients. 2. Subscribe to hits-users@ to receive general updates. | number |
| isShoppingAnnotation | Whether QPrime asserts that particular category. | RepositoryWebrefCategoryAnnotationShoppingSignals | The QPrime query classifier signals. | boolean |
| allTypes | Contains all types relevant for this entity, along with their provenances and confidences. This field basically replicates information above in a unified way, so that Refcon scroing can make better use of it. If present, Refcon scoring will use all_types, and ignore other fields like freebase_type. Note: there is some basic conflict resolution applied when all_types are computed (implemented in type-extractor.cc, IsLikelyConflictingFreebase). | RepositoryWebrefCategoryInfo | All informations about category types of the entity. | list(RepositoryWebrefFreebaseType) |
| freebaseType | RepositoryWebrefCategoryInfo | All informations about category types of the entity. | list(RepositoryWebrefFreebaseType) | |
| kgCollection | RepositoryWebrefCategoryInfo | All informations about category types of the entity. | list(RepositoryWebrefKGCollection) | |
| oysterType | RepositoryWebrefCategoryInfo | All informations about category types of the entity. | RepositoryWebrefOysterType | |
| salientCategory | verticals4 categories that cooccur with this entity, aggregated over D2E. See where we read from CompactDocClassification in http://google3/repository/webref/preprocessing/fatcat-categories.cc. | RepositoryWebrefCategoryInfo | All informations about category types of the entity. | list(RepositoryWebrefFatcatCategory) |
| wikipediaCategory | RepositoryWebrefCategoryInfo | All informations about category types of the entity. | list(RepositoryWebrefWikipediaCategory) | |
| wpCategory | WPCat CategotyResult classification. | RepositoryWebrefCategoryInfo | All informations about category types of the entity. | list(RepositoryWebrefFreebaseType) |
| isSet | If true, this entity is a synthetic entity created to represent a “set” in a cluster, i.e. to represent a set of entities (its children in the cluster graph) when we cannot disambiguate among them. This is similar to a KG Collection, but this is not in KG. | RepositoryWebrefClusterMetadata | Metadata about clusters. See go/webref-variants for details. Next available tag: 6. | boolean |
| ruleInstance | Explanation of where this cluster, and this entity, come from. All entities in a cluster have this, not just entities that have been created because of the cluster. | RepositoryWebrefClusterMetadata | Metadata about clusters. See go/webref-variants for details. Next available tag: 6. | RepositoryWebrefClusterProtoRuleInstance |
| id | Id of this rule; this is used to generate ids for the synthetic entities created for a cluster. Required. | RepositoryWebrefClusterProtoMidListRule | A rule that defines a Cluster based on a list of mids. It creates a single Set, and makes it the parent of each of the mids in the list. | String |
| mid | The mids of the entities that will be made into a cluster. | RepositoryWebrefClusterProtoMidListRule | A rule that defines a Cluster based on a list of mids. It creates a single Set, and makes it the parent of each of the mids in the list. | list(String) |
| role | RepositoryWebrefClusterProtoMidListRuleInstance | An instance of a “mid list” rule. Each “mid list” rule defines exactly one cluster. | String | |
| rule | The rule that this is an instance of. Required. | RepositoryWebrefClusterProtoMidListRuleInstance | An instance of a “mid list” rule. Each “mid list” rule defines exactly one cluster. | RepositoryWebrefClusterProtoMidListRule |
| relation | The topic_property_name for the link that defines the relation, e.g. “/tv/tv_series_episode/series”. Can start with a “!” to indicate that this link is reversed during extraction and we want the reversed case. Required. | RepositoryWebrefClusterProtoRelationRule | A rule that defines a Cluster based on a relation. Given a relation (a link type) R, then: For each entity B that has incoming links of type R This defines an instance of this rule, with argument=B We create a Set S We make B a child of S For each entity A that has a link R to B, we make A a child of S Next available tag: 6 | String |
| role | RepositoryWebrefClusterProtoRelationRuleInstance | An instance of a “relation” rule. Each “relation” rule defines a number of clusters, one for each entity B that that has incoming links of a certain type R; all entities with an outgoing link to B of type R are part of that cluster. | String | |
| rule | The rule that this is an instance of. Required. | RepositoryWebrefClusterProtoRelationRuleInstance | An instance of a “relation” rule. Each “relation” rule defines a number of clusters, one for each entity B that that has incoming links of a certain type R; all entities with an outgoing link to B of type R are part of that cluster. | RepositoryWebrefClusterProtoRelationRule |
| target | The one entity that the links of type R point to. Required. | RepositoryWebrefClusterProtoRelationRuleInstance | An instance of a “relation” rule. Each “relation” rule defines a number of clusters, one for each entity B that that has incoming links of a certain type R; all entities with an outgoing link to B of type R are part of that cluster. | RepositoryWebrefWebrefEntityId |
| midList | Exactly one of these *RuleInstance fields needs to be present for clusters which have not been merged; it selects the specific kind of rule instance. For merged clusters both fields may be present. | RepositoryWebrefClusterProtoRuleInstance | When we apply a rule to define a particular cluster, we have a RuleInstance. Some kinds of rules for clusters define more than one cluster. In those rules we say things like “for each entity X with this property, we create a cluster where…”; each particular cluster that we create is the result of an *instance* of that rule, where the argument X has been bound to a particular entity (note that this also applies to rules that define only one cluster; in that case, there are no arguments). An entity that is part of a cluster plays a “role” in such a cluster. This message describes such an instantiation of a rule with a role and with concrete values for the arguments. | RepositoryWebrefClusterProtoMidListRuleInstance |
| relation | RepositoryWebrefClusterProtoRuleInstance | When we apply a rule to define a particular cluster, we have a RuleInstance. Some kinds of rules for clusters define more than one cluster. In those rules we say things like “for each entity X with this property, we create a cluster where…”; each particular cluster that we create is the result of an *instance* of that rule, where the argument X has been bound to a particular entity (note that this also applies to rules that define only one cluster; in that case, there are no arguments). An entity that is part of a cluster plays a “role” in such a cluster. This message describes such an instantiation of a rule with a role and with concrete values for the arguments. | list(RepositoryWebrefClusterProtoRelationRuleInstance) | |
| predicateEncodedMid | RepositoryWebrefCompactFlatPropertyValue | Flattened version of possibly nested compound values. This means that the `value` in here is *never* a `compound_value` and all predicate MIDs on the nested path are collapsed into the repeated `predicate_encoded_mid` field. When `predicate_encoded_mid` contains only one predicate, this is equivalent to a CompactKgPropertyValue. | list(String) | |
| propertyName | The property corresponding to predicte_encoded_mid above. This is populated in some non-serving tables. | RepositoryWebrefCompactFlatPropertyValue | Flattened version of possibly nested compound values. This means that the `value` in here is *never* a `compound_value` and all predicate MIDs on the nested path are collapsed into the repeated `predicate_encoded_mid` field. When `predicate_encoded_mid` contains only one predicate, this is equivalent to a CompactKgPropertyValue. | String |
| value | RepositoryWebrefCompactFlatPropertyValue | Flattened version of possibly nested compound values. This means that the `value` in here is *never* a `compound_value` and all predicate MIDs on the nested path are collapsed into the repeated `predicate_encoded_mid` field. When `predicate_encoded_mid` contains only one predicate, this is equivalent to a CompactKgPropertyValue. | list(RepositoryWebrefCompactKgValue) | |
| encodedMid | RepositoryWebrefCompactKgPropertyValue | Analog to freebase::PropertyValue | String | |
| hrid | RepositoryWebrefCompactKgPropertyValue | Analog to freebase::PropertyValue | String | |
| value | RepositoryWebrefCompactKgPropertyValue | Analog to freebase::PropertyValue | list(RepositoryWebrefCompactKgValue) | |
| valueStatus | RepositoryWebrefCompactKgPropertyValue | Analog to freebase::PropertyValue | String | |
| mid | Mid of the topic; only filled in if no values. | RepositoryWebrefCompactKgTopic | Analog to freebase::Topic | String |
| propertyValue | RepositoryWebrefCompactKgTopic | Analog to freebase::Topic | list(RepositoryWebrefCompactKgPropertyValue) | |
| boolValue | Present when value is bool. | RepositoryWebrefCompactKgValue | Analog to freebase::Value TODO(b/144526840) This representation has several quality and performance issues. Next available tag number: 12 | boolean |
| compoundValue | Compound values are those that contain either a number of simple valued facets (such as a latitude/longitude pair), or “mediator” topics representing multi-dimensional relationships between topics. See metaweb/data/topictable/topic.proto for more details. | RepositoryWebrefCompactKgValue | Analog to freebase::Value TODO(b/144526840) This representation has several quality and performance issues. Next available tag number: 12 | RepositoryWebrefCompactKgTopic |
| datetimeValue | Present when value is datetime. | RepositoryWebrefCompactKgValue | Analog to freebase::Value TODO(b/144526840) This representation has several quality and performance issues. Next available tag number: 12 | String |
| enumValue | Present when value is enum. | RepositoryWebrefCompactKgValue | Analog to freebase::Value TODO(b/144526840) This representation has several quality and performance issues. Next available tag number: 12 | String |
| floatValue | Present when value is float. | RepositoryWebrefCompactKgValue | Analog to freebase::Value TODO(b/144526840) This representation has several quality and performance issues. Next available tag number: 12 | float |
| idValue | Present when value is an id. | RepositoryWebrefCompactKgValue | Analog to freebase::Value TODO(b/144526840) This representation has several quality and performance issues. Next available tag number: 12 | String |
| intValue | Present when value is int. | RepositoryWebrefCompactKgValue | Analog to freebase::Value TODO(b/144526840) This representation has several quality and performance issues. Next available tag number: 12 | String |
| serializedProtoValue | Present when value is a serialized protocol buffer. | RepositoryWebrefCompactKgValue | Analog to freebase::Value TODO(b/144526840) This representation has several quality and performance issues. Next available tag number: 12 | String |
| textValue | Present when value is text. | RepositoryWebrefCompactKgValue | Analog to freebase::Value TODO(b/144526840) This representation has several quality and performance issues. Next available tag number: 12 | String |
| uriValue | Present when value is URI. | RepositoryWebrefCompactKgValue | Analog to freebase::Value TODO(b/144526840) This representation has several quality and performance issues. Next available tag number: 12 | String |
| uriValueFprint32 | 32-bit fprint of uri. Can be used instead of `uri_value` to save space. See `GetNormalizedUriFprint32()`. | RepositoryWebrefCompactKgValue | Analog to freebase::Value TODO(b/144526840) This representation has several quality and performance issues. Next available tag number: 12 | integer |
| debugEntity | Optionally the freebase_mid of the WebrefEntity which the Component identifies via entity_index. This is purely to help humans diagnose the WebrefEntities structure, may not always be present and should not be used by production code. Use QueryJoinToMeaningStructConverter to compose a proper value in place of the component reference. | RepositoryWebrefComponentReference | The ArgumentValue reference to Mention.CompoundMention.Component. Next available tag number: 4 | String |
| funcallName | The WebrefEntity referenced by `index` is equivalent to this function call in this context, but not universally such that we don’t want to recursively expand its MRF. Use this for example if an entity corresponds to a category in an Intersect: CellPhones() & RelatedTo(/m/foo), where /m/cell_phones is equivalent to CellPhones() (and may or may not have an annotated span), but we don’t want to generally assert that /m/cell_phones == CellPhones(). This cannot be an actual FunctionCall to avoid a circular dependency. | RepositoryWebrefComponentReference | The ArgumentValue reference to Mention.CompoundMention.Component. Next available tag number: 4 | String |
| index | The index of the Component of the CompoundMention which has the mrf_index of this MRF expression in WebrefEntity. Required. | RepositoryWebrefComponentReference | The ArgumentValue reference to Mention.CompoundMention.Component. Next available tag number: 4 | integer |
| nameTypeMask | Bitfield of ConceptNameMetadata::NameType bits. | RepositoryWebrefConceptNameMetadata | Metadata proto to be stored in concept tables. Note: Name table only stores name_type_mask for better performance. Remember to change NameToConceptEntry if you add a field to this proto. Note: in the annotator output only URL and PHONE_NUMBER are populated. | String |
| connectedness | Represents how much the entity is connected/related to the other entities in the document. This signal partially influences the topicality score, but it is not totally aligned with it: an entity can be very related to the rest of the document, but not central for understanding it. Likewise, an entity can be central to understand a document, but not very related to the rest of the document. The value is in [0, 1]. | RepositoryWebrefDetailedEntityScores | Detailed scores about the topicality of an entity. Next available tag: 17 | number |
| docScore | How well the document scores for the entity. The score is unnormalized, and serves as a relative ranking signal between different documents for an entity. | RepositoryWebrefDetailedEntityScores | Detailed scores about the topicality of an entity. Next available tag: 17 | number |
| isAuthor | True if the entity is the author of the document. This was mainly developed and tuned for news articles (e.g. /m/02x27qn on “www.vogue.com/article/flint-town-netflix”) but is also popluated for other content (e.g. scientific articles). Important: the semantics of this field may change in the future or it might be removed and replaced with a different API. If you want to use this field, please reach out to ke-authors@ first. | RepositoryWebrefDetailedEntityScores | Detailed scores about the topicality of an entity. Next available tag: 17 | boolean |
| isPublisher | True if the entity is the publisher of the page (e.g. CNN on “http://www.cnn.com/foo/bar”). | RepositoryWebrefDetailedEntityScores | Detailed scores about the topicality of an entity. Next available tag: 17 | boolean |
| isReferencePage | Set to true iff the entity matches the full URL of the document, meaning that it is a reference page or related page of the entity. | RepositoryWebrefDetailedEntityScores | Detailed scores about the topicality of an entity. Next available tag: 17 | boolean |
| normalizedTopicality | Representation of the topicality score that is normalized in [0, 1] and which sum over all entities in the document is 1. It represents the “proportion” of the document that talks about the entity. This score is less human interpretable as the bucketized topicality score (EntityAnnotations.topicality_score), but is more suited for some usages like aggregations. | RepositoryWebrefDetailedEntityScores | Detailed scores about the topicality of an entity. Next available tag: 17 | number |
| profileUrl | Contains the link to the author’s profile url on the platform. | RepositoryWebrefDetailedEntityScores | Detailed scores about the topicality of an entity. Next available tag: 17 | String |
| referencePageScores | Signals used for mining new reference pages, set by the reference-page-scorer processor (that is turned off by default). This field is not populated, except for special reference page extraction runs. | RepositoryWebrefDetailedEntityScores | Detailed scores about the topicality of an entity. Next available tag: 17 | RepositoryWebrefReferencePageScores |
| relevanceScore | Relevance score generated by a Machine Learning entity classifier. This signal is similar to topicality, but machine learning based and supported by EntitySignals, not Webref. See http://go/entityclassifier for details on the classifier. | RepositoryWebrefDetailedEntityScores | Detailed scores about the topicality of an entity. Next available tag: 17 | number |
| resultEntityScore | How much support this mention received from the results for PostRef. This is populated only if explicitly requested and different from 0. | RepositoryWebrefDetailedMentionScores | number | |
| displayName | Per language display name from reliable sources. | RepositoryWebrefDisplayInfo | Information that can be used to display the entity (e.g. title, image…). | list(RepositoryWebrefDisplayName) |
| canonicalName | An encylopedia style topic name (e.g. “Dog”, not “Dogs”). Corresponds to Freebase /type/object/name and similar sources. | RepositoryWebrefDisplayName | Per language display name from reliable sources (e.g. Freebase, Wikipedia). The name can be ambiguous (e.g. “Springfield” rather than “Springfield, Idaho”), and is thus to be used in a context which provides sufficient disambiguation. See: http://go/entity-names WARNING: This data is DEPRECATED and any user-visible entity names need to be fetched from TopicServer. Note that any display names included in this proto are merely a pass-through from KG and have no freshness guarantees. | String |
| language | The language of this name. See http://goto/iii for all the details on the language identifiers. | RepositoryWebrefDisplayName | Per language display name from reliable sources (e.g. Freebase, Wikipedia). The name can be ambiguous (e.g. “Springfield” rather than “Springfield, Idaho”), and is thus to be used in a context which provides sufficient disambiguation. See: http://go/entity-names WARNING: This data is DEPRECATED and any user-visible entity names need to be fetched from TopicServer. Note that any display names included in this proto are merely a pass-through from KG and have no freshness guarantees. | String |
| subjectName | A name as it would be used for a news topic, an interest, the subject of a story. E.g. in list of things (“Related topics: Smartphones, computers, accidents”. “Interests: Dogs”). *Fall back:* If the field is not populated, fall back to the “canonical_name” field. This field is usually not populated since (a) in most cases the subject form name is the same as the canonical name, and (b) data coverage of subject-form names is currently much lower than data coverage of canonical names. Note: In some languages (e.g. French) the difference between canonical names and subject names is larger than in English (not just plural vs. singular), but still strictly grammatical (including an article, capitalization, plural vs. singular). Corresponds to Freebase /freebase/linguistic_hint/subject_form. | RepositoryWebrefDisplayName | Per language display name from reliable sources (e.g. Freebase, Wikipedia). The name can be ambiguous (e.g. “Springfield” rather than “Springfield, Idaho”), and is thus to be used in a context which provides sufficient disambiguation. See: http://go/entity-names WARNING: This data is DEPRECATED and any user-visible entity names need to be fetched from TopicServer. Note that any display names included in this proto are merely a pass-through from KG and have no freshness guarantees. | String |
| perDocRelevanceRatings | RepositoryWebrefDocLevelRelevanceRatings | List of PerDocRelevanceRatings for Precision@5 evals done via ewok (template 2282). | list(RepositoryWebrefPerDocRelevanceRatings) | |
| crawlTime | The timestamp of when the document was crawled (if known). Copied from CompositeDoc.Content.CrawlTime. | RepositoryWebrefDocumentMetadata | Information about the document which is not produced by webref, typically copied from the docjoin. Next available tag: 15 | String |
| docFp | Fingerprint of the document. We compute and set this fingerprint when creating the pagesets that we use for evals. Otherwise, this field is not normally set. We use the field to make sure that the human ratings that we have are generated for the same version of the document, otherwise they might be invalid. We do not compute the fingerprint on the fly (e.g. as a fingerprint of the proto buffer serialization of the cdoc) because protocol buffer serialization is not stable. | RepositoryWebrefDocumentMetadata | Information about the document which is not produced by webref, typically copied from the docjoin. Next available tag: 15 | String |
| docId | DocId of the annotated document as read from cdoc.doc().docid(). | RepositoryWebrefDocumentMetadata | Information about the document which is not produced by webref, typically copied from the docjoin. Next available tag: 15 | String |
| forwardingUrls | Urls that forward to this url. Needed for url -> topical entity entries. | RepositoryWebrefDocumentMetadata | Information about the document which is not produced by webref, typically copied from the docjoin. Next available tag: 15 | RepositoryWebrefForwardingUrls |
| isDisambiguationPage | Set to true if the document is a known disambiguation page, e.g. https://en.wikipedia.org/wiki/Orange. | RepositoryWebrefDocumentMetadata | Information about the document which is not produced by webref, typically copied from the docjoin. Next available tag: 15 | boolean |
| language | The document language, as read from doc().content().language(). This is go/language-enum value. | RepositoryWebrefDocumentMetadata | Information about the document which is not produced by webref, typically copied from the docjoin. Next available tag: 15 | String |
| numIncomingAnchors | The (weighted) number of incoming anchors (links from other documents). | RepositoryWebrefDocumentMetadata | Information about the document which is not produced by webref, typically copied from the docjoin. Next available tag: 15 | number |
| salientTerms | The salient terms for this document. Only set if –webref_doc_metadata_copy_salient_terms is true. Same motivation as the title field above. | RepositoryWebrefDocumentMetadata | Information about the document which is not produced by webref, typically copied from the docjoin. Next available tag: 15 | QualitySalientTermsSalientTermSet |
| title | The title of the document. Only set if –webref_doc_metadata_set_title is true. The idea is that we can use this to more easily learn things like: title contains “restaurants” -> more likely to be a list page. | RepositoryWebrefDocumentMetadata | Information about the document which is not produced by webref, typically copied from the docjoin. Next available tag: 15 | String |
| totalClicks | The total clicks on this document, taken from navboost data. | RepositoryWebrefDocumentMetadata | Information about the document which is not produced by webref, typically copied from the docjoin. Next available tag: 15 | number |
| url | The url of the document. | RepositoryWebrefDocumentMetadata | Information about the document which is not produced by webref, typically copied from the docjoin. Next available tag: 15 | String |
| entityData | The actual domain specific data. For example it can be freebase.Topic, repository_wikipedia.WikiJoin, ocean.WorkMetadata, geostore.Feature. | RepositoryWebrefDomainSpecificRepresentation | Represents a domain specific entity data. | Proto2BridgeMessageSet |
| nonMidProperties | Contains selected properties (from KG) whose values are not other entities (in which case they would be represented in link_info) but scalar values, possibly reachable through (multiple) CVTs. | RepositoryWebrefEnricherDebugData | Top level proto for enricher specific debug data that is only displayed in the Webref demo and should not be used for anything production-related. Next id: 4. | list(RepositoryWebrefCompactFlatPropertyValue) |
| referencePage | This field contains reference pages for this entity. A reference page is a page that is highly topical for this entity, which can be used to mine additional information about this entity. Example reference pages for Apple Inc. would be the composite docs for “http://en.wikipedia.org/wiki/Apple_Inc.” and http://www.apple.com. For actors or movies, you can also have the imdb page. Also see: http://go/refx-pages. | RepositoryWebrefEnricherDebugData | Top level proto for enricher specific debug data that is only displayed in the Webref demo and should not be used for anything production-related. Next id: 4. | list(RepositoryWebrefSimplifiedCompositeDoc) |
| relatedPage | This field contains mined related pages for the entity. A related page is a page that is moderately topical for this entity (More details: http://shortn/_KCE0GfQlpJ). This is mainly used to mine additional information for entities which do not have reference pages Unlike reference pages, a single doc can be a related page for multiple mids. | RepositoryWebrefEnricherDebugData | Top level proto for enricher specific debug data that is only displayed in the Webref demo and should not be used for anything production-related. Next id: 4. | list(RepositoryWebrefSimplifiedCompositeDoc) |
| confidenceScore | The overall confidence that the entity is annotated somewhere in the document or query. For WebRef it is computed as a function of the mention confidences weighted by the importance of each mention, where for documents a mention is of greater importance if it occurs in the title, h1 or anchors. For QRef it is just the maximum of the confidence over all mentions. NOTE: You probably want to use the mention-level segment_mentions.mention.confidence_score field instead of this one. | RepositoryWebrefEntityAnnotations | All annotations for a given concept (in one document collection). Available tags: [10-15], [19-] | number |
| debugInfo | RepositoryWebrefEntityAnnotations | All annotations for a given concept (in one document collection). Available tags: [10-15], [19-] | RepositoryWebrefAnnotationDebugInfo | |
| detailedEntityScores | Additional information about how the entity relates to the page, for example whether it is a business entity which published the page. | RepositoryWebrefEntityAnnotations | All annotations for a given concept (in one document collection). Available tags: [10-15], [19-] | RepositoryWebrefDetailedEntityScores |
| explainedRangeInfo | All ranges explained by the entity or any other entity it implies. Used in the context of partial query interpretation (go/partial-understanding). | RepositoryWebrefEntityAnnotations | All annotations for a given concept (in one document collection). Available tags: [10-15], [19-] | RepositoryWebrefExplainedRangeInfo |
| imageMention | This is an experimental output for go/multiref. Don’t use it without consulting the Webref team | RepositoryWebrefEntityAnnotations | All annotations for a given concept (in one document collection). Available tags: [10-15], [19-] | list(RepositoryWebrefImageMention) |
| isImplicit | An entity is marked as implicit if there is no explicit mention of the entity in the content of the page. For instance, all mentions of the entity are in query, url and/or anchors; or the entity has only implicit content mentions. | RepositoryWebrefEntityAnnotations | All annotations for a given concept (in one document collection). Available tags: [10-15], [19-] | boolean |
| isResolution | True if the entity is an MDVC summary entity, i.e. it might not be mentioned directly on the query, but it is the product of resolving a set of explicit annotations. E.g. “2014 FIFA World Cup” can be the summary for the query: [soccer world cup in brazil] even though none of the names of the entity is mentioned on the query. Summary nodes can also be synthetic, i.e. have a /t/ mid, as they represent the intersection between a set of regular annotations. For more information, see http://go/mdvc-output. | RepositoryWebrefEntityAnnotations | All annotations for a given concept (in one document collection). Available tags: [10-15], [19-] | boolean |
| segmentMentions | All mentions of a given concept grouped by segments. For Webref, there are many different kinds of segment, such as content, title and anchors; while for QRef, there is only one segment called CONTENT. For QRef this field contains the primary output of the annotator, and for WebRef it together with topicality_score does. | RepositoryWebrefEntityAnnotations | All annotations for a given concept (in one document collection). Available tags: [10-15], [19-] | list(RepositoryWebrefSegmentMentions) |
| topicalityRank | Rank of the entity when sorted by topicality score. | RepositoryWebrefEntityAnnotations | All annotations for a given concept (in one document collection). Available tags: [10-15], [19-] | integer |
| topicalityScore | The WebRef topicality score of the entity for this document. This score indicates how related is the entity to the overall topic of the document. See https://goto.google.com/topicality-score for details. This field is not present in QRef output. Note that the topicality and the confidence score are orthogonal measures. It is possible that the annotator is absolutely sure that an entity is mentioned in a given range in the document, but this entity may be unrelated to the overall topic of the page (e.g. the entity “RSS” is mentioned in the footer of appleinsider.com). In this case the mention has a very high confidence score, but very low topicality score. | RepositoryWebrefEntityAnnotations | All annotations for a given concept (in one document collection). Available tags: [10-15], [19-] | number |
| description | A human-readable description of the entity. This can range from brief, machine-generated notes to lengthy human-written paragraphs from Wikipedia. | RepositoryWebrefEntityDebugInfo | Provides some debug info for the entity. This data shown to engineers (for debugging) and to raters (so it ultimately impacts eval metrics), but is also used to train ML models (see below). IMPORTANT: Despite the proto naming, this data has production quality impact. The data below is mostly human-readable text that is useful to help engineers with debugging. However the text is also used as input to machine-learned natural language processing models, which are used in production Webref. | String |
| language | The language (III LanguageCode) of the `title` and `description` fields. | RepositoryWebrefEntityDebugInfo | Provides some debug info for the entity. This data shown to engineers (for debugging) and to raters (so it ultimately impacts eval metrics), but is also used to train ML models (see below). IMPORTANT: Despite the proto naming, this data has production quality impact. The data below is mostly human-readable text that is useful to help engineers with debugging. However the text is also used as input to machine-learned natural language processing models, which are used in production Webref. | String |
| score | Internal score to merge debug info. should not set in final entityjoins. | RepositoryWebrefEntityDebugInfo | Provides some debug info for the entity. This data shown to engineers (for debugging) and to raters (so it ultimately impacts eval metrics), but is also used to train ML models (see below). IMPORTANT: Despite the proto naming, this data has production quality impact. The data below is mostly human-readable text that is useful to help engineers with debugging. However the text is also used as input to machine-learned natural language processing models, which are used in production Webref. | float |
| title | A short human-readable name/title of the entity, similar to what is displayed at the top of a Hume page. Suitable to be displayed in a list. | RepositoryWebrefEntityDebugInfo | Provides some debug info for the entity. This data shown to engineers (for debugging) and to raters (so it ultimately impacts eval metrics), but is also used to train ML models (see below). IMPORTANT: Despite the proto naming, this data has production quality impact. The data below is mostly human-readable text that is useful to help engineers with debugging. However the text is also used as input to machine-learned natural language processing models, which are used in production Webref. | String |
| url | Link to a page with more information about the entity (internal Hume page, external Wikipedia page, etc.). | RepositoryWebrefEntityDebugInfo | Provides some debug info for the entity. This data shown to engineers (for debugging) and to raters (so it ultimately impacts eval metrics), but is also used to train ML models (see below). IMPORTANT: Despite the proto naming, this data has production quality impact. The data below is mostly human-readable text that is useful to help engineers with debugging. However the text is also used as input to machine-learned natural language processing models, which are used in production Webref. | String |
| annotatedEntityId | The id of this entity, prefer accessing through webref-entities-util.h functions. | RepositoryWebrefEntityJoin | Next available tag: 35. Represents all the information that we have for a given entity. | RepositoryWebrefWebrefEntityId |
| cdoc | This field contains reference pages for this entity. A reference page is a page that is highly topical for this entity, which can be used to mine additional information about this entity. Example reference pages for Apple Inc. would be the composite docs for “http://en.wikipedia.org/wiki/Apple_Inc.” and http://www.apple.com. For actors or movies, you can also have the imdb page. Also see: http://go/refx-pages. | RepositoryWebrefEntityJoin | Next available tag: 35. Represents all the information that we have for a given entity. | list(RepositoryWebrefSimplifiedCompositeDoc) |
| contextNameInfo | The context names (with scores) of this entity. The difference to regular names (aka name_info) is that context names are not used for finding mentions in a document as they consist of names somehow related to the entity (e.g. name “fisherman s wharf” for the entity “Gary Danko”). Used for reconciling freebase and oyster. | RepositoryWebrefEntityJoin | Next available tag: 35. Represents all the information that we have for a given entity. | list(RepositoryWebrefGlobalNameInfo) |
| debugInfo | Debug information about the entity. | RepositoryWebrefEntityJoin | Next available tag: 35. Represents all the information that we have for a given entity. | list(RepositoryWebrefEntityDebugInfo) |
| enricherAnnotatorProfile | Optional profiling data from the enricher that enriched this entity (and produced this EntityJoin as debug output). | RepositoryWebrefEntityJoin | Next available tag: 35. Represents all the information that we have for a given entity. | RepositoryWebrefAnnotatorProfile |
| enricherDebugData | Contains debug data produced by enricher and only used for debug purpose (e.g. demo). | RepositoryWebrefEntityJoin | Next available tag: 35. Represents all the information that we have for a given entity. | RepositoryWebrefEnricherDebugData |
| extraData | Additional metadata about the entity, that can be derived from the “raw data” (composite doc, domain specific data…), or come from other sources. Despite its name, this field often contains quite important information. | RepositoryWebrefEntityJoin | Next available tag: 35. Represents all the information that we have for a given entity. | RepositoryWebrefExtraMetadata |
| humanRatings | Human ratings (e.g. ratings from EWOK). This is typically only populated in the evaluation pipelines (e.g. P@5). | RepositoryWebrefEntityJoin | Next available tag: 35. Represents all the information that we have for a given entity. | RepositoryWebrefHumanRatings |
| linkInfo | Contains all links (with scores) that Webref knows for this entity. Links are relationships between entities. The data in this field is very important for the quality of the model. | RepositoryWebrefEntityJoin | Next available tag: 35. Represents all the information that we have for a given entity. | list(RepositoryWebrefGlobalLinkInfo) |
| nameInfo | Contains all names (with scores) that Webref knows for this entity. The data in this field is very important for the quality of the model. | RepositoryWebrefEntityJoin | Next available tag: 35. Represents all the information that we have for a given entity. | list(RepositoryWebrefGlobalNameInfo) |
| refconNameInfo | Contains names and names metadata used by Refcon. | RepositoryWebrefEntityJoin | Next available tag: 35. Represents all the information that we have for a given entity. | list(RepositoryWebrefRefconRefconNameInfo) |
| representation | An entity can have metadata from various data sources. Generally speaking all sources will be / should be reconciled into a single KG Topic entry. However, in some cases we pull in additional chunks of metadata from these sources; these are stored in this field. For example a local business could have a KG entry (topic proto), wikipedia entry (WikiJoin) and a MapFacts entry (Feature proto). | RepositoryWebrefEntityJoin | Next available tag: 35. Represents all the information that we have for a given entity. | list(RepositoryWebrefDomainSpecificRepresentation) |
| aggregateFlags | The aggregate kind flags for the link. | RepositoryWebrefEntityLinkMetadata | Metadata about the nature of the link. | RepositoryWebrefLinkKindFlags |
| kindInfo | Information about all the link kinds associated with the link. | RepositoryWebrefEntityLinkMetadata | Metadata about the nature of the link. | list(RepositoryWebrefLinkKindInfo) |
| kgProperty | KG-property if the SourceType is associated with a KG-property (TOPIC_PROPERTY, NEW_TOPIC_PROPERTY). | RepositoryWebrefEntityLinkSource | All link data for a given source. | String |
| score | Score in [0, \\infty) that represents how relatively likely it is to see that entity cooccurring with the main entity (in the entity join). A value of 1.0 means that the two entities are basically independent. The higher the more likely (relatively to the individual entity probabilities) they are to cooccur. | RepositoryWebrefEntityLinkSource | All link data for a given source. | number |
| type | RepositoryWebrefEntityLinkSource | All link data for a given source. | String | |
| language | RepositoryWebrefEntityNameRatings | Stores all human ratings collected for a given entity name. | String | |
| name | RepositoryWebrefEntityNameRatings | Stores all human ratings collected for a given entity name. | String | |
| ratings | Every entity name receives one or a few ratings from human raters. | RepositoryWebrefEntityNameRatings | Stores all human ratings collected for a given entity name. | list(RepositoryWebrefEntityNameRatingsEntityNameRating) |
| tags | Multiple tags can be assigned to a rated entity name. The tags can be used when computing metrics in the Name Eval, so that different metrics are computed separately for different sets of examples that have the same tag. | RepositoryWebrefEntityNameRatings | Stores all human ratings collected for a given entity name. | list(String) |
| comment | Comment left by the rater to justify the rating decision. | RepositoryWebrefEntityNameRatingsEntityNameRating | String | |
| label | RepositoryWebrefEntityNameRatingsEntityNameRating | String | ||
| source | RepositoryWebrefEntityNameRatingsEntityNameRating | String | ||
| bootstrappingPreviousIteration | If the EntityNameScore is part of a bootstrapped model, then this field contains the score_ratio from the previous model (“Model 0”). If Model 0 does not have a corresponding entry, because it did not know about this name for this entity, then bootstrapping_previous_iteration is left empty. | RepositoryWebrefEntityNameScore | Represents a score for an entity. Next available tag: 39. | RepositoryWebrefBootstrappingScore |
| confidence | Confidence that this name is a trusted name of the entity. A reasonable threshold for name trust is 0.6. A name can be trusted and still have very low score_ratio, esp. if it is ambiguous (e.g. ‘mercury’) and/or not the dominant interpretation (e.g. “siberian husky” -> /m/06krnsr (a book)). | RepositoryWebrefEntityNameScore | Represents a score for an entity. Next available tag: 39. | number |
| debugInfo | Debug information about the entity. | RepositoryWebrefEntityNameScore | Represents a score for an entity. Next available tag: 39. | list(RepositoryWebrefEntityDebugInfo) |
| debugVariantSignals | Source and score data, this is internal to refx (e.g. for demo/debug). | RepositoryWebrefEntityNameScore | Represents a score for an entity. Next available tag: 39. | list(RepositoryWebrefPreprocessingNameVariantSignals) |
| extendedScoreRatio | Stores region specific score ratios for the entity when it is significantly different from the language version above. | RepositoryWebrefEntityNameScore | Represents a score for an entity. Next available tag: 39. | list(RepositoryWebrefExtendedEntityNameScore) |
| includeInModel | Include this name in the name lookup table. | RepositoryWebrefEntityNameScore | Represents a score for an entity. Next available tag: 39. | boolean |
| internalBootstrapIsOpenWorld | Transient field, only used in bootstrap pipeline. | RepositoryWebrefEntityNameScore | Represents a score for an entity. Next available tag: 39. | boolean |
| internalIsClusterParent | RepositoryWebrefEntityNameScore | Represents a score for an entity. Next available tag: 39. | boolean | |
| isClusterGlobal | Set to true iff the concept is cluster parent and the name can be a name for any child of the cluster. (e.g. ‘starbucks’ is cluster_global for the [Starbucks] chain cluster). | RepositoryWebrefEntityNameScore | Represents a score for an entity. Next available tag: 39. | boolean |
| isDropped | Documented at: google3/repository/webref/enricher/core/data/scored_entity_name.h | RepositoryWebrefEntityNameScore | Represents a score for an entity. Next available tag: 39. | boolean |
| isMatchlessResultContext | Only for context names: Whether this EntityNameScore represents an entity that was dominant in the search results but was not annotated by QRef during learning. Matchless result contexts are useful for bootstrapping, where different model iterations may have different names and thus context scores from Model 0 that are inconsistent with the names from Model 1. | RepositoryWebrefEntityNameScore | Represents a score for an entity. Next available tag: 39. | boolean |
| isPruned | Documented at: google3/repository/webref/enricher/core/data/scored_entity_name.h | RepositoryWebrefEntityNameScore | Represents a score for an entity. Next available tag: 39. | boolean |
| mid | The id of the entity. | RepositoryWebrefEntityNameScore | Represents a score for an entity. Next available tag: 39. | String |
| nameMetadata | Metadata about this name aggregated from name signals. | RepositoryWebrefEntityNameScore | Represents a score for an entity. Next available tag: 39. | RepositoryWebrefPreprocessingNameEntityMetadata |
| rangeMetadata | Metadata of segment range, which is annotated by this entity. | RepositoryWebrefEntityNameScore | Represents a score for an entity. Next available tag: 39. | list(RepositoryWebrefRangeMetadata) |
| score | The absolute score of that entity. score = artificial_score + volume_based_score | RepositoryWebrefEntityNameScore | Represents a score for an entity. Next available tag: 39. | number |
| scoreRatio | Ratio between this entity score and the total score over all entities. This is including the “open world” information if it was estimated. | RepositoryWebrefEntityNameScore | Represents a score for an entity. Next available tag: 39. | number |
| useAsNameCandidate | When this field is true, we consider this context name as candidate in Enricher’s names pipeline. | RepositoryWebrefEntityNameScore | Represents a score for an entity. Next available tag: 39. | boolean |
| volumeBasedScore | Absolute score that comes from quantitative sources such as navboost clicks, anchors, etc. artificial_score = score – volume_based_score | RepositoryWebrefEntityNameScore | Represents a score for an entity. Next available tag: 39. | number |
| entityScore | All the entity-name scores from that source. Keyed by the EntityNameScore.entity_id field. | RepositoryWebrefEntityNameSource | Represents the data for a given source of names, including all entity scores. Notice that a source of name can be just a signal like a multiplier. Next available tag: 8. | list(RepositoryWebrefEntityNameScore) |
| type | Describes where the data comes from. | RepositoryWebrefEntityNameSource | Represents the data for a given source of names, including all entity scores. Notice that a source of name can be just a signal like a multiplier. Next available tag: 8. | String |
| alphaEntityIdf | This field is only for debugging and link weight experiments. It stores the entity’s idf from the alpha model. Alpha idfs are used for link weight computations and available during model omega building via enricher_current_entity_idf_for_link_direction. | RepositoryWebrefEntityScores | Keeps a set of scores about an entity. Next available tag: 20. | number |
| commonNgramProb | Probability that the entity is a common ngram (e.g. from dictionary). | RepositoryWebrefEntityScores | Keeps a set of scores about an entity. Next available tag: 20. | number |
| entityIdf | The final (model omega) idf of an entity. Equals log2(1 / probability of the entity to appear in a document). This probability is currently estimated from its names (i.e. it is a sum of the name frequency weighted by P(entity | name)). | RepositoryWebrefEntityScores | Keeps a set of scores about an entity. Next available tag: 20. | number |
| nameCapitalizationProb | The following field is deprecated and should eventually be removed. It uses data and rules that have not been refreshed for ~10y and KG has changed a lot in the meantime. | RepositoryWebrefEntityScores | Keeps a set of scores about an entity. Next available tag: 20. | number |
| explainedRange | All ranges explained by the entity. | RepositoryWebrefExplainedRangeInfo | Information about all ranges explained by the entity or any other entity it implies. For example, the Zurich entity may explain both tokens “Zurich” and “Switzerland” in [FIFA Zurich Switzerland], the first directly, the other via implication. Only used in the context of query annotation. | list(RepositoryWebrefExplainedRangeInfoExplainedRange) |
| geoQueryCoverage | RepositoryWebrefExplainedRangeInfo | Information about all ranges explained by the entity or any other entity it implies. For example, the Zurich entity may explain both tokens “Zurich” and “Switzerland” in [FIFA Zurich Switzerland], the first directly, the other via implication. Only used in the context of query annotation. | String | |
| mention | SegmentMention describing the occurrence of the token in the document. | RepositoryWebrefExplainedRangeInfoExplainedRange | A range of the annotated document explained by an entity. | RepositoryWebrefSegmentMention |
| domain | The domain name of the website, e.g. “play.google.com”. | RepositoryWebrefExtendedEntityNameScore | Used to store region-specific score ratio per entity. Next available tag: 4. | String |
| region | The region in the III standard (http://go/iii). Eg. “US”, “GB” | RepositoryWebrefExtendedEntityNameScore | Used to store region-specific score ratio per entity. Next available tag: 4. | String |
| scoreRatio | Score ratio for the entity, same as the EntityNameScore score ratio. | RepositoryWebrefExtendedEntityNameScore | Used to store region-specific score ratio per entity. Next available tag: 4. | number |
| bookEditionMetadata | For a book entity, store its book editions metadata. Used by Juggernaut to do /book/book_edition recon, see ariane/265006. This field is used by Juggernaut only. | RepositoryWebrefExtraMetadata | Additional metadata about the entity, that can be derived from the “raw data” (composite doc, domain specific data…), or come from other sources. Next available tag is 35. | list(RepositoryWebrefBookEditionMetadata) |
| categoryInfo | Information about category types of the entity. | RepositoryWebrefExtraMetadata | Additional metadata about the entity, that can be derived from the “raw data” (composite doc, domain specific data…), or come from other sources. Next available tag is 35. | RepositoryWebrefCategoryInfo |
| clusterMetadata | Metadata about clusters. | RepositoryWebrefExtraMetadata | Additional metadata about the entity, that can be derived from the “raw data” (composite doc, domain specific data…), or come from other sources. Next available tag is 35. | RepositoryWebrefClusterMetadata |
| displayInfo | Information for displaying the entity in applications. | RepositoryWebrefExtraMetadata | Additional metadata about the entity, that can be derived from the “raw data” (composite doc, domain specific data…), or come from other sources. Next available tag is 35. | RepositoryWebrefDisplayInfo |
| entityScores | Additional scores for the entity. | RepositoryWebrefExtraMetadata | Additional metadata about the entity, that can be derived from the “raw data” (composite doc, domain specific data…), or come from other sources. Next available tag is 35. | RepositoryWebrefEntityScores |
| equivalentEntityId | An entity in KG that represents the same (or equivalent) entity in the real world. In particular, this is used for mid-forwarding: when de-duping entities in KG, the old ids represent the exact same entity as the one they were merged with. So when we see one id in the query and the other in a document, they are treated as the same entity. | RepositoryWebrefExtraMetadata | Additional metadata about the entity, that can be derived from the “raw data” (composite doc, domain specific data…), or come from other sources. Next available tag is 35. | list(RepositoryWebrefWebrefEntityId) |
| geoMetadata | Geo-specific entity metadata. | RepositoryWebrefExtraMetadata | Additional metadata about the entity, that can be derived from the “raw data” (composite doc, domain specific data…), or come from other sources. Next available tag is 35. | RepositoryWebrefGeoMetadataProto |
| kcAttributeMetadata | Metadata related to KC attributes and Question & Answer triggering. | RepositoryWebrefExtraMetadata | Additional metadata about the entity, that can be derived from the “raw data” (composite doc, domain specific data…), or come from other sources. Next available tag is 35. | RepositoryWebrefKCAttributeMetadata |
| latentEntities | A list of entities that are latent given this entity. For example, “Lionel Messi” can have the latent entity “FC Barcelona”. The latent entity links are materialized in an offline pipeline using r/w/scripts/latent_entities/latent-entities.pq. For more information, see go/latent-entities. | RepositoryWebrefExtraMetadata | Additional metadata about the entity, that can be derived from the “raw data” (composite doc, domain specific data…), or come from other sources. Next available tag is 35. | RepositoryWebrefLatentEntities |
| mdvcMetadata | Metadata about MDVC. | RepositoryWebrefExtraMetadata | Additional metadata about the entity, that can be derived from the “raw data” (composite doc, domain specific data…), or come from other sources. Next available tag is 35. | RepositoryWebrefMdvcMetadata |
| otherMetadata | Other metadata. | RepositoryWebrefExtraMetadata | Additional metadata about the entity, that can be derived from the “raw data” (composite doc, domain specific data…), or come from other sources. Next available tag is 35. | Proto2BridgeMessageSet |
| primaryRecording | The primary recording mid of a recording cluster entity. Used by Juggernaut to do /music/recording recon, see b/139901317. The primary recording is unique to a recording cluster. This field is used by Juggernaut only. | RepositoryWebrefExtraMetadata | Additional metadata about the entity, that can be derived from the “raw data” (composite doc, domain specific data…), or come from other sources. Next available tag is 35. | String |
| productMetadata | Products-specific entity metadata. Only available in QrefMetadata output. | RepositoryWebrefExtraMetadata | Additional metadata about the entity, that can be derived from the “raw data” (composite doc, domain specific data…), or come from other sources. Next available tag is 35. | RepositoryWebrefProductMetadata |
| specialEntityType | # LINT.ThenChange( //depot/google3/repository/webref/evaluation/query/metrics/util.cc) | RepositoryWebrefExtraMetadata | Additional metadata about the entity, that can be derived from the “raw data” (composite doc, domain specific data…), or come from other sources. Next available tag is 35. | String |
| specialWord | RepositoryWebrefExtraMetadata | Additional metadata about the entity, that can be derived from the “raw data” (composite doc, domain specific data…), or come from other sources. Next available tag is 35. | list(MapsQualitySpecialWordsProto) | |
| supportTransferRules | Metadata about support transfer rules defined for this entity. | RepositoryWebrefExtraMetadata | Additional metadata about the entity, that can be derived from the “raw data” (composite doc, domain specific data…), or come from other sources. Next available tag is 35. | list(RepositoryWebrefSupportTransferRule) |
| id | The category ID from verticals4. See go/verticals4 and where we read them in http://google3/repository/webref/preprocessing/fatcat-categories.cc | RepositoryWebrefFatcatCategory | integer | |
| score | The relative weight of the category within a distribution. | RepositoryWebrefFatcatCategory | number | |
| forwardingUrl | Urls that forward to this url. Used for url -> topical entity entries. | RepositoryWebrefForwardingUrls | Submessage for forwarding urls in DocumentMetadata. | list(String) |
| language | i18.languages.Language enum defined in i18n/languages/proto/languages.proto UNKNOWN_LANGUAGE | RepositoryWebrefFprintModifierProto | #NAME? | integer |
| namespaceType | RepositoryWebrefFprintModifierProto | #NAME? | String | |
| provenance | Optional – for inferred types the principal source of information. | RepositoryWebrefFreebaseType | The Freebase type information. | list(String) |
| score | Optional score. Not present in KG directly but e.g. in WPCat. | RepositoryWebrefFreebaseType | The Freebase type information. | number |
| typeFprint | Fingerprint of type hrid http://cs/google3/repository/webref/universal/base/kg-schema.h;rcl=543911652;l=51 | RepositoryWebrefFreebaseType | The Freebase type information. | String |
| typeName | e.g.: “/business/industry”, “/book/book_subject”, “/people/person”… HRID of the type. May be missing for optimisation reasons in Refcon, but is present for Qref/Webref. At least one of type_name or type_fprint will be present at all times | RepositoryWebrefFreebaseType | The Freebase type information. | String |
| index | The segment index. | RepositoryWebrefGenericIndices | Identifies the segment index for Webref SegmentTypes not covered by other *Indices messages. | integer |
| address | Stores parent/container information containing city, province & country. | RepositoryWebrefGeoMetadataProto | Geo-specific information about the entity. Next available tag: 34. | GeostoreAddressProto |
| addressSynonyms | This field is only provided through the online qref interface (QrefMetadata). This is a fairly simple extraction from the /geo/type/feature/address_proto_blob triple. | RepositoryWebrefGeoMetadataProto | Geo-specific information about the entity. Next available tag: 34. | list(RepositoryWebrefGeoMetadataProtoAddressSynonym) |
| areaKm2 | Area in km^2 of the feature if the feature has polygon. Only set by qrefmetadata. | RepositoryWebrefGeoMetadataProto | Geo-specific information about the entity. Next available tag: 34. | float |
| bound | The tight bounds of this feature. Note that these are different from the FeatureProto.bound field. | RepositoryWebrefGeoMetadataProto | Geo-specific information about the entity. Next available tag: 34. | GeostoreRectProto |
| countryCode | Country code of the country of the entity. Only available in qref-metadata. | RepositoryWebrefGeoMetadataProto | Geo-specific information about the entity. Next available tag: 34. | String |
| location | The geographic location (center) and geometry of this entity. See geostore.FeatureProto for more details. | RepositoryWebrefGeoMetadataProto | Geo-specific information about the entity. Next available tag: 34. | GeostorePointProto |
| name | The best name from Oyster for this entity. Is only included for some types of entities, and is a trimmed version of the proto (some fields are cleared). | RepositoryWebrefGeoMetadataProto | Geo-specific information about the entity. Next available tag: 34. | GeostoreNameProto |
| oysterId | The oyster id of the entity | RepositoryWebrefGeoMetadataProto | Geo-specific information about the entity. Next available tag: 34. | GeostoreFeatureIdProto |
| stableIntegerCountryCode | Numerical country code, converted with i18n/identifiers/stableinternalregionconverter.h. It is the same as country_code, but it is available in the annotator model (and takes less space). | RepositoryWebrefGeoMetadataProto | Geo-specific information about the entity. Next available tag: 34. | integer |
| timezone | Timezone if the feature is contained inside one. | RepositoryWebrefGeoMetadataProto | Geo-specific information about the entity. Next available tag: 34. | String |
| wpLocation | Information about the geographic location (center) extracted from the wikijoins. | RepositoryWebrefGeoMetadataProto | Geo-specific information about the entity. Next available tag: 34. | list(RepositoryWebrefWikipediaGeocode) |
| language | RepositoryWebrefGeoMetadataProtoAddressSynonym | Terms from AddressComponent proto that we can use as address synonyms. At the time of annotation we have the entire AddressProto, however we can’t use it all due to size. So only store relevant pieces of components (defined in superroot/impls/localweb/s2_synoyms.h). | String | |
| name | RepositoryWebrefGeoMetadataProtoAddressSynonym | Terms from AddressComponent proto that we can use as address synonyms. At the time of annotation we have the entire AddressProto, however we can’t use it all due to size. So only store relevant pieces of components (defined in superroot/impls/localweb/s2_synoyms.h). | String | |
| type | The type of the geocoded address. e.g. Road, Lake, Ocean, building. This comes from TypeCategory field in geostore/base/proto/feature.proto | RepositoryWebrefGeoMetadataProtoAddressSynonym | Terms from AddressComponent proto that we can use as address synonyms. At the time of annotation we have the entire AddressProto, however we can’t use it all due to size. So only store relevant pieces of components (defined in superroot/impls/localweb/s2_synoyms.h). | integer |
| debugTitle | A short human-readable name/title of the entity, similar to what is displayed at the top of a Hume page. Do not use for any production purpose as it does not provide guarantees for stability or policy checks (access requirements). | RepositoryWebrefGlobalLinkInfo | Groups together the LinkInfo for all locales. | String |
| isBoostedPrimaryWeightLink | Whether this is a BoostedPrimaryWeight link. For these links in some cases a higher weight is used for primary scoring. | RepositoryWebrefGlobalLinkInfo | Groups together the LinkInfo for all locales. | boolean |
| targetMid | The mid of the linked entity. | RepositoryWebrefGlobalLinkInfo | Groups together the LinkInfo for all locales. | String |
| variantInfo | The information about this link for each locale. | RepositoryWebrefGlobalLinkInfo | Groups together the LinkInfo for all locales. | list(RepositoryWebrefLinkInfo) |
| normalizedName | The normalized name. | RepositoryWebrefGlobalNameInfo | Groups together the NameInfo for all variants of a given name. The variants of a name have the same normalized string, but they have a different original string and/or a different language/region. Example: For the name “apple”, there may be variants such as “apple|en”, “apple|en|US”, “apple|de”, “Apple|en”… | String |
| variantInfo | All the variants of this name together with associated information such as score, sources, etc. | RepositoryWebrefGlobalNameInfo | Groups together the NameInfo for all variants of a given name. The variants of a name have the same normalized string, but they have a different original string and/or a different language/region. Example: For the name “apple”, there may be variants such as “apple|en”, “apple|en|US”, “apple|de”, “Apple|en”… | list(RepositoryWebrefNameInfo) |
| annotationRatings | RepositoryWebrefHumanRatings | RepositoryWebrefAnnotationRatings | ||
| confidenceScore | RepositoryWebrefImageMention | number | ||
| imageDocid | https://source.corp.google.com/piper///depot/google3/image/search/imagedoc.proto;bpv=1;bpt=1;rcl=592258038;l=275 cdoc -> doc_images -> canonical_docid corresponds to the Image Doc ID | RepositoryWebrefImageMention | String | |
| canonicalDocid | The (canonical) image docid of the ImageData this image query is part of. Useful for identifying the ImageData even after doc_images are updated in between Webref annotation runs. Use docid only when canonical_docid == 0. | RepositoryWebrefImageQueryIndices | Identifies a set of Image NavBoost queries in the CompositeDoc. Each CompositeDoc can contain several images, so we store the image index from the CompositeDoc::doc_images with the index of the particular query inside ImageData::image_data_navboost. | String |
| docid | RepositoryWebrefImageQueryIndices | Identifies a set of Image NavBoost queries in the CompositeDoc. Each CompositeDoc can contain several images, so we store the image index from the CompositeDoc::doc_images with the index of the particular query inside ImageData::image_data_navboost. | String | |
| imageIndex | WARNING: The doc_images in docjoins are subject to updates including non-deterministic reordering of doc_images and their image_nb_data extensions. This means that without re-running WebrefAnnotator one cannot rely on the accuracy or even consistency of either image_index or query_index when parsing a cdoc from docjoins. In those situations one ought to rely on canonical_docid (or docid when canonical_docid is absent viz. 0). The index of the source image in CompositeDoc::doc_images. | RepositoryWebrefImageQueryIndices | Identifies a set of Image NavBoost queries in the CompositeDoc. Each CompositeDoc can contain several images, so we store the image index from the CompositeDoc::doc_images with the index of the particular query inside ImageData::image_data_navboost. | integer |
| queryIndex | Queries index in ImageData::image_data_navboost. | RepositoryWebrefImageQueryIndices | Identifies a set of Image NavBoost queries in the CompositeDoc. Each CompositeDoc can contain several images, so we store the image index from the CompositeDoc::doc_images with the index of the particular query inside ImageData::image_data_navboost. | RepositoryWebrefQueryIndices |
| index | Index within the proto. Several indices are necessary in case of nested repeated fields. The data can be accessed as follows: TOPICS: topic_annotations.kg_schema_topic(index(0)) .property_value(index(1)) .value(index(2)); TRIPLES: reconcile_request.triple(index(0)); | RepositoryWebrefJuggernautIndices | Identifies the source of Spore segments in the CompositeDoc. | list(integer) |
| type | RepositoryWebrefJuggernautIndices | Identifies the source of Spore segments in the CompositeDoc. | String | |
| equivalentAttributeId | Equivalent kc attribute id for the given entity if applicable. E.g. for Daughter (/m/029wnx) this will be ‘kc:/people/person:daughter’. | RepositoryWebrefKCAttributeMetadata | Metadata related to KC attributes and Question & Answer triggering. Next available tag: 2. | String |
| debugId | A human friendly identifier (collection hrid). NOTE: The field name is a misnomer, this is the preferred field to use in production. | RepositoryWebrefKGCollection | See go/kg-collections | String |
| id | Identifier of the collection, usually a MID (/m/xyz or /g/zyw). NOTE: In most cases, this is not the id that should be used, debug_id is the preferred identifier. The main reason is the this is not a stable id (mid for collection sometimes shift around). | RepositoryWebrefKGCollection | See go/kg-collections | String |
| latentEntity | Latent entities with associated metadata including source of the relationship. This is pruned (“compacted”) from the concept table and will never reach the annotator. | RepositoryWebrefLatentEntities | A list of entities that are latent given this entity. For example, “Lionel Messi” can have the latent entity “FC Barcelona”. See go/refx-latent-entities for detailed description. | list(RepositoryWebrefLatentEntity) |
| broaderImportance | The relatedness score of the two entities corresponding to each source above. | RepositoryWebrefLatentEntity | Metadata about a latent entity and its relationship to a given child. See go/hits. | list(number) |
| mid | The mid of the latent entity. | RepositoryWebrefLatentEntity | Metadata about a latent entity and its relationship to a given child. See go/hits. | String |
| sources | The sources this generalization relationship is coming from. | RepositoryWebrefLatentEntity | Metadata about a latent entity and its relationship to a given child. See go/hits. | list(String) |
| lexicalRange | RepositoryWebrefLexicalAnnotation | LexicalAnnotation is public lightweight serving structure for both WordGraph features and LWT annotations to expose lexical information downstream from RefX, e.g. in LooseParser. | list(RepositoryWebrefLexicalRange) | |
| beginOffset | Begin byte offset relative to the full original query. | RepositoryWebrefLexicalRange | A single understood lexicon of the |category| on byte range from |begin_offset| (inclusive) to |end_offset| (exclusive). The offsets are all byte offsets relative to the full original query and cover both the mentions and surrounding markers. | integer |
| category | RepositoryWebrefLexicalRange | A single understood lexicon of the |category| on byte range from |begin_offset| (inclusive) to |end_offset| (exclusive). The offsets are all byte offsets relative to the full original query and cover both the mentions and surrounding markers. | String | |
| direction | Direction defines the relation between the measurable aspect and the facet. | RepositoryWebrefLexicalRange | A single understood lexicon of the |category| on byte range from |begin_offset| (inclusive) to |end_offset| (exclusive). The offsets are all byte offsets relative to the full original query and cover both the mentions and surrounding markers. | String |
| endOffset | End byte offset relative to the full original query. | RepositoryWebrefLexicalRange | A single understood lexicon of the |category| on byte range from |begin_offset| (inclusive) to |end_offset| (exclusive). The offsets are all byte offsets relative to the full original query and cover both the mentions and surrounding markers. | integer |
| facetMid | The mid of the facet associated with ASPECT category. | RepositoryWebrefLexicalRange | A single understood lexicon of the |category| on byte range from |begin_offset| (inclusive) to |end_offset| (exclusive). The offsets are all byte offsets relative to the full original query and cover both the mentions and surrounding markers. | String |
| additionalBeginOffset | The byte offset of the beging of the additional lightweight token match. e.g. the prefix pattern of the circumfix. | RepositoryWebrefLightweightTokensMatchedLightweightToken | Necessary information of lightweight token pattern with entity retrieval to pass to downstream clients. For example: FpTokenRange: normalized_text: “zurichben” language: Hungarian retrieved_entity: /m/08966 (with name “zurich”) will get: MatchedLightweightToken: LightweightTokenType: “LOCATIVE” begin_offset: 6 end_offset: 9 pattern_id: 8141703461898598811 source_entity_index: 0 FpTokenRange: normalized_text: “egyesult allamokott” language: Hungarian retrieved_entity: /m/09c7w0 (with name “egyesult allamok”) will get: MatchedLightweightToken: LightweightTokenType: “LOCATIVE” begin_offset: 16 end_offset: 19 pattern_id: 10449962977910715124 source_entity_index: 0 Note that begin_offset and end_offset marks the input byte range of the matched input text. For example, if the input text is [tannlegas] in Norwegian, this matches with the rewrite rule “*e:*as” to transform “tannlegas” to “tannlege”. The matched byte range is [7, 9) on “as”, therefore begin_offset = 7 and end_offset = 9. This must not be confused with the rewritten range [7, 8) on “e”. Also, keep in mind these are byte offsets, not codepoints. | integer |
| additionalEndOffset | The byte offset of the end of the additional lightweight token match. e.g. the suffix pattern of the circumfix. | RepositoryWebrefLightweightTokensMatchedLightweightToken | Necessary information of lightweight token pattern with entity retrieval to pass to downstream clients. For example: FpTokenRange: normalized_text: “zurichben” language: Hungarian retrieved_entity: /m/08966 (with name “zurich”) will get: MatchedLightweightToken: LightweightTokenType: “LOCATIVE” begin_offset: 6 end_offset: 9 pattern_id: 8141703461898598811 source_entity_index: 0 FpTokenRange: normalized_text: “egyesult allamokott” language: Hungarian retrieved_entity: /m/09c7w0 (with name “egyesult allamok”) will get: MatchedLightweightToken: LightweightTokenType: “LOCATIVE” begin_offset: 16 end_offset: 19 pattern_id: 10449962977910715124 source_entity_index: 0 Note that begin_offset and end_offset marks the input byte range of the matched input text. For example, if the input text is [tannlegas] in Norwegian, this matches with the rewrite rule “*e:*as” to transform “tannlegas” to “tannlege”. The matched byte range is [7, 9) on “as”, therefore begin_offset = 7 and end_offset = 9. This must not be confused with the rewritten range [7, 8) on “e”. Also, keep in mind these are byte offsets, not codepoints. | integer |
| beginOffset | The byte offset of the begin of the lightweight token match within each range. The default value of -1 (std::string::npos) means that there’s no affix or adposition detected. | RepositoryWebrefLightweightTokensMatchedLightweightToken | Necessary information of lightweight token pattern with entity retrieval to pass to downstream clients. For example: FpTokenRange: normalized_text: “zurichben” language: Hungarian retrieved_entity: /m/08966 (with name “zurich”) will get: MatchedLightweightToken: LightweightTokenType: “LOCATIVE” begin_offset: 6 end_offset: 9 pattern_id: 8141703461898598811 source_entity_index: 0 FpTokenRange: normalized_text: “egyesult allamokott” language: Hungarian retrieved_entity: /m/09c7w0 (with name “egyesult allamok”) will get: MatchedLightweightToken: LightweightTokenType: “LOCATIVE” begin_offset: 16 end_offset: 19 pattern_id: 10449962977910715124 source_entity_index: 0 Note that begin_offset and end_offset marks the input byte range of the matched input text. For example, if the input text is [tannlegas] in Norwegian, this matches with the rewrite rule “*e:*as” to transform “tannlegas” to “tannlege”. The matched byte range is [7, 9) on “as”, therefore begin_offset = 7 and end_offset = 9. This must not be confused with the rewritten range [7, 8) on “e”. Also, keep in mind these are byte offsets, not codepoints. | integer |
| endOffset | The byte offset of the end of the lightweight token match within each range. The default value of 0 means that there’s no affix or adposition detected. | RepositoryWebrefLightweightTokensMatchedLightweightToken | Necessary information of lightweight token pattern with entity retrieval to pass to downstream clients. For example: FpTokenRange: normalized_text: “zurichben” language: Hungarian retrieved_entity: /m/08966 (with name “zurich”) will get: MatchedLightweightToken: LightweightTokenType: “LOCATIVE” begin_offset: 6 end_offset: 9 pattern_id: 8141703461898598811 source_entity_index: 0 FpTokenRange: normalized_text: “egyesult allamokott” language: Hungarian retrieved_entity: /m/09c7w0 (with name “egyesult allamok”) will get: MatchedLightweightToken: LightweightTokenType: “LOCATIVE” begin_offset: 16 end_offset: 19 pattern_id: 10449962977910715124 source_entity_index: 0 Note that begin_offset and end_offset marks the input byte range of the matched input text. For example, if the input text is [tannlegas] in Norwegian, this matches with the rewrite rule “*e:*as” to transform “tannlegas” to “tannlege”. The matched byte range is [7, 9) on “as”, therefore begin_offset = 7 and end_offset = 9. This must not be confused with the rewritten range [7, 8) on “e”. Also, keep in mind these are byte offsets, not codepoints. | integer |
| patternId | Matched pattern Id which will be used to retrieve back pattern features. Pattern id is only populated for Enricher model. | RepositoryWebrefLightweightTokensMatchedLightweightToken | Necessary information of lightweight token pattern with entity retrieval to pass to downstream clients. For example: FpTokenRange: normalized_text: “zurichben” language: Hungarian retrieved_entity: /m/08966 (with name “zurich”) will get: MatchedLightweightToken: LightweightTokenType: “LOCATIVE” begin_offset: 6 end_offset: 9 pattern_id: 8141703461898598811 source_entity_index: 0 FpTokenRange: normalized_text: “egyesult allamokott” language: Hungarian retrieved_entity: /m/09c7w0 (with name “egyesult allamok”) will get: MatchedLightweightToken: LightweightTokenType: “LOCATIVE” begin_offset: 16 end_offset: 19 pattern_id: 10449962977910715124 source_entity_index: 0 Note that begin_offset and end_offset marks the input byte range of the matched input text. For example, if the input text is [tannlegas] in Norwegian, this matches with the rewrite rule “*e:*as” to transform “tannlegas” to “tannlege”. The matched byte range is [7, 9) on “as”, therefore begin_offset = 7 and end_offset = 9. This must not be confused with the rewritten range [7, 8) on “e”. Also, keep in mind these are byte offsets, not codepoints. | String |
| sourceEntityIndex | The index of the source entity in the resulting WebrefEntities or WebrefEntitiesWrapper, to which the lightweight token rule is applied. This field is only populated at the end of Qref scorer when we are sure which source entity should output. | RepositoryWebrefLightweightTokensMatchedLightweightToken | Necessary information of lightweight token pattern with entity retrieval to pass to downstream clients. For example: FpTokenRange: normalized_text: “zurichben” language: Hungarian retrieved_entity: /m/08966 (with name “zurich”) will get: MatchedLightweightToken: LightweightTokenType: “LOCATIVE” begin_offset: 6 end_offset: 9 pattern_id: 8141703461898598811 source_entity_index: 0 FpTokenRange: normalized_text: “egyesult allamokott” language: Hungarian retrieved_entity: /m/09c7w0 (with name “egyesult allamok”) will get: MatchedLightweightToken: LightweightTokenType: “LOCATIVE” begin_offset: 16 end_offset: 19 pattern_id: 10449962977910715124 source_entity_index: 0 Note that begin_offset and end_offset marks the input byte range of the matched input text. For example, if the input text is [tannlegas] in Norwegian, this matches with the rewrite rule “*e:*as” to transform “tannlegas” to “tannlege”. The matched byte range is [7, 9) on “as”, therefore begin_offset = 7 and end_offset = 9. This must not be confused with the rewritten range [7, 8) on “e”. Also, keep in mind these are byte offsets, not codepoints. | integer |
| type | The type of the lightweight token match, which provides the semantic information. | RepositoryWebrefLightweightTokensMatchedLightweightToken | Necessary information of lightweight token pattern with entity retrieval to pass to downstream clients. For example: FpTokenRange: normalized_text: “zurichben” language: Hungarian retrieved_entity: /m/08966 (with name “zurich”) will get: MatchedLightweightToken: LightweightTokenType: “LOCATIVE” begin_offset: 6 end_offset: 9 pattern_id: 8141703461898598811 source_entity_index: 0 FpTokenRange: normalized_text: “egyesult allamokott” language: Hungarian retrieved_entity: /m/09c7w0 (with name “egyesult allamok”) will get: MatchedLightweightToken: LightweightTokenType: “LOCATIVE” begin_offset: 16 end_offset: 19 pattern_id: 10449962977910715124 source_entity_index: 0 Note that begin_offset and end_offset marks the input byte range of the matched input text. For example, if the input text is [tannlegas] in Norwegian, this matches with the rewrite rule “*e:*as” to transform “tannlegas” to “tannlege”. The matched byte range is [7, 9) on “as”, therefore begin_offset = 7 and end_offset = 9. This must not be confused with the rewritten range [7, 8) on “e”. Also, keep in mind these are byte offsets, not codepoints. | String |
| matchedLightweightToken | RepositoryWebrefLightweightTokensPerMentionLightweightToken | Collects all lightweight token patterns for each CandidateMention or Mention. | list(RepositoryWebrefLightweightTokensMatchedLightweightToken) | |
| matchedLightweightToken | RepositoryWebrefLightweightTokensPerNameLightweightToken | Collects all lightweight token patterns for each NameToConceptEntry. | list(RepositoryWebrefLightweightTokensMatchedLightweightToken) | |
| aggregatedScore | The score aggregated from all sources. | RepositoryWebrefLinkInfo | Represents all information we have about a specific/localized link. Next available tag: 11. | number |
| isPreferredDirection | The EntityJoin keeps bi-directional links, but for some applications we only need them in one direction. This value indicates whether this is the preferred direction to keep. (We usually prefer keeping the link from the less common to the more common entity for performance reasons). For categorical links the preferred direction is from child to parent. | RepositoryWebrefLinkInfo | Represents all information we have about a specific/localized link. Next available tag: 11. | boolean |
| metadata | The metadata associated with the link. | RepositoryWebrefLinkInfo | Represents all information we have about a specific/localized link. Next available tag: 11. | RepositoryWebrefEntityLinkMetadata |
| source | The per-source scores. | RepositoryWebrefLinkInfo | Represents all information we have about a specific/localized link. Next available tag: 11. | list(RepositoryWebrefEntityLinkSource) |
| cluster | RepositoryWebrefLinkKindFlags | A bitmap of bool values associated with a link kind. Next available tag: 12 | String | |
| geoContainment | RepositoryWebrefLinkKindFlags | A bitmap of bool values associated with a link kind. Next available tag: 12 | String | |
| implication | RepositoryWebrefLinkKindFlags | A bitmap of bool values associated with a link kind. Next available tag: 12 | String | |
| latentEntity | RepositoryWebrefLinkKindFlags | A bitmap of bool values associated with a link kind. Next available tag: 12 | String | |
| mdvc | RepositoryWebrefLinkKindFlags | A bitmap of bool values associated with a link kind. Next available tag: 12 | String | |
| property | RepositoryWebrefLinkKindFlags | A bitmap of bool values associated with a link kind. Next available tag: 12 | String | |
| flags | The flags associated with the link kind. | RepositoryWebrefLinkKindInfo | Information about one of the types of a linked entity. | RepositoryWebrefLinkKindFlags |
| topicPropertyName | If the link was extracted from a property, the name of the property. Can start with an exclamation mark “!” to indicate that the inverse relationship is specified. (e.g. “!/tv/tv_series_episode/series” is the inverse of “tv/tv_program/episodes”). | RepositoryWebrefLinkKindInfo | Information about one of the types of a linked entity. | String |
| domain | The domain name from which results come, e.g. “play.google.com”. | RepositoryWebrefLocalizedString | Next available tag: 8. | String |
| fprintModifier | FprintModifier describing the formatting of the string. If fprint_modifier is set, then original_string, language and region should not be set. | RepositoryWebrefLocalizedString | Next available tag: 8. | RepositoryWebrefFprintModifierProto |
| language | The language in the III standard (http://go/iii) | RepositoryWebrefLocalizedString | Next available tag: 8. | String |
| normalizedString | RepositoryWebrefLocalizedString | Next available tag: 8. | String | |
| originalString | RepositoryWebrefLocalizedString | Next available tag: 8. | String | |
| region | The region in the III standard (http://go/iii) | RepositoryWebrefLocalizedString | Next available tag: 8. | String |
| sourceType | Which querybase pipeline the data comes from. | RepositoryWebrefLocalizedString | Next available tag: 8. | String |
| dimension | Undergoing migration into the PerVertical message. Avoid using it. Concept ids of MDVC dimensions of this concept. | RepositoryWebrefMdvcMetadata | Metadata about MDVC (go/mdvc). Next available tag: 18. | list(String) |
| expandedOutputConceptId | Undergoing migration into the PerVertical message. Avoid using it. List of encoded mids to be expanded in WebRef/QRef output whenever this entity gets annotated. Will be populated in the annotators once static data is deprecated. b/78866814. | RepositoryWebrefMdvcMetadata | Metadata about MDVC (go/mdvc). Next available tag: 18. | list(String) |
| generalization | Undergoing migration into the PerVertical message. Avoid using it. Concept ids of MDVC generalizations of this concept. | RepositoryWebrefMdvcMetadata | Metadata about MDVC (go/mdvc). Next available tag: 18. | list(String) |
| isSynthetic | True iff the topic is synthetically created during by MDVC extraction. | RepositoryWebrefMdvcMetadata | Metadata about MDVC (go/mdvc). Next available tag: 18. | boolean |
| perVertical | Data, specific to particular verticals. | RepositoryWebrefMdvcMetadata | Metadata about MDVC (go/mdvc). Next available tag: 18. | list(RepositoryWebrefMdvcMetadataPerVertical) |
| resolutionPriority | Undergoing migration into the PerVertical message. Avoid using it. Resolution priority for this entity. In case a query has many possible resolutions, only the ones with the highest resolution priority are annotated. | RepositoryWebrefMdvcMetadata | Metadata about MDVC (go/mdvc). Next available tag: 18. | integer |
| compatibleIds | Concept ids compatible with this topic: specializations and/or ones having this concept as a dimension. Always includes the topic itself. | RepositoryWebrefMdvcMetadataPerVertical | Per-vertical part. Next available tag: 19 | list(String) |
| dimensionIds | Concept ids of the dimension values of this topic. | RepositoryWebrefMdvcMetadataPerVertical | Per-vertical part. Next available tag: 19 | list(String) |
| expandedOutputIds | Concept ids to annotate whenever this entity is annotated. | RepositoryWebrefMdvcMetadataPerVertical | Per-vertical part. Next available tag: 19 | list(String) |
| generalizationIds | Concept ids of the generalizations of this topic. | RepositoryWebrefMdvcMetadataPerVertical | Per-vertical part. Next available tag: 19 | list(String) |
| isCore | True if the topic is considered a “core topic” for the vertical. | RepositoryWebrefMdvcMetadataPerVertical | Per-vertical part. Next available tag: 19 | boolean |
| isDimension | If true, the entity is a dimension for some entities in the vertical. | RepositoryWebrefMdvcMetadataPerVertical | Per-vertical part. Next available tag: 19 | boolean |
| isGeneralization | If true, the entity is a generalization for some entities in the vertical. | RepositoryWebrefMdvcMetadataPerVertical | Per-vertical part. Next available tag: 19 | boolean |
| resolutionPriority | Resolution priority for this entity. If there are many possible resolutions to a MDVC understanding, only the ones with the highest priority are annotated. | RepositoryWebrefMdvcMetadataPerVertical | Per-vertical part. Next available tag: 19 | integer |
| verticalName | Name of the vertical this message is about. | RepositoryWebrefMdvcMetadataPerVertical | Per-vertical part. Next available tag: 19 | String |
| addedByCloseAnswers | Whether this mention was created by CloseAnswers on Postref. This bit is populated into corresponding intent_query through Aqua. | RepositoryWebrefMention | Multiple entities can be identified on a document or query. Each entity can be mentioned several times in different positions on the document or query. This message describes a single mention of the entity. Note that a mention can be either explicit or implicit mentions. All explicit mentions refer to exact range in the document where the entity occurred, but implicit mentions may or may not have corresponding range. Next available tag number: 40 | boolean |
| additionalExplainedRange | If the mention’s range is discontinuous, additional ranges that are a part of the mention but are not included in the begin/end range above. | RepositoryWebrefMention | Multiple entities can be identified on a document or query. Each entity can be mentioned several times in different positions on the document or query. This message describes a single mention of the entity. Note that a mention can be either explicit or implicit mentions. All explicit mentions refer to exact range in the document where the entity occurred, but implicit mentions may or may not have corresponding range. Next available tag number: 40 | list(RepositoryWebrefMentionAdditionalExplainedRange) |
| begin | The [begin, end) byte offset, compatible with the Goldmine DocState representation. – For CONTENT, TITLE, META_CONTENT_TAG and IMG_ALT_TAG segments, the offsets are relative to the beginning of the document content. – For ANCHOR, QUERY, URL, IMAGE_QUERY, CONTEXT_ENTITY, CONTEXT_QUERY, SPORE_GRAPH, INSTANT_QUERY and VIDEO_TRANSCRIPT segments, the offsets are relative to the beginning of the corresponding (sub-)segment or text from doc attachment. The (indexing.annotations.goldmine) options are marks for Goldmine AnnotationsFinder to locate begin and end offsets in order to extract them | RepositoryWebrefMention | Multiple entities can be identified on a document or query. Each entity can be mentioned several times in different positions on the document or query. This message describes a single mention of the entity. Note that a mention can be either explicit or implicit mentions. All explicit mentions refer to exact range in the document where the entity occurred, but implicit mentions may or may not have corresponding range. Next available tag number: 40 | integer |
| beginTokenIndex | The [begin end) token offsets in the Goldmine DocState. They follow similar rules as “begin” and “end” above, but for tokens rather than byte offsets. These fields are currently only populated by the query annotator. | RepositoryWebrefMention | Multiple entities can be identified on a document or query. Each entity can be mentioned several times in different positions on the document or query. This message describes a single mention of the entity. Note that a mention can be either explicit or implicit mentions. All explicit mentions refer to exact range in the document where the entity occurred, but implicit mentions may or may not have corresponding range. Next available tag number: 40 | integer |
| compoundMention | For a compound mention, the references to the entity and mention of the components. Each compound_mention claims one or more ‘mrf’ fields from the WebrefEntity owning this mention. Use QueryJoinToMeaningStructConverter to expand compound mentions into complete MRF. | RepositoryWebrefMention | Multiple entities can be identified on a document or query. Each entity can be mentioned several times in different positions on the document or query. This message describes a single mention of the entity. Note that a mention can be either explicit or implicit mentions. All explicit mentions refer to exact range in the document where the entity occurred, but implicit mentions may or may not have corresponding range. Next available tag number: 40 | list(RepositoryWebrefMentionCompoundMention) |
| confidenceScore | A probabilistic score describing how certain the annotator is that this exact range in the document or query refers to the entity. Probability that a mention is correct corresponds to confidence score roughly as follows: 0.3 -> 75% 0.5 -> 87% 0.7 -> 89% 0.9 -> 94% 1.0 -> 98% However if you consider all mentions with a score above 0.3, then most of these will have scores close to 1, so the overall precision of these mentions is around 95%. | RepositoryWebrefMention | Multiple entities can be identified on a document or query. Each entity can be mentioned several times in different positions on the document or query. This message describes a single mention of the entity. Note that a mention can be either explicit or implicit mentions. All explicit mentions refer to exact range in the document where the entity occurred, but implicit mentions may or may not have corresponding range. Next available tag number: 40 | number |
| debugInfo | Debug information. | RepositoryWebrefMention | Multiple entities can be identified on a document or query. Each entity can be mentioned several times in different positions on the document or query. This message describes a single mention of the entity. Note that a mention can be either explicit or implicit mentions. All explicit mentions refer to exact range in the document where the entity occurred, but implicit mentions may or may not have corresponding range. Next available tag number: 40 | RepositoryWebrefMentionDebugInfo |
| detailedMentionScores | Additional detailed scores about this mention. | RepositoryWebrefMention | Multiple entities can be identified on a document or query. Each entity can be mentioned several times in different positions on the document or query. This message describes a single mention of the entity. Note that a mention can be either explicit or implicit mentions. All explicit mentions refer to exact range in the document where the entity occurred, but implicit mentions may or may not have corresponding range. Next available tag number: 40 | RepositoryWebrefDetailedMentionScores |
| end | RepositoryWebrefMention | Multiple entities can be identified on a document or query. Each entity can be mentioned several times in different positions on the document or query. This message describes a single mention of the entity. Note that a mention can be either explicit or implicit mentions. All explicit mentions refer to exact range in the document where the entity occurred, but implicit mentions may or may not have corresponding range. Next available tag number: 40 | integer | |
| endTokenIndex | RepositoryWebrefMention | Multiple entities can be identified on a document or query. Each entity can be mentioned several times in different positions on the document or query. This message describes a single mention of the entity. Note that a mention can be either explicit or implicit mentions. All explicit mentions refer to exact range in the document where the entity occurred, but implicit mentions may or may not have corresponding range. Next available tag number: 40 | integer | |
| evalInfo | Information used by the evaluation tools to mark mentions annotations as correct/incorrect. This will never be annotated in production (would be nice if was, though :-)). | RepositoryWebrefMention | Multiple entities can be identified on a document or query. Each entity can be mentioned several times in different positions on the document or query. This message describes a single mention of the entity. Note that a mention can be either explicit or implicit mentions. All explicit mentions refer to exact range in the document where the entity occurred, but implicit mentions may or may not have corresponding range. Next available tag number: 40 | RepositoryWebrefMentionEvalInfo |
| interpretationNumber | DEPRECATED and not populated anymore. | RepositoryWebrefMention | Multiple entities can be identified on a document or query. Each entity can be mentioned several times in different positions on the document or query. This message describes a single mention of the entity. Note that a mention can be either explicit or implicit mentions. All explicit mentions refer to exact range in the document where the entity occurred, but implicit mentions may or may not have corresponding range. Next available tag number: 40 | list(integer) |
| isImplicit | True if the entity is mentioned implicitly. Note that a mention can be implicit *and* have a non-empty range, for example if the entity is Sports, and this is inferred from the mention of “gym”. | RepositoryWebrefMention | Multiple entities can be identified on a document or query. Each entity can be mentioned several times in different positions on the document or query. This message describes a single mention of the entity. Note that a mention can be either explicit or implicit mentions. All explicit mentions refer to exact range in the document where the entity occurred, but implicit mentions may or may not have corresponding range. Next available tag number: 40 | boolean |
| lexicalAnnotation | Provides a Wordgraph lexical signals for the mentioned range so it can be use in LooseParsing. Please don’t use this field before consulting wordgraph-team. | RepositoryWebrefMention | Multiple entities can be identified on a document or query. Each entity can be mentioned several times in different positions on the document or query. This message describes a single mention of the entity. Note that a mention can be either explicit or implicit mentions. All explicit mentions refer to exact range in the document where the entity occurred, but implicit mentions may or may not have corresponding range. Next available tag number: 40 | RepositoryWebrefLexicalAnnotation |
| lowConfidence | Qref & Postref only: Set to true for candidates part of qref candidate output for which there was no mention in qref. Internal to qref and LooseParsing. Do not use outside of these systems. | RepositoryWebrefMention | Multiple entities can be identified on a document or query. Each entity can be mentioned several times in different positions on the document or query. This message describes a single mention of the entity. Note that a mention can be either explicit or implicit mentions. All explicit mentions refer to exact range in the document where the entity occurred, but implicit mentions may or may not have corresponding range. Next available tag number: 40 | boolean |
| matchingText | Refcon-only: Annotated span in Refcon-normalized textual format, corresponding to the [begin end) offset interval in the CDoc. It will only be populated for CDocs originated from Docjoin extraction. | RepositoryWebrefMention | Multiple entities can be identified on a document or query. Each entity can be mentioned several times in different positions on the document or query. This message describes a single mention of the entity. Note that a mention can be either explicit or implicit mentions. All explicit mentions refer to exact range in the document where the entity occurred, but implicit mentions may or may not have corresponding range. Next available tag number: 40 | String |
| nameMetadata | Metadata attached to the name. | RepositoryWebrefMention | Multiple entities can be identified on a document or query. Each entity can be mentioned several times in different positions on the document or query. This message describes a single mention of the entity. Note that a mention can be either explicit or implicit mentions. All explicit mentions refer to exact range in the document where the entity occurred, but implicit mentions may or may not have corresponding range. Next available tag number: 40 | RepositoryWebrefConceptNameMetadata |
| perMentionLightweightToken | Provides concised access to all matched MatchedLightweightToken. | RepositoryWebrefMention | Multiple entities can be identified on a document or query. Each entity can be mentioned several times in different positions on the document or query. This message describes a single mention of the entity. Note that a mention can be either explicit or implicit mentions. All explicit mentions refer to exact range in the document where the entity occurred, but implicit mentions may or may not have corresponding range. Next available tag number: 40 | RepositoryWebrefLightweightTokensPerMentionLightweightToken |
| personalizationContextOutputs | Additional personalization output scores about this mention. | RepositoryWebrefMention | Multiple entities can be identified on a document or query. Each entity can be mentioned several times in different positions on the document or query. This message describes a single mention of the entity. Note that a mention can be either explicit or implicit mentions. All explicit mentions refer to exact range in the document where the entity occurred, but implicit mentions may or may not have corresponding range. Next available tag number: 40 | RepositoryWebrefPersonalizationContextOutputs |
| priorProbability | The prior probability of the entity for this mention. | RepositoryWebrefMention | Multiple entities can be identified on a document or query. Each entity can be mentioned several times in different positions on the document or query. This message describes a single mention of the entity. Note that a mention can be either explicit or implicit mentions. All explicit mentions refer to exact range in the document where the entity occurred, but implicit mentions may or may not have corresponding range. Next available tag number: 40 | number |
| referenceScore | Whether the mention is a reference (e.g. it could be resolved to an entity coming from personal data) or not, currently only used for personal resolutions. Scores from 0 (not a reference) to 1 (reference). Use at your own risk as they are subject to change, advised to talk to refx-personal first. | RepositoryWebrefMention | Multiple entities can be identified on a document or query. Each entity can be mentioned several times in different positions on the document or query. This message describes a single mention of the entity. Note that a mention can be either explicit or implicit mentions. All explicit mentions refer to exact range in the document where the entity occurred, but implicit mentions may or may not have corresponding range. Next available tag number: 40 | number |
| resolutionScore | Whether the mention is a resolution or not, currently only used for personal resolutions. Scores from 0 (not a resolution) to 1 (resolution). Use at your own risk as they are subject to change, advised to talk to refx-personal first. | RepositoryWebrefMention | Multiple entities can be identified on a document or query. Each entity can be mentioned several times in different positions on the document or query. This message describes a single mention of the entity. Note that a mention can be either explicit or implicit mentions. All explicit mentions refer to exact range in the document where the entity occurred, but implicit mentions may or may not have corresponding range. Next available tag number: 40 | number |
| stuff | Assorted things that can be added to a Mention. | RepositoryWebrefMention | Multiple entities can be identified on a document or query. Each entity can be mentioned several times in different positions on the document or query. This message describes a single mention of the entity. Note that a mention can be either explicit or implicit mentions. All explicit mentions refer to exact range in the document where the entity occurred, but implicit mentions may or may not have corresponding range. Next available tag number: 40 | Proto2BridgeMessageSet |
| subsegmentIndex | Identifies the sub-segment where the annotation occurs. See SubSegmentIndex for details. Not present in QRef, also deprecated for URL segment types. | RepositoryWebrefMention | Multiple entities can be identified on a document or query. Each entity can be mentioned several times in different positions on the document or query. This message describes a single mention of the entity. Note that a mention can be either explicit or implicit mentions. All explicit mentions refer to exact range in the document where the entity occurred, but implicit mentions may or may not have corresponding range. Next available tag number: 40 | RepositoryWebrefSubSegmentIndex |
| trustedNameConfidence | Confidence that this name is a trusted name of the entity. This is set only in case the confidence is higher than an internal threshold (see ConceptProbability). | RepositoryWebrefMention | Multiple entities can be identified on a document or query. Each entity can be mentioned several times in different positions on the document or query. This message describes a single mention of the entity. Note that a mention can be either explicit or implicit mentions. All explicit mentions refer to exact range in the document where the entity occurred, but implicit mentions may or may not have corresponding range. Next available tag number: 40 | number |
| begin | Like begin/end, begin_token_index/end_token_index above. | RepositoryWebrefMentionAdditionalExplainedRange | Additional ranges covered by the mention. Next available tag: 5 | integer |
| beginTokenIndex | RepositoryWebrefMentionAdditionalExplainedRange | Additional ranges covered by the mention. Next available tag: 5 | integer | |
| end | RepositoryWebrefMentionAdditionalExplainedRange | Additional ranges covered by the mention. Next available tag: 5 | integer | |
| endTokenIndex | RepositoryWebrefMentionAdditionalExplainedRange | Additional ranges covered by the mention. Next available tag: 5 | integer | |
| entityIndex | The indices to identify the entity within the WebrefEntities.entities, the segment within its EntityAnnotations.segment_mentions, and the mention within that segment. entity_index is always guaranteed to be set, but segment_mentions_index and mention_index are omitted if the component reference is implicit. | RepositoryWebrefMentionComponent | Reference to a component of a compound mention. Next available tag: 5 | integer |
| isHeadComponent | The source of the compound has designated this component as the head. Only one of the components can be a head, but it’s possible none are. | RepositoryWebrefMentionComponent | Reference to a component of a compound mention. Next available tag: 5 | boolean |
| mentionIndex | RepositoryWebrefMentionComponent | Reference to a component of a compound mention. Next available tag: 5 | integer | |
| segmentMentionsIndex | RepositoryWebrefMentionComponent | Reference to a component of a compound mention. Next available tag: 5 | integer | |
| component | References to the component mentions which the MRF needs to be fully expanded. It is guaranteed that for a given set of components there exists only a single CompoundMention, i.e. the CompoundMentions are deduped to be unique so each set of components is present only once. The ArgumentValue of the WebrefEntity.mrf refer to these components via ComponentReference; it is guaranteed there are as many components as the MRF expression refers to. | RepositoryWebrefMentionCompoundMention | A single compound mention. Next available tag: 3 | list(RepositoryWebrefMentionComponent) |
| mrfIndex | The WebrefEntity.mrf indices which this compound applies to. There can be at most one CompoundMention which claims an MRF index, but it is possible there are MRF expressions which are not claimed by any CompoundMention. | RepositoryWebrefMentionCompoundMention | A single compound mention. Next available tag: 3 | list(integer) |
| cleanText | A clean version of text. This is mostly used for compatibility with other Goldmine annotators. | RepositoryWebrefMentionDebugInfo | String | |
| infoString | Optional debug information. | RepositoryWebrefMentionDebugInfo | list(String) | |
| snippet | A snippet of the parsed text (html tags removed) in the page around this mention. Useful for human evaluation of the quality of the annotations. Outputted by WebrefAnnotator if –webref_output_mention_snippet_size is set to a value greater than 0. | RepositoryWebrefMentionDebugInfo | String | |
| text | Original UTF-8 document text occurring in the range [begin, end). | RepositoryWebrefMentionDebugInfo | String | |
| atmWeight | Weight of the mention used in the ATM score. | RepositoryWebrefMentionEvalInfo | number | |
| rating | The aggregate numerical rating of this mention. 0.0 means completely incorrect, and 1.0 completely correct. | RepositoryWebrefMentionEvalInfo | number | |
| begin | Byte offsets of the mention. | RepositoryWebrefMentionRatings | Per document mention ratings. Next id: 10 | integer |
| end | RepositoryWebrefMentionRatings | Per document mention ratings. Next id: 10 | integer | |
| mentionMatch | RepositoryWebrefMentionRatings | Per document mention ratings. Next id: 10 | list(String) | |
| singleMentionRating | RepositoryWebrefMentionRatings | Per document mention ratings. Next id: 10 | list(RepositoryWebrefMentionRatingsSingleMentionRating) | |
| isCorrectRange | Set for mentions got from the new topicality template. True if the raters checked this range as being a good range for the entity. If the range is not correct we demote the mention score. This field is only used in template version V1. From template version V2 and forward it is now set via phrase_refer. | RepositoryWebrefMentionRatingsSingleMentionRating | Next available tag: 11 | boolean |
| mentionMatch | RepositoryWebrefMentionRatingsSingleMentionRating | Next available tag: 11 | String | |
| mentionRelevant | RepositoryWebrefMentionRatingsSingleMentionRating | Next available tag: 11 | String | |
| phraseRefer | RepositoryWebrefMentionRatingsSingleMentionRating | Next available tag: 11 | String | |
| raterCanUnderstandTopic | Whether rater can understand the topic. | RepositoryWebrefMentionRatingsSingleMentionRating | Next available tag: 11 | boolean |
| ratingSource | The source of the rating, possibly a golden set external to EWOK. | RepositoryWebrefMentionRatingsSingleMentionRating | Next available tag: 11 | String |
| resultCount | RepositoryWebrefMentionRatingsSingleMentionRating | Next available tag: 11 | integer | |
| taskData | RepositoryWebrefMentionRatingsSingleMentionRating | Next available tag: 11 | RepositoryWebrefTaskData | |
| topicMentionedInResult | RepositoryWebrefMentionRatingsSingleMentionRating | Next available tag: 11 | list(String) | |
| index | RepositoryWebrefMetaTagIndices | Identifies the source of the Meta Content Tag segment in the Cdoc https://www.w3schools.com/tags/tag_meta.asp | integer | |
| metaName | RepositoryWebrefMetaTagIndices | Identifies the source of the Meta Content Tag segment in the Cdoc https://www.w3schools.com/tags/tag_meta.asp | String | |
| candidates | List of per-candidate signals derived from annotation of this query. | RepositoryWebrefNameDebugInfo | Collects signals from one query used for prior learning. | list(RepositoryWebrefNameDebugInfoCandidateInfo) |
| query | Query with region (language is set in parent NameInfo). | RepositoryWebrefNameDebugInfo | Collects signals from one query used for prior learning. | RepositoryWebrefLocalizedString |
| weight | Query weight used in learning. | RepositoryWebrefNameDebugInfo | Collects signals from one query used for prior learning. | number |
| isMatchlessResultContext | Whether the entity is purely from strong result entities, and is matchless in query annotation. | RepositoryWebrefNameDebugInfoCandidateInfo | Collects signals from one query and one candidate. Next available tag: 9 | boolean |
| mid | Mid of the candidate entity or empty string for the full world. | RepositoryWebrefNameDebugInfoCandidateInfo | Collects signals from one query and one candidate. Next available tag: 9 | String |
| name | Debug name of the entity (not usually populated). | RepositoryWebrefNameDebugInfoCandidateInfo | Collects signals from one query and one candidate. Next available tag: 9 | String |
| resultEntityScore | RepositoryWebrefNameDebugInfoCandidateInfo | Collects signals from one query and one candidate. Next available tag: 9 | number | |
| aggregatedScores | The score aggregated from all sources. | RepositoryWebrefNameInfo | Represents all information we have about a specific/localized name. Next available tag: 13. NOTE: If you add a field to the NameInfo proto and wish to retain it *after* the GlobalNameInfo merging steps in //r/w/enricher/pipeline:topic-enricher-flume-main then the appropriate combining logic for turning a flume stream of NameInfo protos into a single NameInfo must be updated with the new field in mind, in either or both of CombineContextNameInfosFn/CombineNameInfosFn. If not, the newly added field will be ignored during the merging steps (presumably because it is a transient field or a debug field that is not necessary to be retained). | RepositoryWebrefAggregatedEntityNameScores |
| annotatedCategory | Information on categories annotated on the range. | RepositoryWebrefNameInfo | Represents all information we have about a specific/localized name. Next available tag: 13. NOTE: If you add a field to the NameInfo proto and wish to retain it *after* the GlobalNameInfo merging steps in //r/w/enricher/pipeline:topic-enricher-flume-main then the appropriate combining logic for turning a flume stream of NameInfo protos into a single NameInfo must be updated with the new field in mind, in either or both of CombineContextNameInfosFn/CombineNameInfosFn. If not, the newly added field will be ignored during the merging steps (presumably because it is a transient field or a debug field that is not necessary to be retained). | list(RepositoryWebrefAnnotatedCategoryInfo) |
| debugDetails | DEBUG ONLY: stores a list of queries with per-candidate scores about signals used for prior learning. | RepositoryWebrefNameInfo | Represents all information we have about a specific/localized name. Next available tag: 13. NOTE: If you add a field to the NameInfo proto and wish to retain it *after* the GlobalNameInfo merging steps in //r/w/enricher/pipeline:topic-enricher-flume-main then the appropriate combining logic for turning a flume stream of NameInfo protos into a single NameInfo must be updated with the new field in mind, in either or both of CombineContextNameInfosFn/CombineNameInfosFn. If not, the newly added field will be ignored during the merging steps (presumably because it is a transient field or a debug field that is not necessary to be retained). | list(RepositoryWebrefNameDebugInfo) |
| includeInModel | Field which decides if this NameInfo should be included in model creation. | RepositoryWebrefNameInfo | Represents all information we have about a specific/localized name. Next available tag: 13. NOTE: If you add a field to the NameInfo proto and wish to retain it *after* the GlobalNameInfo merging steps in //r/w/enricher/pipeline:topic-enricher-flume-main then the appropriate combining logic for turning a flume stream of NameInfo protos into a single NameInfo must be updated with the new field in mind, in either or both of CombineContextNameInfosFn/CombineNameInfosFn. If not, the newly added field will be ignored during the merging steps (presumably because it is a transient field or a debug field that is not necessary to be retained). | boolean |
| name | The specific name to which this information applies. | RepositoryWebrefNameInfo | Represents all information we have about a specific/localized name. Next available tag: 13. NOTE: If you add a field to the NameInfo proto and wish to retain it *after* the GlobalNameInfo merging steps in //r/w/enricher/pipeline:topic-enricher-flume-main then the appropriate combining logic for turning a flume stream of NameInfo protos into a single NameInfo must be updated with the new field in mind, in either or both of CombineContextNameInfosFn/CombineNameInfosFn. If not, the newly added field will be ignored during the merging steps (presumably because it is a transient field or a debug field that is not necessary to be retained). | RepositoryWebrefLocalizedString |
| ngramData | N-gram data (e.g. n-gram IDF). | RepositoryWebrefNameInfo | Represents all information we have about a specific/localized name. Next available tag: 13. NOTE: If you add a field to the NameInfo proto and wish to retain it *after* the GlobalNameInfo merging steps in //r/w/enricher/pipeline:topic-enricher-flume-main then the appropriate combining logic for turning a flume stream of NameInfo protos into a single NameInfo must be updated with the new field in mind, in either or both of CombineContextNameInfosFn/CombineNameInfosFn. If not, the newly added field will be ignored during the merging steps (presumably because it is a transient field or a debug field that is not necessary to be retained). | RepositoryWebrefUniversalNgramData |
| perNameLightweightToken | Lightweight token semantic metadata for inflected name. | RepositoryWebrefNameInfo | Represents all information we have about a specific/localized name. Next available tag: 13. NOTE: If you add a field to the NameInfo proto and wish to retain it *after* the GlobalNameInfo merging steps in //r/w/enricher/pipeline:topic-enricher-flume-main then the appropriate combining logic for turning a flume stream of NameInfo protos into a single NameInfo must be updated with the new field in mind, in either or both of CombineContextNameInfosFn/CombineNameInfosFn. If not, the newly added field will be ignored during the merging steps (presumably because it is a transient field or a debug field that is not necessary to be retained). | RepositoryWebrefLightweightTokensPerNameLightweightToken |
| scores | The name-specific scores. These scores only depend on the name and are independent of the entity. | RepositoryWebrefNameInfo | Represents all information we have about a specific/localized name. Next available tag: 13. NOTE: If you add a field to the NameInfo proto and wish to retain it *after* the GlobalNameInfo merging steps in //r/w/enricher/pipeline:topic-enricher-flume-main then the appropriate combining logic for turning a flume stream of NameInfo protos into a single NameInfo must be updated with the new field in mind, in either or both of CombineContextNameInfosFn/CombineNameInfosFn. If not, the newly added field will be ignored during the merging steps (presumably because it is a transient field or a debug field that is not necessary to be retained). | RepositoryWebrefNameScores |
| source | The per-source scores. | RepositoryWebrefNameInfo | Represents all information we have about a specific/localized name. Next available tag: 13. NOTE: If you add a field to the NameInfo proto and wish to retain it *after* the GlobalNameInfo merging steps in //r/w/enricher/pipeline:topic-enricher-flume-main then the appropriate combining logic for turning a flume stream of NameInfo protos into a single NameInfo must be updated with the new field in mind, in either or both of CombineContextNameInfosFn/CombineNameInfosFn. If not, the newly added field will be ignored during the merging steps (presumably because it is a transient field or a debug field that is not necessary to be retained). | list(RepositoryWebrefEntityNameSource) |
| completeWorldVolume | Approximates volume of this name including entities we don’t have in our set. This is useful to estimate the size of the “open world”. For example, this field can be equal to the total number of clicks for the query. Note that for now, we ignore the number of clicks but just use the idf if available. | RepositoryWebrefNameScores | Represents some name-specific scores. (Unlike EntityNameScore, these scores are independent of the entities the name is associated with). These scores are available for each name as well as for each name/source. Next available tag: 31. | number |
| contextFringeScore | The fringe score in [0, 1] for this context name. This is only populated for full-query context names. | RepositoryWebrefNameScores | Represents some name-specific scores. (Unlike EntityNameScore, these scores are independent of the entities the name is associated with). These scores are available for each name as well as for each name/source. Next available tag: 31. | number |
| contextWeight | The amount of evidence available for this context name. | RepositoryWebrefNameScores | Represents some name-specific scores. (Unlike EntityNameScore, these scores are independent of the entities the name is associated with). These scores are available for each name as well as for each name/source. Next available tag: 31. | number |
| idfScore | The idf of this name. | RepositoryWebrefNameScores | Represents some name-specific scores. (Unlike EntityNameScore, these scores are independent of the entities the name is associated with). These scores are available for each name as well as for each name/source. Next available tag: 31. | number |
| openWorldVolumeModifier | ‘Raw’ open world is computed based on ngram count data. For some names however, we modify the open world based on entities associated with them. This field contains the additive open world modifier. open_world_volume = raw open world + open_world_volume_modifier | RepositoryWebrefNameScores | Represents some name-specific scores. (Unlike EntityNameScore, these scores are independent of the entities the name is associated with). These scores are available for each name as well as for each name/source. Next available tag: 31. | number |
| totalScore | The total score of that name/source. It describes how much data we have for that name/source. It can for example be the sum of all the entity scores for this name. | RepositoryWebrefNameScores | Represents some name-specific scores. (Unlike EntityNameScore, these scores are independent of the entities the name is associated with). These scores are available for each name as well as for each name/source. Next available tag: 31. | number |
| mention | The entities that were annotated on the context | RepositoryWebrefNgramContext | An N-gram context encountered on the document. | list(RepositoryWebrefNgramMention) |
| text | The context (original) text. | RepositoryWebrefNgramContext | An N-gram context encountered on the document. | String |
| weight | The weight of the context on the document; depends on how many times we saw the string in the document. | RepositoryWebrefNgramContext | An N-gram context encountered on the document. | number |
| mid | The entity the mention was referring to. | RepositoryWebrefNgramMention | A mention that has been matched in the context (or a substring of it). | String |
| score | The average score the mention was given across all occurrences of the n-gram. | RepositoryWebrefNgramMention | A mention that has been matched in the context (or a substring of it). | number |
| featureType | The Oyster feature type, which provides a rough categorization. This is a value of the enum geostore.FeatureProto.TypeCategory. | RepositoryWebrefOysterType | Oyster type information. | integer |
| contentRelevant | RepositoryWebrefPerDocRelevanceRating | Per document ratings relevance ratings. Next id: 21. | String | |
| displayString | How this rating is displayed in the evals, pre-computed from the other fields. | RepositoryWebrefPerDocRelevanceRating | Per document ratings relevance ratings. Next id: 21. | String |
| furballUrl | The url of the ewok task that resulted in this rating. Example: https://furball.corp.google.com/project/view-item?itemId=1&projectId=2 | RepositoryWebrefPerDocRelevanceRating | Per document ratings relevance ratings. Next id: 21. | String |
| itemId | RepositoryWebrefPerDocRelevanceRating | Per document ratings relevance ratings. Next id: 21. | String | |
| pageIsAboutChain | If the topic is about a business chain, whether the | RepositoryWebrefPerDocRelevanceRating | Per document ratings relevance ratings. Next id: 21. | String |
| projectId | Metadata for task-level ratings. Not filled for aggregated doc-level ratings. | RepositoryWebrefPerDocRelevanceRating | Per document ratings relevance ratings. Next id: 21. | String |
| raterCanUnderstandTopic | Whether rater can understand the topic. | RepositoryWebrefPerDocRelevanceRating | Per document ratings relevance ratings. Next id: 21. | boolean |
| taskDetails | RepositoryWebrefPerDocRelevanceRating | Per document ratings relevance ratings. Next id: 21. | RepositoryWebrefTaskDetails | |
| taskId | RepositoryWebrefPerDocRelevanceRating | Per document ratings relevance ratings. Next id: 21. | String | |
| topicIsChain | Whether the topic is about a business chain. | RepositoryWebrefPerDocRelevanceRating | Per document ratings relevance ratings. Next id: 21. | String |
| docFp | – In topicality ratings this is Fingerprint2011() of the normalized cdoc. – In query-mention ratings this is a hash of the QueryJoin. – In doc-content-mention ratings this is a hash of a QueryJoin in which the mention rating task has been embedded. – | RepositoryWebrefPerDocRelevanceRatings | Aggregates ratings by url/doc_fp. | String |
| entityNameRating | RepositoryWebrefPerDocRelevanceRatings | Aggregates ratings by url/doc_fp. | list(RepositoryWebrefEntityNameRatings) | |
| mentionRating | RepositoryWebrefPerDocRelevanceRatings | Aggregates ratings by url/doc_fp. | list(RepositoryWebrefMentionRatings) | |
| taskLevelRating | RepositoryWebrefPerDocRelevanceRatings | Aggregates ratings by url/doc_fp. | list(RepositoryWebrefPerDocRelevanceRating) | |
| url | – In topicality ratings this is the url of the document. – In query-mention ratings this is the query in format “en:US:query text”. – In doc-content-mention ratings this is %x:%s where %x is the hex doc_fp of the cdoc (TODO(b/139799592) or sometimes the doc_fp below), and %s is the text of the eval range. – In entity-name ratings this is the MID of the entity. | RepositoryWebrefPerDocRelevanceRatings | Aggregates ratings by url/doc_fp. | String |
| score | Score corresponding to some kind of biasing strength which was applied. The exact semantics of this score is subject to further changes. Don’t make assumptions about specific values or ranges. Values > 0 represents that a boost was applied. Values < 0 represents that a penalty was appled. | RepositoryWebrefPersonalizationContextOutput | Key-Value-like message to store values associated with a personalization type. Next id: 3 | number |
| type | RepositoryWebrefPersonalizationContextOutput | Key-Value-like message to store values associated with a personalization type. Next id: 3 | String | |
| outputs | Detailed output scores per personalization type. | RepositoryWebrefPersonalizationContextOutputs | Details about personalization and contextual scoring decisions from Personalized Query Understanding (go/pqu). This message represents information about what kind of biasing was applied, including what type of data were used and how strongly. Intended to be used by client code for fine-tuning necessary ranking or triggering logic if it’s not possible to rely on the aggregated annotation confidence alone. To minimize unwanted dependencies and incorrect usage of the data this proto has restricted visibility. Please reach out to [email protected] if you want to have access. Next id: 2 | list(RepositoryWebrefPersonalizationContextOutput) |
| isBypassedName | There is a limit of entities per name for which we can keep name signals and score. This flag is set to true for names that by-passed per-name-scoring, as there were too many entities for the name. | RepositoryWebrefPreprocessingNameEntityMetadata | Metadata about a name. There are two metadata protos, whose content is meant to be similar but their usage different: NameEntityMetadata for readability and ConceptNameMetadata for size / decoding speed. NameEntityMetadata is propagated to GlobalNameInfo and EntityJoin tables, while ConceptNameMetadata is propagated from EntityJoins to the name matching tables and later to the Webref’s/QRef’s output. To add a new metadata field in the Names pipeline, and propagate it to EntityJoins and Names matching tables, it is necessary to: (1) Add the field to NameEntityMetadata, and a corresponding data representation in ConceptNameMetadata. (2) Populate the field in NameVariantSignals.name_metadata, from any source. This can be done in a corresponding NameProcessor. (3) Update the library name-metadata.h/cc to make sure that the metadata field is: a) merged correctly when merging two NameSignals; and b) transformed to the corresponding field in ConceptNameMetadata proto. Next available tag: 22. | boolean |
| isCompoundName | This name is a generated compound name to pass primary pruning. | RepositoryWebrefPreprocessingNameEntityMetadata | Metadata about a name. There are two metadata protos, whose content is meant to be similar but their usage different: NameEntityMetadata for readability and ConceptNameMetadata for size / decoding speed. NameEntityMetadata is propagated to GlobalNameInfo and EntityJoin tables, while ConceptNameMetadata is propagated from EntityJoins to the name matching tables and later to the Webref’s/QRef’s output. To add a new metadata field in the Names pipeline, and propagate it to EntityJoins and Names matching tables, it is necessary to: (1) Add the field to NameEntityMetadata, and a corresponding data representation in ConceptNameMetadata. (2) Populate the field in NameVariantSignals.name_metadata, from any source. This can be done in a corresponding NameProcessor. (3) Update the library name-metadata.h/cc to make sure that the metadata field is: a) merged correctly when merging two NameSignals; and b) transformed to the corresponding field in ConceptNameMetadata proto. Next available tag: 22. | boolean |
| isCompoundRetrievalKey | Indicates special compound retrieval keys, like “Compound $mid1 $mid2” | RepositoryWebrefPreprocessingNameEntityMetadata | Metadata about a name. There are two metadata protos, whose content is meant to be similar but their usage different: NameEntityMetadata for readability and ConceptNameMetadata for size / decoding speed. NameEntityMetadata is propagated to GlobalNameInfo and EntityJoin tables, while ConceptNameMetadata is propagated from EntityJoins to the name matching tables and later to the Webref’s/QRef’s output. To add a new metadata field in the Names pipeline, and propagate it to EntityJoins and Names matching tables, it is necessary to: (1) Add the field to NameEntityMetadata, and a corresponding data representation in ConceptNameMetadata. (2) Populate the field in NameVariantSignals.name_metadata, from any source. This can be done in a corresponding NameProcessor. (3) Update the library name-metadata.h/cc to make sure that the metadata field is: a) merged correctly when merging two NameSignals; and b) transformed to the corresponding field in ConceptNameMetadata proto. Next available tag: 22. | boolean |
| isDictionaryTerm | This is set to true if the entity corresponds to a dictionary term. | RepositoryWebrefPreprocessingNameEntityMetadata | Metadata about a name. There are two metadata protos, whose content is meant to be similar but their usage different: NameEntityMetadata for readability and ConceptNameMetadata for size / decoding speed. NameEntityMetadata is propagated to GlobalNameInfo and EntityJoin tables, while ConceptNameMetadata is propagated from EntityJoins to the name matching tables and later to the Webref’s/QRef’s output. To add a new metadata field in the Names pipeline, and propagate it to EntityJoins and Names matching tables, it is necessary to: (1) Add the field to NameEntityMetadata, and a corresponding data representation in ConceptNameMetadata. (2) Populate the field in NameVariantSignals.name_metadata, from any source. This can be done in a corresponding NameProcessor. (3) Update the library name-metadata.h/cc to make sure that the metadata field is: a) merged correctly when merging two NameSignals; and b) transformed to the corresponding field in ConceptNameMetadata proto. Next available tag: 22. | boolean |
| isEventRetrievalKey | If true, this name is an event retrieval key. | RepositoryWebrefPreprocessingNameEntityMetadata | Metadata about a name. There are two metadata protos, whose content is meant to be similar but their usage different: NameEntityMetadata for readability and ConceptNameMetadata for size / decoding speed. NameEntityMetadata is propagated to GlobalNameInfo and EntityJoin tables, while ConceptNameMetadata is propagated from EntityJoins to the name matching tables and later to the Webref’s/QRef’s output. To add a new metadata field in the Names pipeline, and propagate it to EntityJoins and Names matching tables, it is necessary to: (1) Add the field to NameEntityMetadata, and a corresponding data representation in ConceptNameMetadata. (2) Populate the field in NameVariantSignals.name_metadata, from any source. This can be done in a corresponding NameProcessor. (3) Update the library name-metadata.h/cc to make sure that the metadata field is: a) merged correctly when merging two NameSignals; and b) transformed to the corresponding field in ConceptNameMetadata proto. Next available tag: 22. | boolean |
| isGeneratedName | This name is generated from other names. | RepositoryWebrefPreprocessingNameEntityMetadata | Metadata about a name. There are two metadata protos, whose content is meant to be similar but their usage different: NameEntityMetadata for readability and ConceptNameMetadata for size / decoding speed. NameEntityMetadata is propagated to GlobalNameInfo and EntityJoin tables, while ConceptNameMetadata is propagated from EntityJoins to the name matching tables and later to the Webref’s/QRef’s output. To add a new metadata field in the Names pipeline, and propagate it to EntityJoins and Names matching tables, it is necessary to: (1) Add the field to NameEntityMetadata, and a corresponding data representation in ConceptNameMetadata. (2) Populate the field in NameVariantSignals.name_metadata, from any source. This can be done in a corresponding NameProcessor. (3) Update the library name-metadata.h/cc to make sure that the metadata field is: a) merged correctly when merging two NameSignals; and b) transformed to the corresponding field in ConceptNameMetadata proto. Next available tag: 22. | boolean |
| isGeneratedStreetname | This name is a generated street name. | RepositoryWebrefPreprocessingNameEntityMetadata | Metadata about a name. There are two metadata protos, whose content is meant to be similar but their usage different: NameEntityMetadata for readability and ConceptNameMetadata for size / decoding speed. NameEntityMetadata is propagated to GlobalNameInfo and EntityJoin tables, while ConceptNameMetadata is propagated from EntityJoins to the name matching tables and later to the Webref’s/QRef’s output. To add a new metadata field in the Names pipeline, and propagate it to EntityJoins and Names matching tables, it is necessary to: (1) Add the field to NameEntityMetadata, and a corresponding data representation in ConceptNameMetadata. (2) Populate the field in NameVariantSignals.name_metadata, from any source. This can be done in a corresponding NameProcessor. (3) Update the library name-metadata.h/cc to make sure that the metadata field is: a) merged correctly when merging two NameSignals; and b) transformed to the corresponding field in ConceptNameMetadata proto. Next available tag: 22. | boolean |
| isHierarchyPropagated | This name is added by name propagation in hierarchy. | RepositoryWebrefPreprocessingNameEntityMetadata | Metadata about a name. There are two metadata protos, whose content is meant to be similar but their usage different: NameEntityMetadata for readability and ConceptNameMetadata for size / decoding speed. NameEntityMetadata is propagated to GlobalNameInfo and EntityJoin tables, while ConceptNameMetadata is propagated from EntityJoins to the name matching tables and later to the Webref’s/QRef’s output. To add a new metadata field in the Names pipeline, and propagate it to EntityJoins and Names matching tables, it is necessary to: (1) Add the field to NameEntityMetadata, and a corresponding data representation in ConceptNameMetadata. (2) Populate the field in NameVariantSignals.name_metadata, from any source. This can be done in a corresponding NameProcessor. (3) Update the library name-metadata.h/cc to make sure that the metadata field is: a) merged correctly when merging two NameSignals; and b) transformed to the corresponding field in ConceptNameMetadata proto. Next available tag: 22. | boolean |
| isIsbn | This name is an ISBN. | RepositoryWebrefPreprocessingNameEntityMetadata | Metadata about a name. There are two metadata protos, whose content is meant to be similar but their usage different: NameEntityMetadata for readability and ConceptNameMetadata for size / decoding speed. NameEntityMetadata is propagated to GlobalNameInfo and EntityJoin tables, while ConceptNameMetadata is propagated from EntityJoins to the name matching tables and later to the Webref’s/QRef’s output. To add a new metadata field in the Names pipeline, and propagate it to EntityJoins and Names matching tables, it is necessary to: (1) Add the field to NameEntityMetadata, and a corresponding data representation in ConceptNameMetadata. (2) Populate the field in NameVariantSignals.name_metadata, from any source. This can be done in a corresponding NameProcessor. (3) Update the library name-metadata.h/cc to make sure that the metadata field is: a) merged correctly when merging two NameSignals; and b) transformed to the corresponding field in ConceptNameMetadata proto. Next available tag: 22. | boolean |
| isLyricsContent | This name comes from recording lyrics content. | RepositoryWebrefPreprocessingNameEntityMetadata | Metadata about a name. There are two metadata protos, whose content is meant to be similar but their usage different: NameEntityMetadata for readability and ConceptNameMetadata for size / decoding speed. NameEntityMetadata is propagated to GlobalNameInfo and EntityJoin tables, while ConceptNameMetadata is propagated from EntityJoins to the name matching tables and later to the Webref’s/QRef’s output. To add a new metadata field in the Names pipeline, and propagate it to EntityJoins and Names matching tables, it is necessary to: (1) Add the field to NameEntityMetadata, and a corresponding data representation in ConceptNameMetadata. (2) Populate the field in NameVariantSignals.name_metadata, from any source. This can be done in a corresponding NameProcessor. (3) Update the library name-metadata.h/cc to make sure that the metadata field is: a) merged correctly when merging two NameSignals; and b) transformed to the corresponding field in ConceptNameMetadata proto. Next available tag: 22. | boolean |
| isPhoneNumber | This name is a phone number. | RepositoryWebrefPreprocessingNameEntityMetadata | Metadata about a name. There are two metadata protos, whose content is meant to be similar but their usage different: NameEntityMetadata for readability and ConceptNameMetadata for size / decoding speed. NameEntityMetadata is propagated to GlobalNameInfo and EntityJoin tables, while ConceptNameMetadata is propagated from EntityJoins to the name matching tables and later to the Webref’s/QRef’s output. To add a new metadata field in the Names pipeline, and propagate it to EntityJoins and Names matching tables, it is necessary to: (1) Add the field to NameEntityMetadata, and a corresponding data representation in ConceptNameMetadata. (2) Populate the field in NameVariantSignals.name_metadata, from any source. This can be done in a corresponding NameProcessor. (3) Update the library name-metadata.h/cc to make sure that the metadata field is: a) merged correctly when merging two NameSignals; and b) transformed to the corresponding field in ConceptNameMetadata proto. Next available tag: 22. | boolean |
| isRefconName | This name is used for refcon. | RepositoryWebrefPreprocessingNameEntityMetadata | Metadata about a name. There are two metadata protos, whose content is meant to be similar but their usage different: NameEntityMetadata for readability and ConceptNameMetadata for size / decoding speed. NameEntityMetadata is propagated to GlobalNameInfo and EntityJoin tables, while ConceptNameMetadata is propagated from EntityJoins to the name matching tables and later to the Webref’s/QRef’s output. To add a new metadata field in the Names pipeline, and propagate it to EntityJoins and Names matching tables, it is necessary to: (1) Add the field to NameEntityMetadata, and a corresponding data representation in ConceptNameMetadata. (2) Populate the field in NameVariantSignals.name_metadata, from any source. This can be done in a corresponding NameProcessor. (3) Update the library name-metadata.h/cc to make sure that the metadata field is: a) merged correctly when merging two NameSignals; and b) transformed to the corresponding field in ConceptNameMetadata proto. Next available tag: 22. | boolean |
| isReferenceName | This name is a reference name, only for internal usage, this name should not go into matching table without support of other signals. | RepositoryWebrefPreprocessingNameEntityMetadata | Metadata about a name. There are two metadata protos, whose content is meant to be similar but their usage different: NameEntityMetadata for readability and ConceptNameMetadata for size / decoding speed. NameEntityMetadata is propagated to GlobalNameInfo and EntityJoin tables, while ConceptNameMetadata is propagated from EntityJoins to the name matching tables and later to the Webref’s/QRef’s output. To add a new metadata field in the Names pipeline, and propagate it to EntityJoins and Names matching tables, it is necessary to: (1) Add the field to NameEntityMetadata, and a corresponding data representation in ConceptNameMetadata. (2) Populate the field in NameVariantSignals.name_metadata, from any source. This can be done in a corresponding NameProcessor. (3) Update the library name-metadata.h/cc to make sure that the metadata field is: a) merged correctly when merging two NameSignals; and b) transformed to the corresponding field in ConceptNameMetadata proto. Next available tag: 22. | boolean |
| isRefpageUrl | This name is the URL of a reference page. | RepositoryWebrefPreprocessingNameEntityMetadata | Metadata about a name. There are two metadata protos, whose content is meant to be similar but their usage different: NameEntityMetadata for readability and ConceptNameMetadata for size / decoding speed. NameEntityMetadata is propagated to GlobalNameInfo and EntityJoin tables, while ConceptNameMetadata is propagated from EntityJoins to the name matching tables and later to the Webref’s/QRef’s output. To add a new metadata field in the Names pipeline, and propagate it to EntityJoins and Names matching tables, it is necessary to: (1) Add the field to NameEntityMetadata, and a corresponding data representation in ConceptNameMetadata. (2) Populate the field in NameVariantSignals.name_metadata, from any source. This can be done in a corresponding NameProcessor. (3) Update the library name-metadata.h/cc to make sure that the metadata field is: a) merged correctly when merging two NameSignals; and b) transformed to the corresponding field in ConceptNameMetadata proto. Next available tag: 22. | boolean |
| isReverseUniquePropertyName | This name is generated from a reverse unique property of the entity. | RepositoryWebrefPreprocessingNameEntityMetadata | Metadata about a name. There are two metadata protos, whose content is meant to be similar but their usage different: NameEntityMetadata for readability and ConceptNameMetadata for size / decoding speed. NameEntityMetadata is propagated to GlobalNameInfo and EntityJoin tables, while ConceptNameMetadata is propagated from EntityJoins to the name matching tables and later to the Webref’s/QRef’s output. To add a new metadata field in the Names pipeline, and propagate it to EntityJoins and Names matching tables, it is necessary to: (1) Add the field to NameEntityMetadata, and a corresponding data representation in ConceptNameMetadata. (2) Populate the field in NameVariantSignals.name_metadata, from any source. This can be done in a corresponding NameProcessor. (3) Update the library name-metadata.h/cc to make sure that the metadata field is: a) merged correctly when merging two NameSignals; and b) transformed to the corresponding field in ConceptNameMetadata proto. Next available tag: 22. | boolean |
| isStrongIdentifier | This name is a strong identifier for this entity. | RepositoryWebrefPreprocessingNameEntityMetadata | Metadata about a name. There are two metadata protos, whose content is meant to be similar but their usage different: NameEntityMetadata for readability and ConceptNameMetadata for size / decoding speed. NameEntityMetadata is propagated to GlobalNameInfo and EntityJoin tables, while ConceptNameMetadata is propagated from EntityJoins to the name matching tables and later to the Webref’s/QRef’s output. To add a new metadata field in the Names pipeline, and propagate it to EntityJoins and Names matching tables, it is necessary to: (1) Add the field to NameEntityMetadata, and a corresponding data representation in ConceptNameMetadata. (2) Populate the field in NameVariantSignals.name_metadata, from any source. This can be done in a corresponding NameProcessor. (3) Update the library name-metadata.h/cc to make sure that the metadata field is: a) merged correctly when merging two NameSignals; and b) transformed to the corresponding field in ConceptNameMetadata proto. Next available tag: 22. | boolean |
| isSynonymOrFuzzyMatch | Set if the name is coming from synonyms. | RepositoryWebrefPreprocessingNameEntityMetadata | Metadata about a name. There are two metadata protos, whose content is meant to be similar but their usage different: NameEntityMetadata for readability and ConceptNameMetadata for size / decoding speed. NameEntityMetadata is propagated to GlobalNameInfo and EntityJoin tables, while ConceptNameMetadata is propagated from EntityJoins to the name matching tables and later to the Webref’s/QRef’s output. To add a new metadata field in the Names pipeline, and propagate it to EntityJoins and Names matching tables, it is necessary to: (1) Add the field to NameEntityMetadata, and a corresponding data representation in ConceptNameMetadata. (2) Populate the field in NameVariantSignals.name_metadata, from any source. This can be done in a corresponding NameProcessor. (3) Update the library name-metadata.h/cc to make sure that the metadata field is: a) merged correctly when merging two NameSignals; and b) transformed to the corresponding field in ConceptNameMetadata proto. Next available tag: 22. | boolean |
| isTrustedAllcapsName | If true, this name is a trusted name if it is in ALLCAPS. | RepositoryWebrefPreprocessingNameEntityMetadata | Metadata about a name. There are two metadata protos, whose content is meant to be similar but their usage different: NameEntityMetadata for readability and ConceptNameMetadata for size / decoding speed. NameEntityMetadata is propagated to GlobalNameInfo and EntityJoin tables, while ConceptNameMetadata is propagated from EntityJoins to the name matching tables and later to the Webref’s/QRef’s output. To add a new metadata field in the Names pipeline, and propagate it to EntityJoins and Names matching tables, it is necessary to: (1) Add the field to NameEntityMetadata, and a corresponding data representation in ConceptNameMetadata. (2) Populate the field in NameVariantSignals.name_metadata, from any source. This can be done in a corresponding NameProcessor. (3) Update the library name-metadata.h/cc to make sure that the metadata field is: a) merged correctly when merging two NameSignals; and b) transformed to the corresponding field in ConceptNameMetadata proto. Next available tag: 22. | boolean |
| isUnnormalizedName | If true, do not do tokenization when compute fprint hash for this name. | RepositoryWebrefPreprocessingNameEntityMetadata | Metadata about a name. There are two metadata protos, whose content is meant to be similar but their usage different: NameEntityMetadata for readability and ConceptNameMetadata for size / decoding speed. NameEntityMetadata is propagated to GlobalNameInfo and EntityJoin tables, while ConceptNameMetadata is propagated from EntityJoins to the name matching tables and later to the Webref’s/QRef’s output. To add a new metadata field in the Names pipeline, and propagate it to EntityJoins and Names matching tables, it is necessary to: (1) Add the field to NameEntityMetadata, and a corresponding data representation in ConceptNameMetadata. (2) Populate the field in NameVariantSignals.name_metadata, from any source. This can be done in a corresponding NameProcessor. (3) Update the library name-metadata.h/cc to make sure that the metadata field is: a) merged correctly when merging two NameSignals; and b) transformed to the corresponding field in ConceptNameMetadata proto. Next available tag: 22. | boolean |
| notGeneratedName | This name is clearly not generated(aka. at least one source of this name is not generated). This field is added for simplifying generated name tag while merging. Do not use this metadata directly. | RepositoryWebrefPreprocessingNameEntityMetadata | Metadata about a name. There are two metadata protos, whose content is meant to be similar but their usage different: NameEntityMetadata for readability and ConceptNameMetadata for size / decoding speed. NameEntityMetadata is propagated to GlobalNameInfo and EntityJoin tables, while ConceptNameMetadata is propagated from EntityJoins to the name matching tables and later to the Webref’s/QRef’s output. To add a new metadata field in the Names pipeline, and propagate it to EntityJoins and Names matching tables, it is necessary to: (1) Add the field to NameEntityMetadata, and a corresponding data representation in ConceptNameMetadata. (2) Populate the field in NameVariantSignals.name_metadata, from any source. This can be done in a corresponding NameProcessor. (3) Update the library name-metadata.h/cc to make sure that the metadata field is: a) merged correctly when merging two NameSignals; and b) transformed to the corresponding field in ConceptNameMetadata proto. Next available tag: 22. | boolean |
| originalNames | Original versions of the name (before normalization). Used as query for the entity by Explicit Entity Search. | RepositoryWebrefPreprocessingNameEntityMetadata | Metadata about a name. There are two metadata protos, whose content is meant to be similar but their usage different: NameEntityMetadata for readability and ConceptNameMetadata for size / decoding speed. NameEntityMetadata is propagated to GlobalNameInfo and EntityJoin tables, while ConceptNameMetadata is propagated from EntityJoins to the name matching tables and later to the Webref’s/QRef’s output. To add a new metadata field in the Names pipeline, and propagate it to EntityJoins and Names matching tables, it is necessary to: (1) Add the field to NameEntityMetadata, and a corresponding data representation in ConceptNameMetadata. (2) Populate the field in NameVariantSignals.name_metadata, from any source. This can be done in a corresponding NameProcessor. (3) Update the library name-metadata.h/cc to make sure that the metadata field is: a) merged correctly when merging two NameSignals; and b) transformed to the corresponding field in ConceptNameMetadata proto. Next available tag: 22. | RepositoryWebrefPreprocessingOriginalNames |
| suppressTokenization | Whether or not to suppress tokenization on this name. | RepositoryWebrefPreprocessingNameEntityMetadata | Metadata about a name. There are two metadata protos, whose content is meant to be similar but their usage different: NameEntityMetadata for readability and ConceptNameMetadata for size / decoding speed. NameEntityMetadata is propagated to GlobalNameInfo and EntityJoin tables, while ConceptNameMetadata is propagated from EntityJoins to the name matching tables and later to the Webref’s/QRef’s output. To add a new metadata field in the Names pipeline, and propagate it to EntityJoins and Names matching tables, it is necessary to: (1) Add the field to NameEntityMetadata, and a corresponding data representation in ConceptNameMetadata. (2) Populate the field in NameVariantSignals.name_metadata, from any source. This can be done in a corresponding NameProcessor. (3) Update the library name-metadata.h/cc to make sure that the metadata field is: a) merged correctly when merging two NameSignals; and b) transformed to the corresponding field in ConceptNameMetadata proto. Next available tag: 22. | boolean |
| priorScore | An unnormalized measure of how much evidence we have that this name variant refers to the key entity. Should be comparable to all scores from the same source for: – other entities having the same name variant – the open world score computed for this name variant | RepositoryWebrefPreprocessingNameEntityScores | Abstract, source independent scores. Next available tag: 7 | float |
| volumeBasedScore | Prior score come from source that is quantifiable. artificial_score = prior_score – volume_based_score. | RepositoryWebrefPreprocessingNameEntityScores | Abstract, source independent scores. Next available tag: 7 | float |
| scores | Common prior_score/trust proto This field is shared by all sources providing this kind of data, the information has to be considered in context with the source. | RepositoryWebrefPreprocessingNameVariantSignals | Next available tag: 33. | RepositoryWebrefPreprocessingNameEntityScores |
| source | The source of this NameVariantSignals proto | RepositoryWebrefPreprocessingNameVariantSignals | Next available tag: 33. | String |
| count | The total number of original names that a normalized name has (all versions from all different sources). | RepositoryWebrefPreprocessingOriginalNames | integer | |
| name | RepositoryWebrefPreprocessingOriginalNames | list(RepositoryWebrefPreprocessingOriginalNamesOriginalName) | ||
| count | The total number of different sources from where this version of the original name comes from. | RepositoryWebrefPreprocessingOriginalNamesOriginalName | integer | |
| score | Score estimating how good this original name is: – some sources are considered more authoritative than others (e.g. KG) – a name found in more sources is better. | RepositoryWebrefPreprocessingOriginalNamesOriginalName | float | |
| source | The sources this name comes from. | RepositoryWebrefPreprocessingOriginalNamesOriginalName | list(integer) | |
| text | One original name version. | RepositoryWebrefPreprocessingOriginalNamesOriginalName | String | |
| source | The sources the url was suggested by. | RepositoryWebrefPreprocessingUrlMatchingMetadata | Proto with metadata related to why a particular cdoc was selected for an entityjoin. | list(RepositoryWebrefPreprocessingUrlSourceInfo) |
| originalUrl | RepositoryWebrefPreprocessingUrlSourceInfo | Information about where the url comes from. | String | |
| source | RepositoryWebrefPreprocessingUrlSourceInfo | Information about where the url comes from. | String | |
| name | RepositoryWebrefProcessorCounter | A single processor counter stored as a pair of the counter name and the value. | String | |
| value | RepositoryWebrefProcessorCounter | A single processor counter stored as a pair of the counter name and the value. | integer | |
| cpuInstructions | Cpu instructions spent. | RepositoryWebrefProcessorTiming | Processor timings as produced by NestedPerfCounter, see google3/repository/webref/base/nested-perf-counter.h. | String |
| name | A string identifying the processor timing context. | RepositoryWebrefProcessorTiming | Processor timings as produced by NestedPerfCounter, see google3/repository/webref/base/nested-perf-counter.h. | String |
| processorCounters | Document counters defined by processors. A processor can add and increment counters with NestedPerfCounter::IncrementCounterBy. See go/webref-annotator-metrics. | RepositoryWebrefProcessorTiming | Processor timings as produced by NestedPerfCounter, see google3/repository/webref/base/nested-perf-counter.h. | list(RepositoryWebrefProcessorCounter) |
| processorTimings | Nested measurements, see NestedPerfCounter::ScopedPerfCounter. | RepositoryWebrefProcessorTiming | Processor timings as produced by NestedPerfCounter, see google3/repository/webref/base/nested-perf-counter.h. | list(RepositoryWebrefProcessorTiming) |
| wallTimeNs | Wall time (in nanoseconds). | RepositoryWebrefProcessorTiming | Processor timings as produced by NestedPerfCounter, see google3/repository/webref/base/nested-perf-counter.h. | String |
| productLineId | Shopping product line ids (typically moka product line tag) of this entity. Represents shopping product lines, such as iPhone or Canon EOS. Typically, we expect only one id. But keeping repeated, in case we want to merge or aggregate product lines. Using int64, as tag_id in commerce/datastore/processors/moka/proto/moka_annotations.proto. | RepositoryWebrefProductMetadata | Products-specific information about the entity. Only available in QrefMetadata output. Next available tag: 16. | list(String) |
| shoppingIds | All ShoppingIds for this MID that need to be copied to IntentQuery (FunctionCall) if this MID is used in intent generation. See go/iql-shopping-ids for details. | RepositoryWebrefProductMetadata | Products-specific information about the entity. Only available in QrefMetadata output. Next available tag: 16. | KnowledgeAnswersIntentQueryShoppingIds |
| variantClusterId | All unique variant cluster ids (shopping’s GPCs) of this entity. | RepositoryWebrefProductMetadata | Products-specific information about the entity. Only available in QrefMetadata output. Next available tag: 16. | list(String) |
| featuresIndex | The set of indices in the NavBoostQuery::features() array that belong to the collapsed features. | RepositoryWebrefQueryIndices | Identifies a set of NavBoost queries in the CompositeDoc. Typically these queries were collapsed by WebRef into a single query and they were treated by the annotator as equivalent. They all contain the same mentions (at the same offsets). | list(integer) |
| queriesIndex | The index of the query in NavBoostDocument::queries() array. | RepositoryWebrefQueryIndices | Identifies a set of NavBoost queries in the CompositeDoc. Typically these queries were collapsed by WebRef into a single query and they were treated by the annotator as equivalent. They all contain the same mentions (at the same offsets). | integer |
| segmentMentions | The actual mentions. Note SegmentMentions contains some fields specific to entity annotation, and those are typically not populated here. | RepositoryWebrefRangeAnnotations | The fields hold “non-entity” annotations of text. | list(RepositoryWebrefSegmentMentions) |
| type | The type of ranges contained in this message. | RepositoryWebrefRangeAnnotations | The fields hold “non-entity” annotations of text. | String |
| beginOffset | Start index of range (within the segment) being annotated. | RepositoryWebrefRangeMetadata | Metadata keeper for an annotated range of a segment. Next available tag: 3. | integer |
| tokenCount | Number of tokens in the range being annotated. | RepositoryWebrefRangeMetadata | Metadata keeper for an annotated range of a segment. Next available tag: 3. | integer |
| mentionSpan | Per token mention spans. | RepositoryWebrefRefconDocumentMentionSpans | Encapsulates the textual mention spans extracted from a document, split per token. | list(RepositoryWebrefRefconMentionSpans) |
| segment | Segment types in which the mention appears. Now deprecated, because we only care about CONTENT segments. | RepositoryWebrefRefconMentionSpans | Describes a mention annotated by Webref in the given document. | list(String) |
| shortToken | Fingerprinted tokens which form the mention span. We are using 32-bit instead of usual 64bit fingerprints – this greatly reduces the memory footprint while still keeping the chance of collision reasonably low for our specific use case (1 in 4 billion). | RepositoryWebrefRefconMentionSpans | Describes a mention annotated by Webref in the given document. | list(integer) |
| token | Fingerprinted tokens which form the mention span. | RepositoryWebrefRefconMentionSpans | Describes a mention annotated by Webref in the given document. | list(String) |
| aggregatedQueryCount | Total query count for the document from all the query terms. Can be used to estimate the popularity of the document. | RepositoryWebrefRefconQueryStats | Contains high level search query statistics of the document. | float |
| queryStats | RepositoryWebrefRefconRefconDocumentMetadata | Encapsulates additional CDoc metadata needed by Refcon. | RepositoryWebrefRefconQueryStats | |
| confidence | RepositoryWebrefRefconRefconNameInfo | Refcon name representation in split concepts sstable. This is a simplified version of repository_webref.GlobalNameInfo. | number | |
| idfScore | RepositoryWebrefRefconRefconNameInfo | Refcon name representation in split concepts sstable. This is a simplified version of repository_webref.GlobalNameInfo. | number | |
| isGeneratedName | RepositoryWebrefRefconRefconNameInfo | Refcon name representation in split concepts sstable. This is a simplified version of repository_webref.GlobalNameInfo. | boolean | |
| isI18nName | RepositoryWebrefRefconRefconNameInfo | Refcon name representation in split concepts sstable. This is a simplified version of repository_webref.GlobalNameInfo. | boolean | |
| isStrongIdentifier | RepositoryWebrefRefconRefconNameInfo | Refcon name representation in split concepts sstable. This is a simplified version of repository_webref.GlobalNameInfo. | boolean | |
| isTranslatedName | RepositoryWebrefRefconRefconNameInfo | Refcon name representation in split concepts sstable. This is a simplified version of repository_webref.GlobalNameInfo. | boolean | |
| language | Languages of the name, unknown language is not kept. TODO(b/145976266) Don’t use the deprecated language enum. | RepositoryWebrefRefconRefconNameInfo | Refcon name representation in split concepts sstable. This is a simplified version of repository_webref.GlobalNameInfo. | list(integer) |
| namePrior | Name prior to use. We read this from the prior for the “unknown” language. | RepositoryWebrefRefconRefconNameInfo | Refcon name representation in split concepts sstable. This is a simplified version of repository_webref.GlobalNameInfo. | number |
| normalizedName | The normalized name. | RepositoryWebrefRefconRefconNameInfo | Refcon name representation in split concepts sstable. This is a simplified version of repository_webref.GlobalNameInfo. | String |
| originalName | Filled only if different than normalized_name. | RepositoryWebrefRefconRefconNameInfo | Refcon name representation in split concepts sstable. This is a simplified version of repository_webref.GlobalNameInfo. | String |
| score | RepositoryWebrefRefconRefconNameInfo | Refcon name representation in split concepts sstable. This is a simplified version of repository_webref.GlobalNameInfo. | number | |
| bookScore | Stores score for later offline voting to choose reference pages. If zero, it’s not a good book reference page. | RepositoryWebrefReferencePageScores | Signals used for mining new reference pages, set by the reference-page-scorer processor. | number |
| referencePageScore | Reference page score used to select the reference page owner. | RepositoryWebrefReferencePageScores | Signals used for mining new reference pages, set by the reference-page-scorer processor. | number |
| selected | True if the entity is selected as the reference page owner. | RepositoryWebrefReferencePageScores | Signals used for mining new reference pages, set by the reference-page-scorer processor. | boolean |
| singleTopicness | A score in [0, 1] which indicates the single topicness of the entity. | RepositoryWebrefReferencePageScores | Signals used for mining new reference pages, set by the reference-page-scorer processor. | number |
| singleTopicnessV2 | This should have the same semantic as single_topicness, and should replace it in the long term. | RepositoryWebrefReferencePageScores | Signals used for mining new reference pages, set by the reference-page-scorer processor. | number |
| mention | RepositoryWebrefSegmentMention | A single Mention within a segment as defined by SegmentMentions.SegmentType | RepositoryWebrefMention | |
| segmentType | RepositoryWebrefSegmentMention | A single Mention within a segment as defined by SegmentMentions.SegmentType | String | |
| mention | A list of all the places the entity in question was annotated within this segment. The (indexing.annotations.goldmine) option is for Goldmine AnnotationsFinder to include Mention only when segment_type=”CONTENT” | RepositoryWebrefSegmentMentions | Annotations of a single docjoin segment. A CDoc has several distinct data types which we call “segments” (see SegmentType for complete list). SegmentMentions contains all the mentions for a given (document, segment) pair. For queries there is only a single CONTENT segment. | list(RepositoryWebrefMention) |
| segmentType | RepositoryWebrefSegmentMentions | Annotations of a single docjoin segment. A CDoc has several distinct data types which we call “segments” (see SegmentType for complete list). SegmentMentions contains all the mentions for a given (document, segment) pair. For queries there is only a single CONTENT segment. | String | |
| confidence | Indicates how confident we are this extracted range is relevant to a document (document to be infered from context). | RepositoryWebrefSemanticDateRange | A date range for an entity. E.g. lifespan of a person, release date of a movie, … | number |
| end | End date extracted from the entity along end_source_property. | RepositoryWebrefSemanticDateRange | A date range for an entity. E.g. lifespan of a person, release date of a movie, … | String |
| endSourceProperty | KG-property that links the entity to the end date. | RepositoryWebrefSemanticDateRange | A date range for an entity. E.g. lifespan of a person, release date of a movie, … | String |
| sourceEntityMid | Entity from which this range was extracted. | RepositoryWebrefSemanticDateRange | A date range for an entity. E.g. lifespan of a person, release date of a movie, … | String |
| start | Start date extracted from the entity along start_source_property. | RepositoryWebrefSemanticDateRange | A date range for an entity. E.g. lifespan of a person, release date of a movie, … | String |
| startSourceProperty | KG-property that links the entity to the start date. | RepositoryWebrefSemanticDateRange | A date range for an entity. E.g. lifespan of a person, release date of a movie, … | String |
| anchorIndices | The set of (equivalent from WebRef point of view) anchors used to produce this segment. | RepositoryWebrefSimplifiedAnchor | Represents a subpart of the anchor data of the docjoins, but is much smaller. When we build this SimplifiedAnchor from the anchor data of the docjoins, by specifying the option separate_onsite_anchors to SimplifiedAnchorsBuilder, we can also separate the onsite anchors from the other (offdomain) anchors. So onsite anchors and offdomain anchors will have their own count, score, normalized score, and total volume (.._offdomain and .._onsite fields). For example, if there are 10 onsite anchors and 20 offdomain anchors for the anchor text “mountain view”, then the count_from_onsite is 10, and the count_from_offdomain is 20 when we separate onsite anchors out. Otherwise (if we don’t separate onsite anchors), the count is 30 (10 + 20) and we don’t have values in the .._offdomain and .._onsite fields. | RepositoryWebrefAnchorIndices |
| anchorText | The anchor text. Note that the normalized text is not populated. | RepositoryWebrefSimplifiedAnchor | Represents a subpart of the anchor data of the docjoins, but is much smaller. When we build this SimplifiedAnchor from the anchor data of the docjoins, by specifying the option separate_onsite_anchors to SimplifiedAnchorsBuilder, we can also separate the onsite anchors from the other (offdomain) anchors. So onsite anchors and offdomain anchors will have their own count, score, normalized score, and total volume (.._offdomain and .._onsite fields). For example, if there are 10 onsite anchors and 20 offdomain anchors for the anchor text “mountain view”, then the count_from_onsite is 10, and the count_from_offdomain is 20 when we separate onsite anchors out. Otherwise (if we don’t separate onsite anchors), the count is 30 (10 + 20) and we don’t have values in the .._offdomain and .._onsite fields. | RepositoryWebrefLocalizedString |
| count | The number of times we see this anchor text. | RepositoryWebrefSimplifiedAnchor | Represents a subpart of the anchor data of the docjoins, but is much smaller. When we build this SimplifiedAnchor from the anchor data of the docjoins, by specifying the option separate_onsite_anchors to SimplifiedAnchorsBuilder, we can also separate the onsite anchors from the other (offdomain) anchors. So onsite anchors and offdomain anchors will have their own count, score, normalized score, and total volume (.._offdomain and .._onsite fields). For example, if there are 10 onsite anchors and 20 offdomain anchors for the anchor text “mountain view”, then the count_from_onsite is 10, and the count_from_offdomain is 20 when we separate onsite anchors out. Otherwise (if we don’t separate onsite anchors), the count is 30 (10 + 20) and we don’t have values in the .._offdomain and .._onsite fields. | String |
| countFromOffdomain | Count, score, normalized score, and volume of offdomain anchors. | RepositoryWebrefSimplifiedAnchor | Represents a subpart of the anchor data of the docjoins, but is much smaller. When we build this SimplifiedAnchor from the anchor data of the docjoins, by specifying the option separate_onsite_anchors to SimplifiedAnchorsBuilder, we can also separate the onsite anchors from the other (offdomain) anchors. So onsite anchors and offdomain anchors will have their own count, score, normalized score, and total volume (.._offdomain and .._onsite fields). For example, if there are 10 onsite anchors and 20 offdomain anchors for the anchor text “mountain view”, then the count_from_onsite is 10, and the count_from_offdomain is 20 when we separate onsite anchors out. Otherwise (if we don’t separate onsite anchors), the count is 30 (10 + 20) and we don’t have values in the .._offdomain and .._onsite fields. | String |
| countFromOnsite | Count, score, normalized score, and volume of onsite anchors. | RepositoryWebrefSimplifiedAnchor | Represents a subpart of the anchor data of the docjoins, but is much smaller. When we build this SimplifiedAnchor from the anchor data of the docjoins, by specifying the option separate_onsite_anchors to SimplifiedAnchorsBuilder, we can also separate the onsite anchors from the other (offdomain) anchors. So onsite anchors and offdomain anchors will have their own count, score, normalized score, and total volume (.._offdomain and .._onsite fields). For example, if there are 10 onsite anchors and 20 offdomain anchors for the anchor text “mountain view”, then the count_from_onsite is 10, and the count_from_offdomain is 20 when we separate onsite anchors out. Otherwise (if we don’t separate onsite anchors), the count is 30 (10 + 20) and we don’t have values in the .._offdomain and .._onsite fields. | String |
| normalizedScore | The normalized score, which is computed from the score and the total_volume. | RepositoryWebrefSimplifiedAnchor | Represents a subpart of the anchor data of the docjoins, but is much smaller. When we build this SimplifiedAnchor from the anchor data of the docjoins, by specifying the option separate_onsite_anchors to SimplifiedAnchorsBuilder, we can also separate the onsite anchors from the other (offdomain) anchors. So onsite anchors and offdomain anchors will have their own count, score, normalized score, and total volume (.._offdomain and .._onsite fields). For example, if there are 10 onsite anchors and 20 offdomain anchors for the anchor text “mountain view”, then the count_from_onsite is 10, and the count_from_offdomain is 20 when we separate onsite anchors out. Otherwise (if we don’t separate onsite anchors), the count is 30 (10 + 20) and we don’t have values in the .._offdomain and .._onsite fields. | number |
| normalizedScoreFromOffdomain | RepositoryWebrefSimplifiedAnchor | Represents a subpart of the anchor data of the docjoins, but is much smaller. When we build this SimplifiedAnchor from the anchor data of the docjoins, by specifying the option separate_onsite_anchors to SimplifiedAnchorsBuilder, we can also separate the onsite anchors from the other (offdomain) anchors. So onsite anchors and offdomain anchors will have their own count, score, normalized score, and total volume (.._offdomain and .._onsite fields). For example, if there are 10 onsite anchors and 20 offdomain anchors for the anchor text “mountain view”, then the count_from_onsite is 10, and the count_from_offdomain is 20 when we separate onsite anchors out. Otherwise (if we don’t separate onsite anchors), the count is 30 (10 + 20) and we don’t have values in the .._offdomain and .._onsite fields. | number | |
| normalizedScoreFromOnsite | RepositoryWebrefSimplifiedAnchor | Represents a subpart of the anchor data of the docjoins, but is much smaller. When we build this SimplifiedAnchor from the anchor data of the docjoins, by specifying the option separate_onsite_anchors to SimplifiedAnchorsBuilder, we can also separate the onsite anchors from the other (offdomain) anchors. So onsite anchors and offdomain anchors will have their own count, score, normalized score, and total volume (.._offdomain and .._onsite fields). For example, if there are 10 onsite anchors and 20 offdomain anchors for the anchor text “mountain view”, then the count_from_onsite is 10, and the count_from_offdomain is 20 when we separate onsite anchors out. Otherwise (if we don’t separate onsite anchors), the count is 30 (10 + 20) and we don’t have values in the .._offdomain and .._onsite fields. | number | |
| score | The sum/aggregate of the anchor scores that have the same text. | RepositoryWebrefSimplifiedAnchor | Represents a subpart of the anchor data of the docjoins, but is much smaller. When we build this SimplifiedAnchor from the anchor data of the docjoins, by specifying the option separate_onsite_anchors to SimplifiedAnchorsBuilder, we can also separate the onsite anchors from the other (offdomain) anchors. So onsite anchors and offdomain anchors will have their own count, score, normalized score, and total volume (.._offdomain and .._onsite fields). For example, if there are 10 onsite anchors and 20 offdomain anchors for the anchor text “mountain view”, then the count_from_onsite is 10, and the count_from_offdomain is 20 when we separate onsite anchors out. Otherwise (if we don’t separate onsite anchors), the count is 30 (10 + 20) and we don’t have values in the .._offdomain and .._onsite fields. | number |
| scoreFromFragment | The sum/aggregate of the anchor scores that direct to a fragment and have the same text. | RepositoryWebrefSimplifiedAnchor | Represents a subpart of the anchor data of the docjoins, but is much smaller. When we build this SimplifiedAnchor from the anchor data of the docjoins, by specifying the option separate_onsite_anchors to SimplifiedAnchorsBuilder, we can also separate the onsite anchors from the other (offdomain) anchors. So onsite anchors and offdomain anchors will have their own count, score, normalized score, and total volume (.._offdomain and .._onsite fields). For example, if there are 10 onsite anchors and 20 offdomain anchors for the anchor text “mountain view”, then the count_from_onsite is 10, and the count_from_offdomain is 20 when we separate onsite anchors out. Otherwise (if we don’t separate onsite anchors), the count is 30 (10 + 20) and we don’t have values in the .._offdomain and .._onsite fields. | number |
| scoreFromOffdomain | RepositoryWebrefSimplifiedAnchor | Represents a subpart of the anchor data of the docjoins, but is much smaller. When we build this SimplifiedAnchor from the anchor data of the docjoins, by specifying the option separate_onsite_anchors to SimplifiedAnchorsBuilder, we can also separate the onsite anchors from the other (offdomain) anchors. So onsite anchors and offdomain anchors will have their own count, score, normalized score, and total volume (.._offdomain and .._onsite fields). For example, if there are 10 onsite anchors and 20 offdomain anchors for the anchor text “mountain view”, then the count_from_onsite is 10, and the count_from_offdomain is 20 when we separate onsite anchors out. Otherwise (if we don’t separate onsite anchors), the count is 30 (10 + 20) and we don’t have values in the .._offdomain and .._onsite fields. | number | |
| scoreFromOffdomainFragment | RepositoryWebrefSimplifiedAnchor | Represents a subpart of the anchor data of the docjoins, but is much smaller. When we build this SimplifiedAnchor from the anchor data of the docjoins, by specifying the option separate_onsite_anchors to SimplifiedAnchorsBuilder, we can also separate the onsite anchors from the other (offdomain) anchors. So onsite anchors and offdomain anchors will have their own count, score, normalized score, and total volume (.._offdomain and .._onsite fields). For example, if there are 10 onsite anchors and 20 offdomain anchors for the anchor text “mountain view”, then the count_from_onsite is 10, and the count_from_offdomain is 20 when we separate onsite anchors out. Otherwise (if we don’t separate onsite anchors), the count is 30 (10 + 20) and we don’t have values in the .._offdomain and .._onsite fields. | number | |
| scoreFromOnsite | RepositoryWebrefSimplifiedAnchor | Represents a subpart of the anchor data of the docjoins, but is much smaller. When we build this SimplifiedAnchor from the anchor data of the docjoins, by specifying the option separate_onsite_anchors to SimplifiedAnchorsBuilder, we can also separate the onsite anchors from the other (offdomain) anchors. So onsite anchors and offdomain anchors will have their own count, score, normalized score, and total volume (.._offdomain and .._onsite fields). For example, if there are 10 onsite anchors and 20 offdomain anchors for the anchor text “mountain view”, then the count_from_onsite is 10, and the count_from_offdomain is 20 when we separate onsite anchors out. Otherwise (if we don’t separate onsite anchors), the count is 30 (10 + 20) and we don’t have values in the .._offdomain and .._onsite fields. | number | |
| scoreFromOnsiteFragment | RepositoryWebrefSimplifiedAnchor | Represents a subpart of the anchor data of the docjoins, but is much smaller. When we build this SimplifiedAnchor from the anchor data of the docjoins, by specifying the option separate_onsite_anchors to SimplifiedAnchorsBuilder, we can also separate the onsite anchors from the other (offdomain) anchors. So onsite anchors and offdomain anchors will have their own count, score, normalized score, and total volume (.._offdomain and .._onsite fields). For example, if there are 10 onsite anchors and 20 offdomain anchors for the anchor text “mountain view”, then the count_from_onsite is 10, and the count_from_offdomain is 20 when we separate onsite anchors out. Otherwise (if we don’t separate onsite anchors), the count is 30 (10 + 20) and we don’t have values in the .._offdomain and .._onsite fields. | number | |
| scoreFromRedirect | The sum/aggregate of the anchor scores that direct to a different wiki title and have the same text. NOTE: url direct to a fragment score is not included in this value. | RepositoryWebrefSimplifiedAnchor | Represents a subpart of the anchor data of the docjoins, but is much smaller. When we build this SimplifiedAnchor from the anchor data of the docjoins, by specifying the option separate_onsite_anchors to SimplifiedAnchorsBuilder, we can also separate the onsite anchors from the other (offdomain) anchors. So onsite anchors and offdomain anchors will have their own count, score, normalized score, and total volume (.._offdomain and .._onsite fields). For example, if there are 10 onsite anchors and 20 offdomain anchors for the anchor text “mountain view”, then the count_from_onsite is 10, and the count_from_offdomain is 20 when we separate onsite anchors out. Otherwise (if we don’t separate onsite anchors), the count is 30 (10 + 20) and we don’t have values in the .._offdomain and .._onsite fields. | number |
| totalVolume | The total score volume used for normalization. | RepositoryWebrefSimplifiedAnchor | Represents a subpart of the anchor data of the docjoins, but is much smaller. When we build this SimplifiedAnchor from the anchor data of the docjoins, by specifying the option separate_onsite_anchors to SimplifiedAnchorsBuilder, we can also separate the onsite anchors from the other (offdomain) anchors. So onsite anchors and offdomain anchors will have their own count, score, normalized score, and total volume (.._offdomain and .._onsite fields). For example, if there are 10 onsite anchors and 20 offdomain anchors for the anchor text “mountain view”, then the count_from_onsite is 10, and the count_from_offdomain is 20 when we separate onsite anchors out. Otherwise (if we don’t separate onsite anchors), the count is 30 (10 + 20) and we don’t have values in the .._offdomain and .._onsite fields. | number |
| totalVolumeFromOffdomain | RepositoryWebrefSimplifiedAnchor | Represents a subpart of the anchor data of the docjoins, but is much smaller. When we build this SimplifiedAnchor from the anchor data of the docjoins, by specifying the option separate_onsite_anchors to SimplifiedAnchorsBuilder, we can also separate the onsite anchors from the other (offdomain) anchors. So onsite anchors and offdomain anchors will have their own count, score, normalized score, and total volume (.._offdomain and .._onsite fields). For example, if there are 10 onsite anchors and 20 offdomain anchors for the anchor text “mountain view”, then the count_from_onsite is 10, and the count_from_offdomain is 20 when we separate onsite anchors out. Otherwise (if we don’t separate onsite anchors), the count is 30 (10 + 20) and we don’t have values in the .._offdomain and .._onsite fields. | number | |
| totalVolumeFromOnsite | RepositoryWebrefSimplifiedAnchor | Represents a subpart of the anchor data of the docjoins, but is much smaller. When we build this SimplifiedAnchor from the anchor data of the docjoins, by specifying the option separate_onsite_anchors to SimplifiedAnchorsBuilder, we can also separate the onsite anchors from the other (offdomain) anchors. So onsite anchors and offdomain anchors will have their own count, score, normalized score, and total volume (.._offdomain and .._onsite fields). For example, if there are 10 onsite anchors and 20 offdomain anchors for the anchor text “mountain view”, then the count_from_onsite is 10, and the count_from_offdomain is 20 when we separate onsite anchors out. Otherwise (if we don’t separate onsite anchors), the count is 30 (10 + 20) and we don’t have values in the .._offdomain and .._onsite fields. | number | |
| anchor | RepositoryWebrefSimplifiedAnchors | list(RepositoryWebrefSimplifiedAnchor) | ||
| anchors | The composite doc anchors trimmed and transformed in a smaller data structure and aggregated (if they have the exact same text). | RepositoryWebrefSimplifiedCompositeDoc | Represents an information which is very close to composite doc, but compresses how the anchors are represented to save space. Next available tag: 18. | RepositoryWebrefSimplifiedAnchors |
| cdocContainer | IMPORTANT: do not access this field directly, use the simplified-cdoc-access library functions to get the composite doc out of this proto. | RepositoryWebrefSimplifiedCompositeDoc | Represents an information which is very close to composite doc, but compresses how the anchors are represented to save space. Next available tag: 18. | Proto2BridgeMessageSet |
| documentMentionSpans | The composite doc spans which were annotated with entities by Webref. | RepositoryWebrefSimplifiedCompositeDoc | Represents an information which is very close to composite doc, but compresses how the anchors are represented to save space. Next available tag: 18. | RepositoryWebrefRefconDocumentMentionSpans |
| forwardingDups | Forwarding dups generated by merging existing forwarding dups within cdoc_container and URLs from ReferencePageCandidateList. Populated only before writing to online CDocs Spanner table and used for keeping an index on non canonical URLs in table. [!] Do not use unless fetching CDocs from Enricher’s online Spanner CDocs database knowledge-enricher-cdocs-spanner. | RepositoryWebrefSimplifiedCompositeDoc | Represents an information which is very close to composite doc, but compresses how the anchors are represented to save space. Next available tag: 18. | list(RepositoryWebrefSimplifiedForwardingDup) |
| matchingMetadata | Metadata related to why this doc was matched to its owning entity. | RepositoryWebrefSimplifiedCompositeDoc | Represents an information which is very close to composite doc, but compresses how the anchors are represented to save space. Next available tag: 18. | RepositoryWebrefPreprocessingUrlMatchingMetadata |
| pageContent | RepositoryWebrefSimplifiedCompositeDoc | Represents an information which is very close to composite doc, but compresses how the anchors are represented to save space. Next available tag: 18. | list(String) | |
| refconDocumentMetadata | Additional document metadata needed by Refcon. | RepositoryWebrefSimplifiedCompositeDoc | Represents an information which is very close to composite doc, but compresses how the anchors are represented to save space. Next available tag: 18. | RepositoryWebrefRefconRefconDocumentMetadata |
| sourceSnapshotType | RepositoryWebrefSimplifiedCompositeDoc | Represents an information which is very close to composite doc, but compresses how the anchors are represented to save space. Next available tag: 18. | String | |
| url | The URL, populated independently of whether we have a CompositeDoc proto. If the cdoc exists, the url is the same as CompositeDoc.doc.url. | RepositoryWebrefSimplifiedCompositeDoc | Represents an information which is very close to composite doc, but compresses how the anchors are represented to save space. Next available tag: 18. | String |
| webrefOutlinkInfos | RepositoryWebrefSimplifiedCompositeDoc | Represents an information which is very close to composite doc, but compresses how the anchors are represented to save space. Next available tag: 18. | RepositoryWebrefWebrefOutlinkInfos | |
| url | RepositoryWebrefSimplifiedForwardingDup | String | ||
| anchorIndex | Pointer to the exact set of anchors in the cdoc. | RepositoryWebrefSubSegmentIndex | LINT.IfChange Some document segments may consist of multiple sub-segments (e.g. a document might have multiple anchors or navboost queries). SubSegmentIndex contains all information needed to identify the sub-segment (e.g. specific query, query feature or or anchor) where the mention is located. | RepositoryWebrefAnchorIndices |
| genericIndex | Pointer to the Webref-internal Segment indices. Can’t be mapped back to the CDoc. | RepositoryWebrefSubSegmentIndex | LINT.IfChange Some document segments may consist of multiple sub-segments (e.g. a document might have multiple anchors or navboost queries). SubSegmentIndex contains all information needed to identify the sub-segment (e.g. specific query, query feature or or anchor) where the mention is located. | RepositoryWebrefGenericIndices |
| imageQueryIndex | Pointer to the exact set of image navboost queries in the cdoc. | RepositoryWebrefSubSegmentIndex | LINT.IfChange Some document segments may consist of multiple sub-segments (e.g. a document might have multiple anchors or navboost queries). SubSegmentIndex contains all information needed to identify the sub-segment (e.g. specific query, query feature or or anchor) where the mention is located. | RepositoryWebrefImageQueryIndices |
| jgnIndex | Pointer to the proto in the cdoc and index within the proto for Spore. | RepositoryWebrefSubSegmentIndex | LINT.IfChange Some document segments may consist of multiple sub-segments (e.g. a document might have multiple anchors or navboost queries). SubSegmentIndex contains all information needed to identify the sub-segment (e.g. specific query, query feature or or anchor) where the mention is located. | RepositoryWebrefJuggernautIndices |
| metaTagIndex | Informs about the ‘name’ attribute of the referenced tag. | RepositoryWebrefSubSegmentIndex | LINT.IfChange Some document segments may consist of multiple sub-segments (e.g. a document might have multiple anchors or navboost queries). SubSegmentIndex contains all information needed to identify the sub-segment (e.g. specific query, query feature or or anchor) where the mention is located. | RepositoryWebrefMetaTagIndices |
| queryIndex | Pointer to the exact set of queries in the cdoc. | RepositoryWebrefSubSegmentIndex | LINT.IfChange Some document segments may consist of multiple sub-segments (e.g. a document might have multiple anchors or navboost queries). SubSegmentIndex contains all information needed to identify the sub-segment (e.g. specific query, query feature or or anchor) where the mention is located. | RepositoryWebrefQueryIndices |
| allowWildcardIntents | If set to true, allow STBR targets to trigger intents like ShowEntity that do not have explicit lists of allowed collections, accepting entities with any collections instead. This setting together with target_collection define what intents are allowed to be triggered by the STBR target. Be careful with setting this option to ‘true’, as in the case of our example the query [france] would result in the knowledge panel for the monarch. Louis XIV might’ve wanted such a behaviour, but you are probably not him. | RepositoryWebrefSupportTransferRule | Each SupportTransferRule proto represents a single STBR (go/stbr) rule. These rules are attached to entities (called STBR sources). Each rule attached to an STBR source talks about a single entity (called STBR target). If an STBR source gets annotated, its attached rules result in creation of annotations for corresponding STBR targets. An STBR source might have more than one STBR rule attached to it. STBR rules allow us to address cases where otherwise annotations for what people say do not match what people mean. For example, a query [france vs spain] uses names of countries while in sports context the query would actually be about national sports teams of those countries. In other words, STBR rules have meaning of “in this particular context (see domain + target_collection fields below) a mention of this particular STBR source (the entity this rule is attached to) actually should be treated as that STBR target (see the target field below)”. To describe the meaning of STBR settings (proto fields below), we are going to use a hypothetical example of an STBR rule making Search stack treat annotations for /m/France as annotations for /m/Louis_XIV, since he was the one saying “I am the state”. In this example /m/France is going to be the STBR source. NOTICE: When adding new fields also update client::support_transfer::SortDeterministically to ensure deterministic sorting of the SupportTransferRule objects. Next available tag: 11. LINT.IfChange | boolean |
| domain | Name of Aqua grammar domain this STBR rule is restricted to. If the domain is set to anything other than “default”, the STBR rule is only going to result in an annotation for the STBR target inside of the Aqua domain of the corresponding name. If there is no such Aqua domain, the rule is going to be ignored. The default value of string “default” for domain makes it possible for the STBR rule to be used inside Loose Parser. | RepositoryWebrefSupportTransferRule | Each SupportTransferRule proto represents a single STBR (go/stbr) rule. These rules are attached to entities (called STBR sources). Each rule attached to an STBR source talks about a single entity (called STBR target). If an STBR source gets annotated, its attached rules result in creation of annotations for corresponding STBR targets. An STBR source might have more than one STBR rule attached to it. STBR rules allow us to address cases where otherwise annotations for what people say do not match what people mean. For example, a query [france vs spain] uses names of countries while in sports context the query would actually be about national sports teams of those countries. In other words, STBR rules have meaning of “in this particular context (see domain + target_collection fields below) a mention of this particular STBR source (the entity this rule is attached to) actually should be treated as that STBR target (see the target field below)”. To describe the meaning of STBR settings (proto fields below), we are going to use a hypothetical example of an STBR rule making Search stack treat annotations for /m/France as annotations for /m/Louis_XIV, since he was the one saying “I am the state”. In this example /m/France is going to be the STBR source. NOTICE: When adding new fields also update client::support_transfer::SortDeterministically to ensure deterministic sorting of the SupportTransferRule objects. Next available tag: 11. LINT.IfChange | String |
| isReverseLink | Whether this rule points from an STBR target to its STBR source. This field is an internal implementation detail that is not configurable by customers. Inside QRewrite we have to keep track of relations between entities. Among other things it is useful to remember which STBR target a given STBR source came from. For that purpose we attach an STBR proto to the STBR target, reversing the rule, i.e, putting STBR source’s mid as the target etc. For this reversed rule we set is_reverse_link to true. | RepositoryWebrefSupportTransferRule | Each SupportTransferRule proto represents a single STBR (go/stbr) rule. These rules are attached to entities (called STBR sources). Each rule attached to an STBR source talks about a single entity (called STBR target). If an STBR source gets annotated, its attached rules result in creation of annotations for corresponding STBR targets. An STBR source might have more than one STBR rule attached to it. STBR rules allow us to address cases where otherwise annotations for what people say do not match what people mean. For example, a query [france vs spain] uses names of countries while in sports context the query would actually be about national sports teams of those countries. In other words, STBR rules have meaning of “in this particular context (see domain + target_collection fields below) a mention of this particular STBR source (the entity this rule is attached to) actually should be treated as that STBR target (see the target field below)”. To describe the meaning of STBR settings (proto fields below), we are going to use a hypothetical example of an STBR rule making Search stack treat annotations for /m/France as annotations for /m/Louis_XIV, since he was the one saying “I am the state”. In this example /m/France is going to be the STBR source. NOTICE: When adding new fields also update client::support_transfer::SortDeterministically to ensure deterministic sorting of the SupportTransferRule objects. Next available tag: 11. LINT.IfChange | boolean |
| mentionsOnly | STBR doesn’t just create annotations for STBR targets. It also can modify search result support (useful in PostRef) in order for web pages supporting the STBR source to also support the STBR target. Otherwise in PostRef annotations for STBR targets are going to be demoted, resulting in the STBR rule potentially not affecting anything. Regarding treatment of this result support, STBR has 3 possible modes that for historical reasons are represented as 2 booleans – mentions_only and support_share. No more than one of these bools is supposed to be set to ‘true’ for a rule. Setting both to ‘true’ at once would lead to undefined behaviour. These 3 modes are: 1. (default) All the support gets assigned to the STBR target. The STBR source is left with no support. To be extra sure, interpretations that still managed to get triggered by STBR source are suppressed later unless STBR target has no interpretations of its own. In other words this is “we are pretty sure that if France is mentioned in a query that might be talking about a person, we want to treat the query as if it is about Louis XIV”. This mode would result in a query [age of france] being treated as [age of louis xiv], while [population of france] still being about the country unless [population of louis xiv] matches some intents. For this mode both mentions_only and support_share should be set to ‘false’. 2. Support is shared between STBR source ans STBR target. That allows both STBR source and STBR target to trigger some intents with KScorer later deciding which intent is better. In other words, this is “when it is not clear whether a query is about France of Louis XIV, provide KScorer with both options and let it decide”. For this mode mentions_only should be set to ‘false’ and support_share should be set to ‘true’. 3. While annotations for the STBR target are created, no support is given to those annotations. This is more like “we are mostly sure that a mention of France is about the country, but just for a rare case it is about the monarch, we would like to have Louis XIV annotated”. For this mode mentions_only should be set to ‘true’ and support_share should be set to ‘false’. | RepositoryWebrefSupportTransferRule | Each SupportTransferRule proto represents a single STBR (go/stbr) rule. These rules are attached to entities (called STBR sources). Each rule attached to an STBR source talks about a single entity (called STBR target). If an STBR source gets annotated, its attached rules result in creation of annotations for corresponding STBR targets. An STBR source might have more than one STBR rule attached to it. STBR rules allow us to address cases where otherwise annotations for what people say do not match what people mean. For example, a query [france vs spain] uses names of countries while in sports context the query would actually be about national sports teams of those countries. In other words, STBR rules have meaning of “in this particular context (see domain + target_collection fields below) a mention of this particular STBR source (the entity this rule is attached to) actually should be treated as that STBR target (see the target field below)”. To describe the meaning of STBR settings (proto fields below), we are going to use a hypothetical example of an STBR rule making Search stack treat annotations for /m/France as annotations for /m/Louis_XIV, since he was the one saying “I am the state”. In this example /m/France is going to be the STBR source. NOTICE: When adding new fields also update client::support_transfer::SortDeterministically to ensure deterministic sorting of the SupportTransferRule objects. Next available tag: 11. LINT.IfChange | boolean |
| supportShare | RepositoryWebrefSupportTransferRule | Each SupportTransferRule proto represents a single STBR (go/stbr) rule. These rules are attached to entities (called STBR sources). Each rule attached to an STBR source talks about a single entity (called STBR target). If an STBR source gets annotated, its attached rules result in creation of annotations for corresponding STBR targets. An STBR source might have more than one STBR rule attached to it. STBR rules allow us to address cases where otherwise annotations for what people say do not match what people mean. For example, a query [france vs spain] uses names of countries while in sports context the query would actually be about national sports teams of those countries. In other words, STBR rules have meaning of “in this particular context (see domain + target_collection fields below) a mention of this particular STBR source (the entity this rule is attached to) actually should be treated as that STBR target (see the target field below)”. To describe the meaning of STBR settings (proto fields below), we are going to use a hypothetical example of an STBR rule making Search stack treat annotations for /m/France as annotations for /m/Louis_XIV, since he was the one saying “I am the state”. In this example /m/France is going to be the STBR source. NOTICE: When adding new fields also update client::support_transfer::SortDeterministically to ensure deterministic sorting of the SupportTransferRule objects. Next available tag: 11. LINT.IfChange | boolean | |
| target | Mid of the STBR target, e.g. “/m/04pwg” for Louis XIV. | RepositoryWebrefSupportTransferRule | Each SupportTransferRule proto represents a single STBR (go/stbr) rule. These rules are attached to entities (called STBR sources). Each rule attached to an STBR source talks about a single entity (called STBR target). If an STBR source gets annotated, its attached rules result in creation of annotations for corresponding STBR targets. An STBR source might have more than one STBR rule attached to it. STBR rules allow us to address cases where otherwise annotations for what people say do not match what people mean. For example, a query [france vs spain] uses names of countries while in sports context the query would actually be about national sports teams of those countries. In other words, STBR rules have meaning of “in this particular context (see domain + target_collection fields below) a mention of this particular STBR source (the entity this rule is attached to) actually should be treated as that STBR target (see the target field below)”. To describe the meaning of STBR settings (proto fields below), we are going to use a hypothetical example of an STBR rule making Search stack treat annotations for /m/France as annotations for /m/Louis_XIV, since he was the one saying “I am the state”. In this example /m/France is going to be the STBR source. NOTICE: When adding new fields also update client::support_transfer::SortDeterministically to ensure deterministic sorting of the SupportTransferRule objects. Next available tag: 11. LINT.IfChange | String |
| targetCollection | Collection that is going to be assigned to the target when the annotation for the target is created. This setting together with allow_wildcard_intents define what intents are allowed to be triggered by the STBR target. At the moment those annotations get created, we can not afford to fetch information about the STBR target from Topic Server, but the target mid by itself doesn’t mean much for the Search stack. Setting up the collection for that annotated mid allows us to provide at least some information to the stack on how to treat the mid. This collection together with domain and allow_wildcard_intents fields (see below) defines what intents can be triggered by annotations created for this STBR target. Intents that accept only entities of specific collections can only be triggered if the value of this field matches one of the allowed collections for that intent. In our example, KGCollection.debug_id might be “/collection/people” if we care about context of the monarch as a person, e.g. if we would like to understand queries like [how many children does france have] as [how many childred does lous xiv have]. Or, if we would like to be more restrictive and to only apply the rule to contexts that only make sense for monarch, e.g. [how long did france reign], we might decide to use more specific “/collection/monarchs” instead. | RepositoryWebrefSupportTransferRule | Each SupportTransferRule proto represents a single STBR (go/stbr) rule. These rules are attached to entities (called STBR sources). Each rule attached to an STBR source talks about a single entity (called STBR target). If an STBR source gets annotated, its attached rules result in creation of annotations for corresponding STBR targets. An STBR source might have more than one STBR rule attached to it. STBR rules allow us to address cases where otherwise annotations for what people say do not match what people mean. For example, a query [france vs spain] uses names of countries while in sports context the query would actually be about national sports teams of those countries. In other words, STBR rules have meaning of “in this particular context (see domain + target_collection fields below) a mention of this particular STBR source (the entity this rule is attached to) actually should be treated as that STBR target (see the target field below)”. To describe the meaning of STBR settings (proto fields below), we are going to use a hypothetical example of an STBR rule making Search stack treat annotations for /m/France as annotations for /m/Louis_XIV, since he was the one saying “I am the state”. In this example /m/France is going to be the STBR source. NOTICE: When adding new fields also update client::support_transfer::SortDeterministically to ensure deterministic sorting of the SupportTransferRule objects. Next available tag: 11. LINT.IfChange | RepositoryWebrefKGCollection |
| userCountry | The user country this rule is for. Rules only take effect if the country is not set, set to an empty string or matches the country that is detected for the user – like the country user issued the query from. E.g. “US” for the United States. | RepositoryWebrefSupportTransferRule | Each SupportTransferRule proto represents a single STBR (go/stbr) rule. These rules are attached to entities (called STBR sources). Each rule attached to an STBR source talks about a single entity (called STBR target). If an STBR source gets annotated, its attached rules result in creation of annotations for corresponding STBR targets. An STBR source might have more than one STBR rule attached to it. STBR rules allow us to address cases where otherwise annotations for what people say do not match what people mean. For example, a query [france vs spain] uses names of countries while in sports context the query would actually be about national sports teams of those countries. In other words, STBR rules have meaning of “in this particular context (see domain + target_collection fields below) a mention of this particular STBR source (the entity this rule is attached to) actually should be treated as that STBR target (see the target field below)”. To describe the meaning of STBR settings (proto fields below), we are going to use a hypothetical example of an STBR rule making Search stack treat annotations for /m/France as annotations for /m/Louis_XIV, since he was the one saying “I am the state”. In this example /m/France is going to be the STBR source. NOTICE: When adding new fields also update client::support_transfer::SortDeterministically to ensure deterministic sorting of the SupportTransferRule objects. Next available tag: 11. LINT.IfChange | String |
| userLanguage | User language this rule is for. Rules only take effect if the language is not set, set to an empty string or matches the language that is detected for the user’s query. E.g. set it to “en” if you want the STBR rule to only work for users working from computers with English being set as the main language. Keep it unset if you want the rule not to depend on local language settings of user’s computer. | RepositoryWebrefSupportTransferRule | Each SupportTransferRule proto represents a single STBR (go/stbr) rule. These rules are attached to entities (called STBR sources). Each rule attached to an STBR source talks about a single entity (called STBR target). If an STBR source gets annotated, its attached rules result in creation of annotations for corresponding STBR targets. An STBR source might have more than one STBR rule attached to it. STBR rules allow us to address cases where otherwise annotations for what people say do not match what people mean. For example, a query [france vs spain] uses names of countries while in sports context the query would actually be about national sports teams of those countries. In other words, STBR rules have meaning of “in this particular context (see domain + target_collection fields below) a mention of this particular STBR source (the entity this rule is attached to) actually should be treated as that STBR target (see the target field below)”. To describe the meaning of STBR settings (proto fields below), we are going to use a hypothetical example of an STBR rule making Search stack treat annotations for /m/France as annotations for /m/Louis_XIV, since he was the one saying “I am the state”. In this example /m/France is going to be the STBR source. NOTICE: When adding new fields also update client::support_transfer::SortDeterministically to ensure deterministic sorting of the SupportTransferRule objects. Next available tag: 11. LINT.IfChange | String |
| isReadable | Signals about quality of data that was shown to raters. If document/query and concept description are readable. | RepositoryWebrefTaskData | boolean | |
| itemId | RepositoryWebrefTaskData | String | ||
| projectId | RepositoryWebrefTaskData | String | ||
| taskDetails | RepositoryWebrefTaskData | RepositoryWebrefTaskDetails | ||
| taskId | RepositoryWebrefTaskData | String | ||
| experimentId | The id of the experiment in case we are dealing with a refx data experiment. Should only be set in case of data experiments to gather topicality ratings, in order to allow separating these ratings from regular ratings. | RepositoryWebrefTaskDetails | Information about what the raters saw, how the information was presented to them, or how they interacted with the task. Next id: 6 | String |
| lastSubmitTimestamp | RepositoryWebrefTaskDetails | Information about what the raters saw, how the information was presented to them, or how they interacted with the task. Next id: 6 | String | |
| topicDescription | RepositoryWebrefTaskDetails | Information about what the raters saw, how the information was presented to them, or how they interacted with the task. Next id: 6 | String | |
| topicName | RepositoryWebrefTaskDetails | Information about what the raters saw, how the information was presented to them, or how they interacted with the task. Next id: 6 | String | |
| topicUrl | RepositoryWebrefTaskDetails | Information about what the raters saw, how the information was presented to them, or how they interacted with the task. Next id: 6 | String | |
| confidenceScore | Triple annotation confidence_score (value between 0 and 1). Higher values correspond to higher confidence. | RepositoryWebrefTripleAnnotation | number | |
| isImplied | The information in this triple is implied by other triple(s) in the document. | RepositoryWebrefTripleAnnotation | boolean | |
| kgVerified | Set to true if this triple is present in the webref model as either a link or property value. This implies that the information is in the Knowledge Graph. Note that it can happen that a triple is in KG but not present in the webref model. | RepositoryWebrefTripleAnnotation | boolean | |
| mentions | Occurrences of the triple on the document | RepositoryWebrefTripleAnnotation | list(RepositoryWebrefTripleMention) | |
| predMid | The mid of the predicate kg-property(-ies). In order, in the case of multihop links. | RepositoryWebrefTripleAnnotation | list(String) | |
| stuff | Generic container to hold additional data such as signals, debug data etc. Data that can be stored in this field and their TypeIds: repository_webref::evaluation::ECMDebug (TypeId 192627933), defined in repository/webref/evaluation/triple_annotations/triple-diff.proto Debugging data to be used in WebIt’s ECM report. | RepositoryWebrefTripleAnnotation | Proto2BridgeMessageSet | |
| triple | RepositoryWebrefTripleAnnotation | KnowledgeGraphTriple | ||
| annotations | RepositoryWebrefTripleAnnotations | Represents a collection of triples annotated by Webref/Webit. Included in WebrefEntities | list(RepositoryWebrefTripleAnnotation) | |
| predMention | Document mention of the predicate | RepositoryWebrefTripleMention | RepositoryWebrefSegmentMention | |
| scopeBegin | The [begin, end) byte offset of the document scope where this triple was annotated. This corresponds to a table row or a text sentence where the triple was identified. The sub_mention can be outside the scope when the subject is inferred from the table title. | RepositoryWebrefTripleMention | integer | |
| scopeEnd | RepositoryWebrefTripleMention | integer | ||
| scopeFprint | Fingerprint2011 of space-joined SAFT tokens in the scope. | RepositoryWebrefTripleMention | String | |
| stuff | Generic container to hold additional data such as triple scoped signals. Data that can be stored in this field and their TypeIds: repository_webref::universal::webit::ScopeSignals (TypeId 192754198), defined in repository/webref/universal/processors/understanding/webit.proto | RepositoryWebrefTripleMention | Proto2BridgeMessageSet | |
| subMention | Document mention of the subject | RepositoryWebrefTripleMention | RepositoryWebrefSegmentMention | |
| valueMention | Document mention of the value | RepositoryWebrefTripleMention | RepositoryWebrefSegmentMention | |
| idf | IDF of the n-gram. | RepositoryWebrefUniversalNgramData | This proto is filled with n-gram data during model building. | number |
| pluralProb | Probability that the n-gram is a plural form of a word. This information is extracted from SAFT annotations of queries. See HasPluralProperty(). | RepositoryWebrefUniversalNgramData | This proto is filled with n-gram data during model building. | number |
| docWeight | The relative weight of the document, used when aggregating information from multiple documents. | RepositoryWebrefWebrefAnnotationStats | Detailed statistics about the annotations in the document. Contains, for example, the number of ranges with name matches, the number of entities matched, and the number of entities with mentions. This information can be used to tune some WebRef-internal scoring functions based on existing annotations (e.g., document-length normalization in global link support). Next available tag: 10. | number |
| ngramContext | Extracted n-grams context scores (in cdoc language, weighted by doc_weight) output if webref_populate_annotation_ngrams is enabled. | RepositoryWebrefWebrefAnnotationStats | Detailed statistics about the annotations in the document. Contains, for example, the number of ranges with name matches, the number of entities matched, and the number of entities with mentions. This information can be used to tune some WebRef-internal scoring functions based on existing annotations (e.g., document-length normalization in global link support). Next available tag: 10. | list(RepositoryWebrefNgramContext) |
| numCandidates | The total number of candidates. | RepositoryWebrefWebrefAnnotationStats | Detailed statistics about the annotations in the document. Contains, for example, the number of ranges with name matches, the number of entities matched, and the number of entities with mentions. This information can be used to tune some WebRef-internal scoring functions based on existing annotations (e.g., document-length normalization in global link support). Next available tag: 10. | String |
| numConceptsWithCandidates | The total number of concepts with at least 1 candidate. | RepositoryWebrefWebrefAnnotationStats | Detailed statistics about the annotations in the document. Contains, for example, the number of ranges with name matches, the number of entities matched, and the number of entities with mentions. This information can be used to tune some WebRef-internal scoring functions based on existing annotations (e.g., document-length normalization in global link support). Next available tag: 10. | String |
| numConceptsWithMentions | The total number of concepts with at least 1 mention. | RepositoryWebrefWebrefAnnotationStats | Detailed statistics about the annotations in the document. Contains, for example, the number of ranges with name matches, the number of entities matched, and the number of entities with mentions. This information can be used to tune some WebRef-internal scoring functions based on existing annotations (e.g., document-length normalization in global link support). Next available tag: 10. | String |
| numRangesWithCandidates | The total number of RangeData objects with at least one candidate. | RepositoryWebrefWebrefAnnotationStats | Detailed statistics about the annotations in the document. Contains, for example, the number of ranges with name matches, the number of entities matched, and the number of entities with mentions. This information can be used to tune some WebRef-internal scoring functions based on existing annotations (e.g., document-length normalization in global link support). Next available tag: 10. | String |
| statsPerType | Statistics for each token type. | RepositoryWebrefWebrefAnnotationStats | Detailed statistics about the annotations in the document. Contains, for example, the number of ranges with name matches, the number of entities matched, and the number of entities with mentions. This information can be used to tune some WebRef-internal scoring functions based on existing annotations (e.g., document-length normalization in global link support). Next available tag: 10. | list(RepositoryWebrefAnnotationStatsPerType) |
| featureType | Oyster Feature Type. | RepositoryWebrefWebrefAttachmentMetadata | Annotation metadata for an individual entity. | String |
| index | Indicates which entity this message belongs to: encoded_mid[index]. | RepositoryWebrefWebrefAttachmentMetadata | Annotation metadata for an individual entity. | integer |
| latE7 | Latitude and longitude of the location. Same format as geostore.PointProto. | RepositoryWebrefWebrefAttachmentMetadata | Annotation metadata for an individual entity. | integer |
| lngE7 | RepositoryWebrefWebrefAttachmentMetadata | Annotation metadata for an individual entity. | integer | |
| oysterId | Oyster Feature ID of the location. | RepositoryWebrefWebrefAttachmentMetadata | Annotation metadata for an individual entity. | GeostoreFeatureIdProto |
| documentMetadata | Information about the document copied from the docjoin. This will never be populated when WebrefEntities appears inside a CompositeDoc, but may we used when it stands alone. | RepositoryWebrefWebrefDocumentInfo | All information that applies globally to the document. Next available tag: 11 | RepositoryWebrefDocumentMetadata |
| extensions | Optional extensions (e.g. taxonomic classifications). | RepositoryWebrefWebrefDocumentInfo | All information that applies globally to the document. Next available tag: 11 | Proto2BridgeMessageSet |
| webrefParsedContentSentence | The content (CONTENT section 0) as parsed by WebrefParser. Only used by //r/w/postprocessing/idf/idf-pipeline for document ngram idf computation. Populated when the annotator is run with webref_populate_parsed_content Each webref_parsed_content_sentence represents one sentence of the context where saft annotations were used to determine the sentence boundaries. See r/w/universal/processors/saft/saft-sentence-helper.h for details. | RepositoryWebrefWebrefDocumentInfo | All information that applies globally to the document. Next available tag: 11 | list(String) |
| annotationStats | Detailed annotation statistics that can, e.g., be used to tune the WebRef scoring logic based on existing (Model-0) annotations. | RepositoryWebrefWebrefEntities | Represents a collection of entities returned by the WebRef service. Next available tag: 14. | RepositoryWebrefWebrefAnnotationStats |
| annotatorCheckpointFingerprints | Fingerprints checkpointing annotator stages, can be used to track the source of diffs. | RepositoryWebrefWebrefEntities | Represents a collection of entities returned by the WebRef service. Next available tag: 14. | list(RepositoryWebrefAnnotatorCheckpointFprint) |
| category | Categories of the document or query. This replaces the category_score found under EntityAnnotations. | RepositoryWebrefWebrefEntities | Represents a collection of entities returned by the WebRef service. Next available tag: 14. | list(RepositoryWebrefCategoryAnnotation) |
| dateRange | Dates ranges that are most relevant to the document. E.g. on a document about Dune the 2021 movie, this might hold the release date of that movie. | RepositoryWebrefWebrefEntities | Represents a collection of entities returned by the WebRef service. Next available tag: 14. | list(RepositoryWebrefSemanticDateRange) |
| documentInfo | Information that applies globally to the document. The exclude_field option is for Goldmine AnnotationsFinder to exclude document_info from retrieving annotation entities | RepositoryWebrefWebrefEntities | Represents a collection of entities returned by the WebRef service. Next available tag: 14. | RepositoryWebrefWebrefDocumentInfo |
| entity | The annotated entities, with associated confidence scores and metadata. This is the primary output of WebRef/QRef. In case of Webref output, entities are sorted by decreasing topicality score. | RepositoryWebrefWebrefEntities | Represents a collection of entities returned by the WebRef service. Next available tag: 14. | list(RepositoryWebrefWebrefEntity) |
| rangeAnnotations | These messages contain non-entity annotations of ranges in the document. This might be used to hold part-of-speech annotations, stopword annotations, and other range based information. The exclude_field option is for Goldmine AnnotationsFinder to exclude ranged_annotations from retrieving annotation entities | RepositoryWebrefWebrefEntities | Represents a collection of entities returned by the WebRef service. Next available tag: 14. | list(RepositoryWebrefRangeAnnotations) |
| status | The status message returned by the annotator. Might not be populated on success. | RepositoryWebrefWebrefEntities | Represents a collection of entities returned by the WebRef service. Next available tag: 14. | RepositoryWebrefWebrefStatus |
| stuff | A generic container to hold extra result data. | RepositoryWebrefWebrefEntities | Represents a collection of entities returned by the WebRef service. Next available tag: 14. | Proto2BridgeMessageSet |
| tripleAnnotations | Triples inferred from the document When the annotator recognizes phrases, lists or tables associated with a property or relationship for an entity it generates triples that encode that information. This generated data is only substantiated by the document vs KG data which has been verified from multiple sources and/or human curators. | RepositoryWebrefWebrefEntities | Represents a collection of entities returned by the WebRef service. Next available tag: 14. | RepositoryWebrefTripleAnnotations |
| annotatedRelationship | Information about links (e.g. implications) between the annotated entities. | RepositoryWebrefWebrefEntity | All information about a single entity available to WebRef. Next available tag: 7 | list(RepositoryWebrefWebrefEntityRelationship) |
| annotations | All annotations of this entity on the given document. | RepositoryWebrefWebrefEntity | All information about a single entity available to WebRef. Next available tag: 7 | RepositoryWebrefEntityAnnotations |
| collections | Information about the collections of this entity. | RepositoryWebrefWebrefEntity | All information about a single entity available to WebRef. Next available tag: 7 | RepositoryWebrefWebrefEntityCollections |
| entityJoin | Metadata and raw signals used by the annotator. Intended for internal use. Steer clear of adding new dependencies on fields in this proto, especially external dependencies. If you are a Refx client and would like to consume entity metadata, consider querying TopicServer instead. | RepositoryWebrefWebrefEntity | All information about a single entity available to WebRef. Next available tag: 7 | RepositoryWebrefEntityJoin |
| id | An identifier (usually a MID) for the entity. Consider using GetWebrefEntityMid() in the adjacent webref-entities-util.h to read this. | RepositoryWebrefWebrefEntity | All information about a single entity available to WebRef. Next available tag: 7 | RepositoryWebrefWebrefEntityId |
| mrf | MRF equivalent representations of this entity as a compound, one for each unique MRF representation. Populated for compounds. Each MRF expression contains a minimum FunctionCall structure wrapped in a nameless Argument without signals and range data. This is not meant to be directly usable as MRF, use QueryJoinToMeaningStructConverter to expand it into a usable form. References to entities are made as component_reference ArgumentValue. Each compound Mention of this entity (not all of its mentions need be compounds, some may be plain entity mentions) have one or more compound_value fields claiming these MRF expressions via their mrf_index. The compound_value has nested components, one for each unique component_reference.index in the MRF expression. The processing expectation is that each ArgumentValue which has a component_reference has its contents discarded and replaced with the MRF for the target entity and mention named by the compound_value.component. If the target is not a compound, the ArgumentValue becomes a simple mid value and the signals are taken from the entity and the mention. If the target is a compound itself, the expansion continues recursively. If the target is a compound with multiple MRFs, a cartesian product of recursive expansions may need to be produced. Along with the component_reference we also emit an example value, but this is purely for human consumption so it’s easier to understand what the full compound is like. The processing expectation remains that the ArgumentValue containing a component_reference is completely discarded and rebuilt with the reference target value. If the target has more than one MRF expression, it’s not specified which one will be used as an example, except that the choice is guaranteed to be deterministic from run to run. | RepositoryWebrefWebrefEntity | All information about a single entity available to WebRef. Next available tag: 7 | list(KnowledgeAnswersIntentQueryArgument) |
| collection | RepositoryWebrefWebrefEntityCollections | list(RepositoryWebrefKGCollection) | ||
| conceptId | The MID in integer format. Nowadays, this field contains the equivalent representation of `freebase_mid`, i.e. what metaweb::ParseId() returns. | RepositoryWebrefWebrefEntityId | The identifier of a WebrefEntity (see webref-entities.proto). IMPORTANT: Please consider reading this proto through GetWebrefEntityMid() in webref-entities-util.h, because this proto may: a) contain both freebase_mid and concept_id (this is frequently the case to avoid breaking downstream clients), b) only contain freebase_mid or only contain concept_id (as the other one is technically redundant), c) contain neither of them or be missing entirely (potentially in future). | String |
| freebaseMid | The MID in the same format that is returned by metaweb::MidToString(), e.g. “/m/02mjmr” or “/g/11b6vyscgb” or “/t/24bjj59_jbj9f”. | RepositoryWebrefWebrefEntityId | The identifier of a WebrefEntity (see webref-entities.proto). IMPORTANT: Please consider reading this proto through GetWebrefEntityMid() in webref-entities-util.h, because this proto may: a) contain both freebase_mid and concept_id (this is frequently the case to avoid breaking downstream clients), b) only contain freebase_mid or only contain concept_id (as the other one is technically redundant), c) contain neither of them or be missing entirely (potentially in future). | String |
| entityIndex | The index of the entry in WebrefEntities.entity that the entity carrying this field is linked to. This field must be set. | RepositoryWebrefWebrefEntityRelationship | Information regarding links between annotated entities. Next available tag: 5 | integer |
| linkMetadata | Information about the link. | RepositoryWebrefWebrefEntityRelationship | Information regarding links between annotated entities. Next available tag: 5 | RepositoryWebrefEntityLinkMetadata |
| linkWeight | The weight of the link. | RepositoryWebrefWebrefEntityRelationship | Information regarding links between annotated entities. Next available tag: 5 | number |
| categoryConfidenceE2 | The confidence of the category. In the range [0, 100]. | RepositoryWebrefWebrefMustangAttachment | *** THIS ATTACHMENT IS DEPRECATED, SEE go/udr/migrate-wma. ***. We still allow legacy use case to exist (no forced migration), but we will not accept any new usage of WMA, incl. from existing clients. UDR has the same features and can be used similarly: – To consume the topical entities (+properties, incl. hitcat, browsy, …) go/udr/migrate-wma provides a migration with minimal changes. – To consume IQL, please consult go/udr/superroot#access and go/pianno team. The top-level proto used to store WebRef entities and IQL expressions in Mustang/TG. The proto uses packed repeated fields and variable-length integers in order to be as compact as possible. See http://b/5802389 and b/7473898 for details on other approaches that were considered and space/readability/extensibility trade-offs made. Note: It is not recommeded to read this proto directly. Clients of the attachment should use the decoder instead: repository/webref/tools/kc/indexing/webref-attachment-decoder.h Next available tag: 25 | list(integer) |
| categoryEncodedMid | See go/category-annotations-api about the story behind various types of category annotations that are provided using the catmid token and category_encoded_mid fields below. Some of these annotation types are experimental, so please contact related-entities@ if you consider using this data. For production uses, please: 1. Add your use-case to go/hits-clients. 2. Subscribe to hits-users@ to receive general updates and info about deprecations. To convert it to the string form use metaweb::MidToString(encoded_mid) defined in metaweb/util/mid/mid.h The uint64-encoded MIDs of HitCat categories. See google3/repository/webref/hits/hitcat/category.textproto for the complete list of HitCat categories. Should have the same number of elements as the category_confidence_e2 field. | RepositoryWebrefWebrefMustangAttachment | *** THIS ATTACHMENT IS DEPRECATED, SEE go/udr/migrate-wma. ***. We still allow legacy use case to exist (no forced migration), but we will not accept any new usage of WMA, incl. from existing clients. UDR has the same features and can be used similarly: – To consume the topical entities (+properties, incl. hitcat, browsy, …) go/udr/migrate-wma provides a migration with minimal changes. – To consume IQL, please consult go/udr/superroot#access and go/pianno team. The top-level proto used to store WebRef entities and IQL expressions in Mustang/TG. The proto uses packed repeated fields and variable-length integers in order to be as compact as possible. See http://b/5802389 and b/7473898 for details on other approaches that were considered and space/readability/extensibility trade-offs made. Note: It is not recommeded to read this proto directly. Clients of the attachment should use the decoder instead: repository/webref/tools/kc/indexing/webref-attachment-decoder.h Next available tag: 25 | list(String) |
| confidenceE2 | The confidence scores of all entities in the encoded_mid array. For space reasons this is also represented as a fixed-point integer with two decimal precision. Convert it to confidence_score using the following formula: float confidence_score = confidence_e2 / 100.0f Should have the same number of elements as the encoded_mid field. | RepositoryWebrefWebrefMustangAttachment | *** THIS ATTACHMENT IS DEPRECATED, SEE go/udr/migrate-wma. ***. We still allow legacy use case to exist (no forced migration), but we will not accept any new usage of WMA, incl. from existing clients. UDR has the same features and can be used similarly: – To consume the topical entities (+properties, incl. hitcat, browsy, …) go/udr/migrate-wma provides a migration with minimal changes. – To consume IQL, please consult go/udr/superroot#access and go/pianno team. The top-level proto used to store WebRef entities and IQL expressions in Mustang/TG. The proto uses packed repeated fields and variable-length integers in order to be as compact as possible. See http://b/5802389 and b/7473898 for details on other approaches that were considered and space/readability/extensibility trade-offs made. Note: It is not recommeded to read this proto directly. Clients of the attachment should use the decoder instead: repository/webref/tools/kc/indexing/webref-attachment-decoder.h Next available tag: 25 | list(integer) |
| encodedMid | The int64-encoded MIDs of the entities in the document sorted by topicality score. To convert it to the string form use metaweb::MidToString(encoded_mid) defined in metaweb/util/mid/mid.h Should have the same number of elements as the topicality_e2 field. | RepositoryWebrefWebrefMustangAttachment | *** THIS ATTACHMENT IS DEPRECATED, SEE go/udr/migrate-wma. ***. We still allow legacy use case to exist (no forced migration), but we will not accept any new usage of WMA, incl. from existing clients. UDR has the same features and can be used similarly: – To consume the topical entities (+properties, incl. hitcat, browsy, …) go/udr/migrate-wma provides a migration with minimal changes. – To consume IQL, please consult go/udr/superroot#access and go/pianno team. The top-level proto used to store WebRef entities and IQL expressions in Mustang/TG. The proto uses packed repeated fields and variable-length integers in order to be as compact as possible. See http://b/5802389 and b/7473898 for details on other approaches that were considered and space/readability/extensibility trade-offs made. Note: It is not recommeded to read this proto directly. Clients of the attachment should use the decoder instead: repository/webref/tools/kc/indexing/webref-attachment-decoder.h Next available tag: 25 | list(String) |
| entityMetadata | Per-entity metadata. Not packed (not every entity has metadata). If you’d like to add per-document metadata, see document_metadata instead. | RepositoryWebrefWebrefMustangAttachment | *** THIS ATTACHMENT IS DEPRECATED, SEE go/udr/migrate-wma. ***. We still allow legacy use case to exist (no forced migration), but we will not accept any new usage of WMA, incl. from existing clients. UDR has the same features and can be used similarly: – To consume the topical entities (+properties, incl. hitcat, browsy, …) go/udr/migrate-wma provides a migration with minimal changes. – To consume IQL, please consult go/udr/superroot#access and go/pianno team. The top-level proto used to store WebRef entities and IQL expressions in Mustang/TG. The proto uses packed repeated fields and variable-length integers in order to be as compact as possible. See http://b/5802389 and b/7473898 for details on other approaches that were considered and space/readability/extensibility trade-offs made. Note: It is not recommeded to read this proto directly. Clients of the attachment should use the decoder instead: repository/webref/tools/kc/indexing/webref-attachment-decoder.h Next available tag: 25 | list(RepositoryWebrefWebrefAttachmentMetadata) |
| iqlAttachment | A sub-proto to encode IQL expressions. To be used by Pianno page-level intents and Webref Compounds. | RepositoryWebrefWebrefMustangAttachment | *** THIS ATTACHMENT IS DEPRECATED, SEE go/udr/migrate-wma. ***. We still allow legacy use case to exist (no forced migration), but we will not accept any new usage of WMA, incl. from existing clients. UDR has the same features and can be used similarly: – To consume the topical entities (+properties, incl. hitcat, browsy, …) go/udr/migrate-wma provides a migration with minimal changes. – To consume IQL, please consult go/udr/superroot#access and go/pianno team. The top-level proto used to store WebRef entities and IQL expressions in Mustang/TG. The proto uses packed repeated fields and variable-length integers in order to be as compact as possible. See http://b/5802389 and b/7473898 for details on other approaches that were considered and space/readability/extensibility trade-offs made. Note: It is not recommeded to read this proto directly. Clients of the attachment should use the decoder instead: repository/webref/tools/kc/indexing/webref-attachment-decoder.h Next available tag: 25 | KnowledgeAnswersIntentQueryIndexingIQLAttachment |
| isAuthorIndex | The indices of all the reference entities in encoded_mid that are authors of the page. Not packed as in most cases when populated, it contains 1 element. | RepositoryWebrefWebrefMustangAttachment | *** THIS ATTACHMENT IS DEPRECATED, SEE go/udr/migrate-wma. ***. We still allow legacy use case to exist (no forced migration), but we will not accept any new usage of WMA, incl. from existing clients. UDR has the same features and can be used similarly: – To consume the topical entities (+properties, incl. hitcat, browsy, …) go/udr/migrate-wma provides a migration with minimal changes. – To consume IQL, please consult go/udr/superroot#access and go/pianno team. The top-level proto used to store WebRef entities and IQL expressions in Mustang/TG. The proto uses packed repeated fields and variable-length integers in order to be as compact as possible. See http://b/5802389 and b/7473898 for details on other approaches that were considered and space/readability/extensibility trade-offs made. Note: It is not recommeded to read this proto directly. Clients of the attachment should use the decoder instead: repository/webref/tools/kc/indexing/webref-attachment-decoder.h Next available tag: 25 | list(integer) |
| isPublisherIndex | The indices of all the reference entities in encoded_mid that are publishers of the page (e.g. /m/cnn on “http://www.cnn.com/foo/bar”). Not packed as in most cases when populated, it contains 1 element. | RepositoryWebrefWebrefMustangAttachment | *** THIS ATTACHMENT IS DEPRECATED, SEE go/udr/migrate-wma. ***. We still allow legacy use case to exist (no forced migration), but we will not accept any new usage of WMA, incl. from existing clients. UDR has the same features and can be used similarly: – To consume the topical entities (+properties, incl. hitcat, browsy, …) go/udr/migrate-wma provides a migration with minimal changes. – To consume IQL, please consult go/udr/superroot#access and go/pianno team. The top-level proto used to store WebRef entities and IQL expressions in Mustang/TG. The proto uses packed repeated fields and variable-length integers in order to be as compact as possible. See http://b/5802389 and b/7473898 for details on other approaches that were considered and space/readability/extensibility trade-offs made. Note: It is not recommeded to read this proto directly. Clients of the attachment should use the decoder instead: repository/webref/tools/kc/indexing/webref-attachment-decoder.h Next available tag: 25 | list(integer) |
| referencePageIndex | Only populated when the document is a reference page for an entity. Contains the indices of all reference entities in the encoded_mid and topicality_e2 arrays. Not packed as in most cases when populated, it contains 1 element. | RepositoryWebrefWebrefMustangAttachment | *** THIS ATTACHMENT IS DEPRECATED, SEE go/udr/migrate-wma. ***. We still allow legacy use case to exist (no forced migration), but we will not accept any new usage of WMA, incl. from existing clients. UDR has the same features and can be used similarly: – To consume the topical entities (+properties, incl. hitcat, browsy, …) go/udr/migrate-wma provides a migration with minimal changes. – To consume IQL, please consult go/udr/superroot#access and go/pianno team. The top-level proto used to store WebRef entities and IQL expressions in Mustang/TG. The proto uses packed repeated fields and variable-length integers in order to be as compact as possible. See http://b/5802389 and b/7473898 for details on other approaches that were considered and space/readability/extensibility trade-offs made. Note: It is not recommeded to read this proto directly. Clients of the attachment should use the decoder instead: repository/webref/tools/kc/indexing/webref-attachment-decoder.h Next available tag: 25 | list(integer) |
| topicalityE2 | The topicality scores of all entities in the encoded_mid array. For space reasons this is represented as a fixed-point integer with two decimal points precision. Convert it to topicality_score using the following formula: float topicality_score = topicality_e2 / 100.f Should have the same number of elements as the encoded_mid field. | RepositoryWebrefWebrefMustangAttachment | *** THIS ATTACHMENT IS DEPRECATED, SEE go/udr/migrate-wma. ***. We still allow legacy use case to exist (no forced migration), but we will not accept any new usage of WMA, incl. from existing clients. UDR has the same features and can be used similarly: – To consume the topical entities (+properties, incl. hitcat, browsy, …) go/udr/migrate-wma provides a migration with minimal changes. – To consume IQL, please consult go/udr/superroot#access and go/pianno team. The top-level proto used to store WebRef entities and IQL expressions in Mustang/TG. The proto uses packed repeated fields and variable-length integers in order to be as compact as possible. See http://b/5802389 and b/7473898 for details on other approaches that were considered and space/readability/extensibility trade-offs made. Note: It is not recommeded to read this proto directly. Clients of the attachment should use the decoder instead: repository/webref/tools/kc/indexing/webref-attachment-decoder.h Next available tag: 25 | list(integer) |
| unboundIntentMid | The uint64-encoded MID of the unbound intents generated by Pianno. An unbound intent is the annotation of an intent without slots arguments (e.g. Age) declared in Intent Catalog. See go/pianno-asteroid-belt-migration for details. We only keep the top unbound intents with the highest orbit scores. Should have the same number of elements as unbound_intent_score_e2. | RepositoryWebrefWebrefMustangAttachment | *** THIS ATTACHMENT IS DEPRECATED, SEE go/udr/migrate-wma. ***. We still allow legacy use case to exist (no forced migration), but we will not accept any new usage of WMA, incl. from existing clients. UDR has the same features and can be used similarly: – To consume the topical entities (+properties, incl. hitcat, browsy, …) go/udr/migrate-wma provides a migration with minimal changes. – To consume IQL, please consult go/udr/superroot#access and go/pianno team. The top-level proto used to store WebRef entities and IQL expressions in Mustang/TG. The proto uses packed repeated fields and variable-length integers in order to be as compact as possible. See http://b/5802389 and b/7473898 for details on other approaches that were considered and space/readability/extensibility trade-offs made. Note: It is not recommeded to read this proto directly. Clients of the attachment should use the decoder instead: repository/webref/tools/kc/indexing/webref-attachment-decoder.h Next available tag: 25 | list(String) |
| unboundIntentScoreE2 | The confidence of the unbound intent. represented as a fixed-point integer with two decimal precision. In the range [0, 100]. Should have the same number of elements as unbound_intent_mid. | RepositoryWebrefWebrefMustangAttachment | *** THIS ATTACHMENT IS DEPRECATED, SEE go/udr/migrate-wma. ***. We still allow legacy use case to exist (no forced migration), but we will not accept any new usage of WMA, incl. from existing clients. UDR has the same features and can be used similarly: – To consume the topical entities (+properties, incl. hitcat, browsy, …) go/udr/migrate-wma provides a migration with minimal changes. – To consume IQL, please consult go/udr/superroot#access and go/pianno team. The top-level proto used to store WebRef entities and IQL expressions in Mustang/TG. The proto uses packed repeated fields and variable-length integers in order to be as compact as possible. See http://b/5802389 and b/7473898 for details on other approaches that were considered and space/readability/extensibility trade-offs made. Note: It is not recommeded to read this proto directly. Clients of the attachment should use the decoder instead: repository/webref/tools/kc/indexing/webref-attachment-decoder.h Next available tag: 25 | list(integer) |
| byteLength | The length in bytes of such a link (including internal spaces); e.g. if the link text is “click here” then the length is 10. | RepositoryWebrefWebrefOutlinkInfo | Information about the outlinks for one specific target URL, from a given annotated document. Next available tag: 7 | list(String) |
| byteOffset | The byte offset of the start of a link with this target URL, in the content of the annotated document. | RepositoryWebrefWebrefOutlinkInfo | Information about the outlinks for one specific target URL, from a given annotated document. Next available tag: 7 | list(String) |
| isNofollow | Whether this is a nofollow link (https://en.wikipedia.org/wiki/Nofollow). If the page has multiple links to the same url, all of them must be nofollow to set this field. | RepositoryWebrefWebrefOutlinkInfo | Information about the outlinks for one specific target URL, from a given annotated document. Next available tag: 7 | boolean |
| topicalityWeight | The topicality_weight for each link with this target URL. | RepositoryWebrefWebrefOutlinkInfo | Information about the outlinks for one specific target URL, from a given annotated document. Next available tag: 7 | list(number) |
| url | The target URL of the link. | RepositoryWebrefWebrefOutlinkInfo | Information about the outlinks for one specific target URL, from a given annotated document. Next available tag: 7 | String |
| outlinkInfo | Information about each target URL referred to in the document’s outlinks. If a given URL has multiple links, they are grouped in a single WebrefLinkInfo. | RepositoryWebrefWebrefOutlinkInfos | Information about the outlinks of an annotated document. Next available tag: 3 | list(RepositoryWebrefWebrefOutlinkInfo) |
| dataEpoch | The epoch of the Webref static data (the name-filter.data file). As of Dec 2020 in prod Goldmine (in webref_daily_full_model_static_data) this value is over from the alpha model static data, since this is where most of the parts come from. I.e. the value does not correspond to the actual model being used. | RepositoryWebrefWebrefStatus | String | |
| utilStatus | Error that occurred during the annotation. This field is only populated by QRef (i.e. under QueryJoin.status) and never by WebRef (i.e. under WebrefEntities.status) anymore, which instead reports errors (and soon also taints) through standard Goldmine mechanisms. | RepositoryWebrefWebrefStatus | UtilStatusProto | |
| version | The version number of the annotator (the cl the binary was built from). Must be enabled via a command line flag. See also the Goldmine’s indexing::annotations::AnnotationMeta proto. | RepositoryWebrefWebrefStatus | integer | |
| categoryName | RepositoryWebrefWikipediaCategory | Information about a Wikipedia category (typically at the bottom of the page). | String | |
| location | The location as extracted from the wikijoins. | RepositoryWebrefWikipediaGeocode | Geocodes extracted from the wikijoins. | GeostorePointProto |
| sourceUrl | The source contains the url field from the wikijoins. | RepositoryWebrefWikipediaGeocode | Geocodes extracted from the wikijoins. | String |
| disjunctionId | disjunction_id / is_positive *MUST* have the same length. They specify a set of disjunctions that make up this conjunction. The conjunction will be active iff *all* of the positive disjunctions are active and *all* of the negative disjunctions are inactive. | ResearchScamCoscamConjunction | ////////////////////////////////////////////////////////////////////////////// Conjunction: a single AND clause that contains multiple disjunctions. | list(String) |
| isPositive | ResearchScamCoscamConjunction | ////////////////////////////////////////////////////////////////////////////// Conjunction: a single AND clause that contains multiple disjunctions. | list(boolean) | |
| key | key – a uint64 key that uniquely identifies this disjunction. | ResearchScamCoscamDisjunction | ////////////////////////////////////////////////////////////////////////////// Disjunction: a single OR clause that contains multiple group:token tuples. | String |
| tokenGroups | groups – the group:token tuples that make up this disjunction. The disjunction will be active if *any* off the group:token tuples are present in a request. | ResearchScamCoscamDisjunction | ////////////////////////////////////////////////////////////////////////////// Disjunction: a single OR clause that contains multiple group:token tuples. | list(ResearchScamCoscamTokenGroup) |
| disjunctions | disjunctions is the set of OR clauses that | ResearchScamCoscamEasyConjunction | Each EasyConjunction represents an AND-of-ORs block. | list(ResearchScamCoscamEasyDisjunction) |
| isPositive | If is_positive is set to false, then the entire disjunction is negated, and will be true only if none of its members is true. | ResearchScamCoscamEasyDisjunction | Each EasyDisjunction represents one OR clause. | boolean |
| tokenGroups | token_groups – the group:token tuples that make up this disjunction. The disjunction will be active if *any* off the group:token tuples are present in a request. | ResearchScamCoscamEasyDisjunction | Each EasyDisjunction represents one OR clause. | list(ResearchScamCoscamTokenGroup) |
| conjunctions | conjunctions is the set of AND-of-ORs blocks. | ResearchScamCoscamEasyRestrictDefinition | Each EasyRestrictDefinition represents an OR-of-ANDs-of-ORs block. | list(ResearchScamCoscamEasyConjunction) |
| conjunctions | conjunctions – each conjunction is an AND-of-ORs; if any of these conjunctions match, then the entire restrict matches. | ResearchScamCoscamRestrictDefinition | ////////////////////////////////////////////////////////////////////////////// RestrictDefinition: the set of conjunctions and disjunctions that define a single OR-of-ANDs-of-ORs restrict definition. | list(ResearchScamCoscamConjunction) |
| disjunctions | disjunctions – each disjunction is an OR clause. | ResearchScamCoscamRestrictDefinition | ////////////////////////////////////////////////////////////////////////////// RestrictDefinition: the set of conjunctions and disjunctions that define a single OR-of-ANDs-of-ORs restrict definition. | list(ResearchScamCoscamDisjunction) |
| subsKey | subs_key – ignore. Only used for testing. | ResearchScamCoscamRestrictDefinition | ////////////////////////////////////////////////////////////////////////////// RestrictDefinition: the set of conjunctions and disjunctions that define a single OR-of-ANDs-of-ORs restrict definition. | String |
| tokenGroups | token_groups – group:token tuples, collated by group. | ResearchScamCoscamRestrictTokensV2 | ////////////////////////////////////////////////////////////////////////////// RestrictTokensV2: a set of group:token tuples, collated by group. | list(ResearchScamCoscamTokenGroup) |
| debugTokenStrings | debug_token_strings – (optional) strings that should be used for human-friendly printing. NOT used by the matching engine! | ResearchScamCoscamTokenGroup | list(String) | |
| name | name – the name of the token group. | ResearchScamCoscamTokenGroup | String | |
| tokens | tokens – a list of tokens, stored by their Fingerprint2011 hash. | ResearchScamCoscamTokenGroup | list(String) | |
| namespace | The name of this namespacey | ResearchScamCustomRestrictNamespace | The custom restrict namespace proto. Note that custom restrict don’t have to be symmetric. That is, this proto is always needed in the query, but only optionally in database datapoints, as some custom restrict implementations may use alternative data sources, instead of |GenericFeatureVector.restrict_tokens.v3.custom_namespaces| field. | String |
| classLabel | The class label of this datapoint. This should be populated if ScaM is being used for nearest-neighbor-based classification. | ResearchScamGenericFeatureVector | !ERROR! D11155 -> Formula Error: An unexpected error occurred | String |
| crowding | ResearchScamGenericFeatureVector | !ERROR! D11156 -> Formula Error: An unexpected error occurred | ResearchScamGenericFeatureVectorCrowding | |
| dataIdStr | Optional point id that can contain an arbitrary (unrestricted in content) value except when the data is provided via SSTable (sharded or not). In the case of SSTable the data_id_str must be set for _all_ points in all shards or the SSTable keys will be used as the values for the data_id_str of the respective points. In either SSTable case–data_id_str provided explicitly or via the key–the values must be unique across all shards. | ResearchScamGenericFeatureVector | !ERROR! D11157 -> Formula Error: An unexpected error occurred | String |
| expirationTimestamp | A timestamp after which this datapoint is considered no longer valid and is eligible for deletion. The exact meaning varies with application/configuration. | ResearchScamGenericFeatureVector | !ERROR! D11158 -> Formula Error: An unexpected error occurred | DateTime |
| featureDim | – Optionally explicitly specifies the dimensionality of this vector. For dense vectors, this is ignored and, dimensionality is inferred from the number of values specified, and must be identical to this, or unspecified. For sparse vectors, the default value is correct for most users, and allows use of 64-bit hash values for feature indices. If you’re using sparse vectors with a limited range of dimension indices and want to do K-Means clustering with them, you may want to specify this explicitly. | ResearchScamGenericFeatureVector | !ERROR! D11159 -> Formula Error: An unexpected error occurred | String |
| featureIndex | – for SPARSE vectors, specifies indices of the nonzero dimensions whose values are specified by the , , or field. This field is not used when specifying dense vectors. | ResearchScamGenericFeatureVector | !ERROR! D11160 -> Formula Error: An unexpected error occurred | list(String) |
| featureType | Describes the type of feature values. | ResearchScamGenericFeatureVector | !ERROR! D11161 -> Formula Error: An unexpected error occurred | String |
| featureValueDouble | ResearchScamGenericFeatureVector | !ERROR! D11162 -> Formula Error: An unexpected error occurred | list(float) | |
| featureValueFloat | Actual feature vector. Only one of the following should be populated. This list has to be kept in sync with FeatureType enum. NOTES: Binary features are stored as ones or zeroes in feature_value_int64. Floating point values (feature_value_float, feature_value_double) may not be NaN. | ResearchScamGenericFeatureVector | !ERROR! D11163 -> Formula Error: An unexpected error occurred | list(number) |
| featureValueInt64 | ResearchScamGenericFeatureVector | !ERROR! D11164 -> Formula Error: An unexpected error occurred | list(String) | |
| featureValueString | ResearchScamGenericFeatureVector | !ERROR! D11165 -> Formula Error: An unexpected error occurred | String | |
| fixedPointMetadata | ResearchScamGenericFeatureVector | !ERROR! D11166 -> Formula Error: An unexpected error occurred | ResearchScamGenericFeatureVectorFixedPointMetadata | |
| internalOnlyIsSecondaryPartition | copybara:strip_begin INTERNAL USE ONLY! The ScaM Team reserves the right to remove this field and reuse its proto tag without notice. DO NOT USE outside of build_shards_pipeline! This field is used inside build_shards_pipeline to indicate whether this GFV is residing in its secondary (vs. primary) partition. copybara:strip_end | ResearchScamGenericFeatureVector | !ERROR! D11167 -> Formula Error: An unexpected error occurred | boolean |
| normType | Describes if data has been normalized and the type. | ResearchScamGenericFeatureVector | !ERROR! D11168 -> Formula Error: An unexpected error occurred | String |
| queryMetadata | copybara:strip_begin A field that contains metadata information when the datapoint is acting as a query. copybara:strip_end | ResearchScamGenericFeatureVector | !ERROR! D11169 -> Formula Error: An unexpected error occurred | ResearchScamQueryMetadata |
| restrictTokens | copybara:strip_end_and_replace reserved 15; | ResearchScamGenericFeatureVector | !ERROR! D11170 -> Formula Error: An unexpected error occurred | ResearchScamGenericFeatureVectorRestrictTokens |
| tokens | ResearchScamGenericFeatureVector | !ERROR! D11171 -> Formula Error: An unexpected error occurred | list(integer) | |
| userinfo | This field allows application-specific metadata to be stored in a GFV. This information may be used by custom binaries or in pre- or postprocessing outside of ScaM. Use cases include but are not limited to: * Dataset IDs, if multiple datasets are multiplexed into one physical file or network location. * An alternative, possibly more human-readable representation of the data represented by this GFV, for e.g. debugging purposes. * Outputting the contents of this field verbatim to the metadata field of the NearestNeighbors.Neighbor proto. | ResearchScamGenericFeatureVector | !ERROR! D11172 -> Formula Error: An unexpected error occurred | String |
| weight | DEPRECATED fields. Ignored by ScaM binaries. Do not use. | ResearchScamGenericFeatureVector | !ERROR! D11173 -> Formula Error: An unexpected error occurred | number |
| crowdingAttribute | The value of the crowding attribute for this document. The maximum number of neighbors to return per crowding attribute value (per_crowding_attribute_num_neighbors) is configured per-query. This field is ignored if per_crowding_attribute_num_neighbors is larger than the total number of neighbors to return for a given query. | ResearchScamGenericFeatureVectorCrowding | This subproto contains configuration for crowding. Crowding is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than some value k’ of the k neighbors returned have the same value of crowding_attribute. | String |
| squaredL2Norm | The squared L2 norm of the original (pre-fixed-point transformation) GFV. Used for computing squared L2 distance. | ResearchScamGenericFeatureVectorFixedPointMetadata | Metadata that may be populated if this GFV was transformed into fixed-point from a floating-point GFV. | number |
| blacklistToken | ResearchScamGenericFeatureVectorRestrictTokens | copybara:strip_begin RestrictTokens – used to perform “restricted searches” where boolean rules are used to filter the subset of the database eligible for matching. We currently support V1 and V3 restrict systems. V3 restrict is a superset of V1 restrict. New users are encouraged to use V3 directly for its rich features and cleaner semantics. See the document go/scam-v3-restricts, or read the comments in //research/scam/proto/restricts.proto for details. Nevertheless, V1 restrict is still supported by ScaM team. There’s some minor tradeoff of performance between V1 and V3. User may prefer V1 over V3 if performance is the first priority. However, the CPU cost between V1 and V3 should be very minor. ————————————————————————— The semantics of V1 restrict is described below: V1 “forward” restricts: The dataset defines a many:many mapping between the database points and a token space. Each token names a set of tokens and each database point is a member of zero-to-many tokens. Queries specify zero-to-many whitelist and blacklist tokens that activate database points according to the following rules: * If whitelist_token is populated, the search will be restricted to points named by at least one whitelist token. If whitelist_token is empty, all points are whitelisted by default. * If blacklist_token is populated, it overrides the whitelist. Points named by a blacklisted token are *not* searched. * Note that, if neither whitelist_token nor blacklist_token is populated, the search remains unrestricted. ————————————————————————— V1 “reverse” restricts: Each database point is whitelisted and/or blacklisted for zero or more tokens, specified by whitelist_token and blacklist_token fields. Each query specifies zero or more tokens, and the same rules apply: * If a point’s whitelist_token is populated, the point will only be searched if the query has at least one matching whitelist token. If whitelist_token is empty, the point is always whitelisted by default. * If a point’s blacklist_token is populated, it overrides the whitelist. The point will be ignored for any query with a matching blacklist token. * Note that, if neither whitelist_token nor blacklist_token is populated, the point will always be searched. NEXT ID TO USE: 9 | list(String) | |
| definition | DEPRECATED | ResearchScamGenericFeatureVectorRestrictTokens | copybara:strip_begin RestrictTokens – used to perform “restricted searches” where boolean rules are used to filter the subset of the database eligible for matching. We currently support V1 and V3 restrict systems. V3 restrict is a superset of V1 restrict. New users are encouraged to use V3 directly for its rich features and cleaner semantics. See the document go/scam-v3-restricts, or read the comments in //research/scam/proto/restricts.proto for details. Nevertheless, V1 restrict is still supported by ScaM team. There’s some minor tradeoff of performance between V1 and V3. User may prefer V1 over V3 if performance is the first priority. However, the CPU cost between V1 and V3 should be very minor. ————————————————————————— The semantics of V1 restrict is described below: V1 “forward” restricts: The dataset defines a many:many mapping between the database points and a token space. Each token names a set of tokens and each database point is a member of zero-to-many tokens. Queries specify zero-to-many whitelist and blacklist tokens that activate database points according to the following rules: * If whitelist_token is populated, the search will be restricted to points named by at least one whitelist token. If whitelist_token is empty, all points are whitelisted by default. * If blacklist_token is populated, it overrides the whitelist. Points named by a blacklisted token are *not* searched. * Note that, if neither whitelist_token nor blacklist_token is populated, the search remains unrestricted. ————————————————————————— V1 “reverse” restricts: Each database point is whitelisted and/or blacklisted for zero or more tokens, specified by whitelist_token and blacklist_token fields. Each query specifies zero or more tokens, and the same rules apply: * If a point’s whitelist_token is populated, the point will only be searched if the query has at least one matching whitelist token. If whitelist_token is empty, the point is always whitelisted by default. * If a point’s blacklist_token is populated, it overrides the whitelist. The point will be ignored for any query with a matching blacklist token. * Note that, if neither whitelist_token nor blacklist_token is populated, the point will always be searched. NEXT ID TO USE: 9 | ResearchScamCoscamRestrictDefinition |
| easyDefinition | DEPRECATED | ResearchScamGenericFeatureVectorRestrictTokens | copybara:strip_begin RestrictTokens – used to perform “restricted searches” where boolean rules are used to filter the subset of the database eligible for matching. We currently support V1 and V3 restrict systems. V3 restrict is a superset of V1 restrict. New users are encouraged to use V3 directly for its rich features and cleaner semantics. See the document go/scam-v3-restricts, or read the comments in //research/scam/proto/restricts.proto for details. Nevertheless, V1 restrict is still supported by ScaM team. There’s some minor tradeoff of performance between V1 and V3. User may prefer V1 over V3 if performance is the first priority. However, the CPU cost between V1 and V3 should be very minor. ————————————————————————— The semantics of V1 restrict is described below: V1 “forward” restricts: The dataset defines a many:many mapping between the database points and a token space. Each token names a set of tokens and each database point is a member of zero-to-many tokens. Queries specify zero-to-many whitelist and blacklist tokens that activate database points according to the following rules: * If whitelist_token is populated, the search will be restricted to points named by at least one whitelist token. If whitelist_token is empty, all points are whitelisted by default. * If blacklist_token is populated, it overrides the whitelist. Points named by a blacklisted token are *not* searched. * Note that, if neither whitelist_token nor blacklist_token is populated, the search remains unrestricted. ————————————————————————— V1 “reverse” restricts: Each database point is whitelisted and/or blacklisted for zero or more tokens, specified by whitelist_token and blacklist_token fields. Each query specifies zero or more tokens, and the same rules apply: * If a point’s whitelist_token is populated, the point will only be searched if the query has at least one matching whitelist token. If whitelist_token is empty, the point is always whitelisted by default. * If a point’s blacklist_token is populated, it overrides the whitelist. The point will be ignored for any query with a matching blacklist token. * Note that, if neither whitelist_token nor blacklist_token is populated, the point will always be searched. NEXT ID TO USE: 9 | ResearchScamCoscamEasyRestrictDefinition |
| tokenMembership | B) Token Definitions (V1 Restricts) In “forward” mode: defined on database points In “reverse” mode: defined on queries | ResearchScamGenericFeatureVectorRestrictTokens | copybara:strip_begin RestrictTokens – used to perform “restricted searches” where boolean rules are used to filter the subset of the database eligible for matching. We currently support V1 and V3 restrict systems. V3 restrict is a superset of V1 restrict. New users are encouraged to use V3 directly for its rich features and cleaner semantics. See the document go/scam-v3-restricts, or read the comments in //research/scam/proto/restricts.proto for details. Nevertheless, V1 restrict is still supported by ScaM team. There’s some minor tradeoff of performance between V1 and V3. User may prefer V1 over V3 if performance is the first priority. However, the CPU cost between V1 and V3 should be very minor. ————————————————————————— The semantics of V1 restrict is described below: V1 “forward” restricts: The dataset defines a many:many mapping between the database points and a token space. Each token names a set of tokens and each database point is a member of zero-to-many tokens. Queries specify zero-to-many whitelist and blacklist tokens that activate database points according to the following rules: * If whitelist_token is populated, the search will be restricted to points named by at least one whitelist token. If whitelist_token is empty, all points are whitelisted by default. * If blacklist_token is populated, it overrides the whitelist. Points named by a blacklisted token are *not* searched. * Note that, if neither whitelist_token nor blacklist_token is populated, the search remains unrestricted. ————————————————————————— V1 “reverse” restricts: Each database point is whitelisted and/or blacklisted for zero or more tokens, specified by whitelist_token and blacklist_token fields. Each query specifies zero or more tokens, and the same rules apply: * If a point’s whitelist_token is populated, the point will only be searched if the query has at least one matching whitelist token. If whitelist_token is empty, the point is always whitelisted by default. * If a point’s blacklist_token is populated, it overrides the whitelist. The point will be ignored for any query with a matching blacklist token. * Note that, if neither whitelist_token nor blacklist_token is populated, the point will always be searched. NEXT ID TO USE: 9 | list(String) |
| tokens | DEPRECATED | ResearchScamGenericFeatureVectorRestrictTokens | copybara:strip_begin RestrictTokens – used to perform “restricted searches” where boolean rules are used to filter the subset of the database eligible for matching. We currently support V1 and V3 restrict systems. V3 restrict is a superset of V1 restrict. New users are encouraged to use V3 directly for its rich features and cleaner semantics. See the document go/scam-v3-restricts, or read the comments in //research/scam/proto/restricts.proto for details. Nevertheless, V1 restrict is still supported by ScaM team. There’s some minor tradeoff of performance between V1 and V3. User may prefer V1 over V3 if performance is the first priority. However, the CPU cost between V1 and V3 should be very minor. ————————————————————————— The semantics of V1 restrict is described below: V1 “forward” restricts: The dataset defines a many:many mapping between the database points and a token space. Each token names a set of tokens and each database point is a member of zero-to-many tokens. Queries specify zero-to-many whitelist and blacklist tokens that activate database points according to the following rules: * If whitelist_token is populated, the search will be restricted to points named by at least one whitelist token. If whitelist_token is empty, all points are whitelisted by default. * If blacklist_token is populated, it overrides the whitelist. Points named by a blacklisted token are *not* searched. * Note that, if neither whitelist_token nor blacklist_token is populated, the search remains unrestricted. ————————————————————————— V1 “reverse” restricts: Each database point is whitelisted and/or blacklisted for zero or more tokens, specified by whitelist_token and blacklist_token fields. Each query specifies zero or more tokens, and the same rules apply: * If a point’s whitelist_token is populated, the point will only be searched if the query has at least one matching whitelist token. If whitelist_token is empty, the point is always whitelisted by default. * If a point’s blacklist_token is populated, it overrides the whitelist. The point will be ignored for any query with a matching blacklist token. * Note that, if neither whitelist_token nor blacklist_token is populated, the point will always be searched. NEXT ID TO USE: 9 | ResearchScamCoscamRestrictTokensV2 |
| v3 | Only ONE of the following sections should be used: A) V3 restricts. Defined in //research/scam/proto/restricts.proto | ResearchScamGenericFeatureVectorRestrictTokens | copybara:strip_begin RestrictTokens – used to perform “restricted searches” where boolean rules are used to filter the subset of the database eligible for matching. We currently support V1 and V3 restrict systems. V3 restrict is a superset of V1 restrict. New users are encouraged to use V3 directly for its rich features and cleaner semantics. See the document go/scam-v3-restricts, or read the comments in //research/scam/proto/restricts.proto for details. Nevertheless, V1 restrict is still supported by ScaM team. There’s some minor tradeoff of performance between V1 and V3. User may prefer V1 over V3 if performance is the first priority. However, the CPU cost between V1 and V3 should be very minor. ————————————————————————— The semantics of V1 restrict is described below: V1 “forward” restricts: The dataset defines a many:many mapping between the database points and a token space. Each token names a set of tokens and each database point is a member of zero-to-many tokens. Queries specify zero-to-many whitelist and blacklist tokens that activate database points according to the following rules: * If whitelist_token is populated, the search will be restricted to points named by at least one whitelist token. If whitelist_token is empty, all points are whitelisted by default. * If blacklist_token is populated, it overrides the whitelist. Points named by a blacklisted token are *not* searched. * Note that, if neither whitelist_token nor blacklist_token is populated, the search remains unrestricted. ————————————————————————— V1 “reverse” restricts: Each database point is whitelisted and/or blacklisted for zero or more tokens, specified by whitelist_token and blacklist_token fields. Each query specifies zero or more tokens, and the same rules apply: * If a point’s whitelist_token is populated, the point will only be searched if the query has at least one matching whitelist token. If whitelist_token is empty, the point is always whitelisted by default. * If a point’s blacklist_token is populated, it overrides the whitelist. The point will be ignored for any query with a matching blacklist token. * Note that, if neither whitelist_token nor blacklist_token is populated, the point will always be searched. NEXT ID TO USE: 9 | ResearchScamV3Restrict |
| v3CompatibleNamespace | If this field is not empty, when query is in V1 restricts while database is in V3 restricts, SCaM will update V1 query to V3 automatically instead of sending error messages. When updating query from V1 to V3, SCaM server will use this field to fillin the ‘namespace’ field. | ResearchScamGenericFeatureVectorRestrictTokens | copybara:strip_begin RestrictTokens – used to perform “restricted searches” where boolean rules are used to filter the subset of the database eligible for matching. We currently support V1 and V3 restrict systems. V3 restrict is a superset of V1 restrict. New users are encouraged to use V3 directly for its rich features and cleaner semantics. See the document go/scam-v3-restricts, or read the comments in //research/scam/proto/restricts.proto for details. Nevertheless, V1 restrict is still supported by ScaM team. There’s some minor tradeoff of performance between V1 and V3. User may prefer V1 over V3 if performance is the first priority. However, the CPU cost between V1 and V3 should be very minor. ————————————————————————— The semantics of V1 restrict is described below: V1 “forward” restricts: The dataset defines a many:many mapping between the database points and a token space. Each token names a set of tokens and each database point is a member of zero-to-many tokens. Queries specify zero-to-many whitelist and blacklist tokens that activate database points according to the following rules: * If whitelist_token is populated, the search will be restricted to points named by at least one whitelist token. If whitelist_token is empty, all points are whitelisted by default. * If blacklist_token is populated, it overrides the whitelist. Points named by a blacklisted token are *not* searched. * Note that, if neither whitelist_token nor blacklist_token is populated, the search remains unrestricted. ————————————————————————— V1 “reverse” restricts: Each database point is whitelisted and/or blacklisted for zero or more tokens, specified by whitelist_token and blacklist_token fields. Each query specifies zero or more tokens, and the same rules apply: * If a point’s whitelist_token is populated, the point will only be searched if the query has at least one matching whitelist token. If whitelist_token is empty, the point is always whitelisted by default. * If a point’s blacklist_token is populated, it overrides the whitelist. The point will be ignored for any query with a matching blacklist token. * Note that, if neither whitelist_token nor blacklist_token is populated, the point will always be searched. NEXT ID TO USE: 9 | String |
| whitelistToken | C) Whitelist / Blacklist Definitions (V1 Restricts) In “forward” mode: defined on queries In “reverse” mode: defined on database points | ResearchScamGenericFeatureVectorRestrictTokens | copybara:strip_begin RestrictTokens – used to perform “restricted searches” where boolean rules are used to filter the subset of the database eligible for matching. We currently support V1 and V3 restrict systems. V3 restrict is a superset of V1 restrict. New users are encouraged to use V3 directly for its rich features and cleaner semantics. See the document go/scam-v3-restricts, or read the comments in //research/scam/proto/restricts.proto for details. Nevertheless, V1 restrict is still supported by ScaM team. There’s some minor tradeoff of performance between V1 and V3. User may prefer V1 over V3 if performance is the first priority. However, the CPU cost between V1 and V3 should be very minor. ————————————————————————— The semantics of V1 restrict is described below: V1 “forward” restricts: The dataset defines a many:many mapping between the database points and a token space. Each token names a set of tokens and each database point is a member of zero-to-many tokens. Queries specify zero-to-many whitelist and blacklist tokens that activate database points according to the following rules: * If whitelist_token is populated, the search will be restricted to points named by at least one whitelist token. If whitelist_token is empty, all points are whitelisted by default. * If blacklist_token is populated, it overrides the whitelist. Points named by a blacklisted token are *not* searched. * Note that, if neither whitelist_token nor blacklist_token is populated, the search remains unrestricted. ————————————————————————— V1 “reverse” restricts: Each database point is whitelisted and/or blacklisted for zero or more tokens, specified by whitelist_token and blacklist_token fields. Each query specifies zero or more tokens, and the same rules apply: * If a point’s whitelist_token is populated, the point will only be searched if the query has at least one matching whitelist token. If whitelist_token is empty, the point is always whitelisted by default. * If a point’s blacklist_token is populated, it overrides the whitelist. The point will be ignored for any query with a matching blacklist token. * Note that, if neither whitelist_token nor blacklist_token is populated, the point will always be searched. NEXT ID TO USE: 9 | list(String) |
| docid | Data point for which we computed nearest neighbors. This field is set based on the data_id_str field in the QueryRequest GFV (or SSTable key if data_id_str is not present), and thus can be arbitrary data, e.g. docid, URL, query string. | ResearchScamNearestNeighbors | All nearest neighbors for one data point. Last tag used: 5 | String |
| metadata | Metadata about the query. This field is populated if and only if: 1) ScaM is running in offline query-database or online mode and; 2) The metadata is directly fetched from the userinfo field inside GFV and; 3) MetadataConfig.userinfo.set_user_info_for_query is set to true. The field name is kept as “metadata” for consistency with neighbors. | ResearchScamNearestNeighbors | All nearest neighbors for one data point. Last tag used: 5 | String |
| neighbor | All its neighbors. | ResearchScamNearestNeighbors | All nearest neighbors for one data point. Last tag used: 5 | list(ResearchScamNearestNeighborsNeighbor) |
| neighborSelectionOverride | Propagate neighbor selection override information during offline search. | ResearchScamNearestNeighbors | All nearest neighbors for one data point. Last tag used: 5 | ResearchScamNeighborSelectionOverride |
| query | The query vector for which we computed nearest neighbors. | ResearchScamNearestNeighbors | All nearest neighbors for one data point. Last tag used: 5 | ResearchScamGenericFeatureVector |
| retrievedVersion | The version ID of the server that responded to this query, if one was specified. This field is not populated for offline (i.e. Flume rather than RPC) search. | ResearchScamNearestNeighbors | All nearest neighbors for one data point. Last tag used: 5 | String |
| crowdingAttribute | If crowding is enabled, the crowding attribute of this neighbor will be stored here. | ResearchScamNearestNeighborsNeighbor | String | |
| distance | This could be exact or approximate distance. | ResearchScamNearestNeighborsNeighbor | float | |
| docid | Neighbor data point. This field is set based on the data_id_str field in the GFV of the data point in the database (or SSTable key if data_id_str is not present), and thus can be arbitrary data, e.g. docid, URL, query string. | ResearchScamNearestNeighborsNeighbor | String | |
| gfv | The field isn’t populated by default, but when enabled (eg, in the ground-truth pipeline), this field provides the original database GFV corresponding to this result. | ResearchScamNearestNeighborsNeighbor | ResearchScamGenericFeatureVector | |
| metadata | Metadata about the neighbor. This is returned under some configurations as a serialized proto. The specific proto depends on which metadata is configured to be returned. | ResearchScamNearestNeighborsNeighbor | String | |
| approxEpsilonDistance | The distance threshold to use for approximate search before exact reordering is performed, if exact reordering is performed. If this is not set and exact reordering is enabled, a reasonable default value will be chosen using a heuristic specified in ScamConfig.ExactReordering.NeighborSelectionOverrideHeuristics. This field is ignored if exact reordering is not enabled. This value must be non-NaN if set. | ResearchScamNeighborSelectionOverride | Last used tag = 13 | number |
| approxNumNeighbors | The number of neighbors to find via approximate search before exact reordering is performed. If this is not set and exact reordering is enabled, a reasonable default value will be chosen using the heuristic specified in ScamConfig.ExactReordering.NeighborSelectionOverrideHeuristics. This field is ignored if exact reordering is not enabled. This value must be > 0 if set. | ResearchScamNeighborSelectionOverride | Last used tag = 13 | integer |
| epsilonDistance | The maximum distance at which to return a neighbor. If this proto is used, at least one of this and num_neighbors must be set. The default is infinity, effectively returning num_neighbors neighbors regardless of distance. This value must be non-NaN if set. | ResearchScamNeighborSelectionOverride | Last used tag = 13 | number |
| numNeighbors | The maximum number of neighbors to return. If this proto is used, at least one of this and epsilon_distance must be set. The default is the largest value representable as an int32, effectively returning all neighbors within epsilon_distance. This value must be > 0 if set. | ResearchScamNeighborSelectionOverride | Last used tag = 13 | integer |
| numSingleShardNeighbors | If populated, this is the maximum number of neighbors that may be returned from a single shard. If not populated, up to num_neighbors neighbors are returned from each shard. Setting this to a smaller value than num_neighbors will increase speed at the expense of accuray by requiring cross-shard merging of fewer neighbors. If this value is set, num_neighbors must also be set and this value must be <= num_neighbors and >= num_neighbors / number of shards. If set, this value must always be > 0. | ResearchScamNeighborSelectionOverride | Last used tag = 13 | integer |
| perCrowdingAttributeNumNeighbors | The maximum number of neighbors to return for a single value of the crowding attribute. The crowding attribute is specified per-datapoint in the GenericFeatureVector proto, or the Document proto for sparse logistic models. Crowding is described more thoroughly in research/scam/utils/crowding_top_n.h. NOTES: Crowding is effectivley enabled if this value is less than num_neighbors. | ResearchScamNeighborSelectionOverride | Last used tag = 13 | integer |
| perCrowdingAttributePreReorderingNumNeighbors | The maximum number of neighbors to return from the approximate portion of the nearest-neighbor search algorithm, within each shard, for a single value of the crowding attribute, before performing exact reordering. Ignored if exact reordering is disabled for this dataset. | ResearchScamNeighborSelectionOverride | Last used tag = 13 | integer |
| scoringExtensionMetadata | The scoring extension metadata overrides for single machine classical scam database. | ResearchScamNeighborSelectionOverride | Last used tag = 13 | ResearchScamScoringExtensionMetadata |
| treeXHybridCentersToSearch | Note: currently not implemented for all database shard subclasses! Contact ScaM before using. Provides prematched centers_to_search for tree-X hybrid searchers. Ignores any overwrites related to centroid matching since they are already matched. `tree_x_hybrid_centers_to_search` should match by size with `tree_x_hybrid_distances`. | ResearchScamNeighborSelectionOverride | Last used tag = 13 | list(integer) |
| treeXHybridDistances | ResearchScamNeighborSelectionOverride | Last used tag = 13 | list(number) | |
| treeXHybridLeavesSearchedOverride | Note: currently not implemented for all database shard subclasses! Contact ScaM before using. Overrides max_spill_centers for tree-X hybrid searchers configured with FIXED_NUMBER_OF_CENTERS spilling. The max_spill_centers in the ScaM config is used if this field isn’t set. Only valid if: * Used on a tree-X hybrid ScaM config with FIXED_NUMBER_OF_CENTERS. * Value is greater than zero and at most equal to num_children. | ResearchScamNeighborSelectionOverride | Last used tag = 13 | integer |
| namespace | The name of this namespace. | ResearchScamNumericRestrictNamespace | String | |
| op | This MUST be specified for queries and must NOT be specified for database points. | ResearchScamNumericRestrictNamespace | String | |
| valueDouble | ResearchScamNumericRestrictNamespace | float | ||
| valueFloat | ResearchScamNumericRestrictNamespace | number | ||
| valueInt | NOTE: Integers are represented in 64 bits here, but if all integer values for a given namespace fit in a narrower integer type (e.g. int8), we use the narrower integer type internally, increasing performance. | ResearchScamNumericRestrictNamespace | String | |
| cpuTime | An estimate of the CPU time used for this query on the machine associated with task_id, from when the query was received to when the response was ready to send, in seconds. Caveats: 1. Does not account for CPU time spent serializing, deserializing, compressing or decompressing protos within Stubby. 2. Does not account for cleanup time after response has been sent. | ResearchScamOnlineSearchLatencyStats | Structure to hold the response time for a node. Last used: 3 | float |
| taskId | Task number associated with response time measurements. | ResearchScamOnlineSearchLatencyStats | Structure to hold the response time for a node. Last used: 3 | integer |
| wallTime | Wall time taken on the machine associated with task_id from when the query was received to when the response was ready to send, in seconds. This time excludes the time spent sending the response and the time to perform cleanup operations after the response is sent. | ResearchScamOnlineSearchLatencyStats | Structure to hold the response time for a node. Last used: 3 | float |
| neighborSelectionOverride | ResearchScamQueryMetadata | Metadata to encode query-specific information. This may include NeighborSelectionOverride, pre-computed query tokenization, etc.. | ResearchScamNeighborSelectionOverride | |
| latency | Debugging fields: The wall and CPU time used by each query on each machine. For successful queries, there will be one entry here for each machine that the query used if QueryRequest.enable_latency_stats was enabled. For unsuccessful queries, the contents of this field will be undefined. NOTE: The following accounting rules apply in batched mode, assuming there are | ResearchScamQueryResponse | Response to a query. The main result is the nearest neighbor list, but we also optionally include debugging information if the appropriate field is set in the request. Last used: 8 | list(ResearchScamOnlineSearchLatencyStats) |
| numDeadlineExceededMachines | The number of non-root machines for which a DEADLINE_EXCEEDED error occurred when they were contacted. This value does NOT include machines for which no reply was received because their parent machine timed out. Therefore, num_total_machines may be larger than num_ok_machines + num_unreachable_machines + num_deadline_exceeded_machines. | ResearchScamQueryResponse | Response to a query. The main result is the nearest neighbor list, but we also optionally include debugging information if the appropriate field is set in the request. Last used: 8 | integer |
| numOkMachines | Number of machines that contributed to the results; this might be less than the total number of machines if a machine has failed. The impact of a single machine failure could be larger than just one machine, if it happens to be one of the machines involved in distributing the query and collecting results. | ResearchScamQueryResponse | Response to a query. The main result is the nearest neighbor list, but we also optionally include debugging information if the appropriate field is set in the request. Last used: 8 | integer |
| numTotalMachines | The number of machines used in this service for the dataset that was queried. If everything went right, this should be equal to num_ok_machines. If num_ok_machines < num_total_machines, some neighbors may be missing from results. | ResearchScamQueryResponse | Response to a query. The main result is the nearest neighbor list, but we also optionally include debugging information if the appropriate field is set in the request. Last used: 8 | integer |
| numUnreachableMachines | The number of non-root machines for which an UNREACHABLE error occurred when they were contacted. This value does NOT include machines that were implicitly unreachable because their parent machine was not reachable. Therefore, num_total_machines may be larger than num_ok_machines + num_unreachable_machines + num_deadline_exceeded_machines. | ResearchScamQueryResponse | Response to a query. The main result is the nearest neighbor list, but we also optionally include debugging information if the appropriate field is set in the request. Last used: 8 | integer |
| restrictStats | The number of “active” datapoints for each dataset, i.e. points that are whitelisted by restricts and could be returned if they were close enough to the query. For successful queries, there will be one entry here for each dataset queried, if QueryRequest.enable_restrict_stats was true. For partially-successful successful queries, this field will contain results | ResearchScamQueryResponse | Response to a query. The main result is the nearest neighbor list, but we also optionally include debugging information if the appropriate field is set in the request. Last used: 8 | list(ResearchScamRestrictStats) |
| results | The results for each dataset searched. If per_dataset_parameters was empty in QueryRequest then this will have one entry, the results for dataset 0. If per_dataset_parameters was not empty in QueryRequest, this will contain the results for each dataset queried, in order corresponding to the order of QueryRequest.per_dataset_parameters. | ResearchScamQueryResponse | Response to a query. The main result is the nearest neighbor list, but we also optionally include debugging information if the appropriate field is set in the request. Last used: 8 | list(ResearchScamNearestNeighbors) |
| status | USEFUL ONLY IN CUSTOM BINARIES. In the stock ScaM server binary, all errors are relayed via the RPC’s status. Thus, if RPC’s status is ok, this field is guaranteed to be ok and if RPC’s status is an error, no QueryResponse will be returned. The status of this query. This is useful when using a batched postprocessing lambda, which may ignore erroneous subqueries, continue postprocessing the valid ones and return OkStatus. In this case, this field will inform the client of any invalid subqueries. | ResearchScamQueryResponse | Response to a query. The main result is the nearest neighbor list, but we also optionally include debugging information if the appropriate field is set in the request. Last used: 8 | UtilStatusProto |
| applyTokenStats | ResearchScamRestrictEvaluationInfo | Structre to hold the detailed information for restrict evaluation for a given query and dataset. | ResearchScamRestrictEvaluationInfoApplyTokenStats | |
| customRestrictStats | The evaluation results for all custom restricts. It’s up to the individual custom restrict implementation and configuration to populate this field accordingly. | ResearchScamRestrictEvaluationInfo | Structre to hold the detailed information for restrict evaluation for a given query and dataset. | ResearchScamCustomRestrictEvaluationStats |
| directLookupStats | ResearchScamRestrictEvaluationInfo | Structre to hold the detailed information for restrict evaluation for a given query and dataset. | ResearchScamRestrictEvaluationInfoDirectLookupStats | |
| bijectiveMatches | ResearchScamRestrictEvaluationInfoApplyTokenStats | The aggregated stats for token namespace restricts. | String | |
| bitmapMatches | ResearchScamRestrictEvaluationInfoApplyTokenStats | The aggregated stats for token namespace restricts. | String | |
| noMatches | ResearchScamRestrictEvaluationInfoApplyTokenStats | The aggregated stats for token namespace restricts. | String | |
| nonCompactMatches | ResearchScamRestrictEvaluationInfoApplyTokenStats | The aggregated stats for token namespace restricts. | String | |
| vectorDatapointCount | ResearchScamRestrictEvaluationInfoApplyTokenStats | The aggregated stats for token namespace restricts. | String | |
| vectorMatches | ResearchScamRestrictEvaluationInfoApplyTokenStats | The aggregated stats for token namespace restricts. | String | |
| directLookupDocidsCount | The number of docids in the direct lookup request. | ResearchScamRestrictEvaluationInfoDirectLookupStats | NOTE: add stats for numeric restrict if needed. The stats for direct lookup restricts. | String |
| directLookupMatches | The number of datapoints found for direct lookup request. | ResearchScamRestrictEvaluationInfoDirectLookupStats | NOTE: add stats for numeric restrict if needed. The stats for direct lookup restricts. | String |
| evaluationInfo | Information about the evaluation of the restricts for this query. Could be used for production (e.g., custom restrict pass certain information to the downstream). copybara:strip_end | ResearchScamRestrictStats | TODO(qhliao) move this proto to research/scam/proto/restricts.proto Structure to hold the number of active and total datapoints for a given dataset, as defined below. Last used: 3 | ResearchScamRestrictEvaluationInfo |
| numActiveDatapoints | The number of datapoints that are whitelisted by restricts specified for this query, across all shards for which the query executed successfully. In other words, this represents the number of datapoints that could potentially be returned if they were close enough to the query according to the selected distance measure. If restricts are disabled, this will be equal to num_total_datapoints. | ResearchScamRestrictStats | TODO(qhliao) move this proto to research/scam/proto/restricts.proto Structure to hold the number of active and total datapoints for a given dataset, as defined below. Last used: 3 | String |
| numTotalDatapoints | The number of total datapoints in all shards of this dataset for which the query executed successfully. This is returned for convenience so that a ratio can be easily computed, and so that num_active_datapoints can be put in perspective for partially successful queries, i.e. queries where only some shards were successful. | ResearchScamRestrictStats | TODO(qhliao) move this proto to research/scam/proto/restricts.proto Structure to hold the number of active and total datapoints for a given dataset, as defined below. Last used: 3 | String |
| postScoringExtensionNumNeighbors | The number of neighbors to return post scoring extension. | ResearchScamScoringExtensionMetadata | Parameters to adjust the scoring extension configuration for ScaM. Next ID: 2 | integer |
| bytesBlocklistTokens | If present, override |string_blacklist_tokens|. | ResearchScamTokenNamespace | list(String) | |
| bytesTokens | If present, override |string_tokens| | ResearchScamTokenNamespace | list(String) | |
| namespace | //////////////////////////////////////////////////////////////////////////// NAMESPACE – the string name of the namespace that this proto is specifying, such as “color”, “shape”, “geo”, or “tags”. Recall that your overall query is an AND across namespaces. | ResearchScamTokenNamespace | String | |
| stringBlacklistTokens | New use cases should prefer |bytes_tokens|, go/fast/11#bytes-vs-string When migrate, need to be consistent in both dataset and query. | ResearchScamTokenNamespace | list(String) | |
| stringTokens | New use cases should prefer |bytes_tokens|, go/fast/11#bytes-vs-string When migrate, need to be consistent in both dataset and query. | ResearchScamTokenNamespace | list(String) | |
| uint64BlacklistTokens | TODO(qhliao) rename to |uint64_blocklist_tokens| eventually. | ResearchScamTokenNamespace | list(String) | |
| uint64Tokens | ResearchScamTokenNamespace | list(String) | ||
| customNamespaces | This field allows custom restrict extension. – It is up to the extension to decide whether OK to specify the same custom namespace more than once per instance of the V3Restrict proto. – Unrecorgniazed (in |V3RestrictsConfig.custom_restrict_namespace_configs|) and unregistered (in factory function registry) custom namespace name will fail dataset loading (instead of being ignored silently). See go/scam-restrict-plugin for more details. | ResearchScamV3Restrict | //////////////////////////////////////////////////////////////////////////// Note that: * Your overall query is an AND across namespaces across types. * Namespaces names are independent across different restrict types (token, numeric and custom). | list(ResearchScamCustomRestrictNamespace) |
| namespaces | A repeating field, where each entry specifies the set of tokens, within a single namespace, that apply to the query, or database point, on which this V3Restrict proto is defined. * Explicitly specifying a namespace with 0 tokens is identical to omitting that namespace. ie, “{ns:}” == “”. * It is an error to specify the same namespace more than once per instance of the V3Restrict proto. | ResearchScamV3Restrict | //////////////////////////////////////////////////////////////////////////// Note that: * Your overall query is an AND across namespaces across types. * Namespaces names are independent across different restrict types (token, numeric and custom). | list(ResearchScamTokenNamespace) |
| numericNamespaces | This field allows restricts to be based on numeric comparisons rather than categorical tokens. HINT: To allow a range of values in a namespace (e.g. 42 <= x < 128), specify the same namespace twice in the query, e.g.: {namespace: "x" op: LESS value_int: 128 } {namespace: "x" op: GREATER_EQUAL value_int: 42 } | ResearchScamV3Restrict | //////////////////////////////////////////////////////////////////////////// Note that: * Your overall query is an AND across namespaces across types. * Namespaces names are independent across different restrict types (token, numeric and custom). | list(ResearchScamNumericRestrictNamespace) |
| description | catalog description | ResearchScienceSearchCatalog | Information on the catalog that this dataset comes from. Next ID: 5 | String |
| mid | catalog mid | ResearchScienceSearchCatalog | Information on the catalog that this dataset comes from. Next ID: 5 | String |
| name | catalog name | ResearchScienceSearchCatalog | Information on the catalog that this dataset comes from. Next ID: 5 | String |
| url | catalog url | ResearchScienceSearchCatalog | Information on the catalog that this dataset comes from. Next ID: 5 | String |
| citation | ResearchScienceSearchCitation | Reference to the citation in Google scholar. | String | |
| safeHtmlCitation | The citation after HTML sanitation. Used only by the front-end. | ResearchScienceSearchCitation | Reference to the citation in Google scholar. | WebutilHtmlTypesSafeHtmlProto |
| contentSize | Size of the download, as a string from the provider. May include units. | ResearchScienceSearchDataDownload | The dataset in downloadable form. There can be multiple data download entries for different file types. Next ID: 6 | String |
| downloadUrl | URL for downloading the data | ResearchScienceSearchDataDownload | The dataset in downloadable form. There can be multiple data download entries for different file types. Next ID: 6 | String |
| fileFormat | File format at the link (ASCII, CSV, etc.) | ResearchScienceSearchDataDownload | The dataset in downloadable form. There can be multiple data download entries for different file types. Next ID: 6 | String |
| fileFormatClass | Pragmatic classification of file formats – for filtering purposes | ResearchScienceSearchDataDownload | The dataset in downloadable form. There can be multiple data download entries for different file types. Next ID: 6 | String |
| parsedContentSize | Parsed content size | ResearchScienceSearchDataDownload | The dataset in downloadable form. There can be multiple data download entries for different file types. Next ID: 6 | ResearchScienceSearchDataSize |
| size | Data size value, in the provided size unit | ResearchScienceSearchDataSize | Data size information, consists of a numeric value and a unit. Next ID: 3 | float |
| unit | The data size unit | ResearchScienceSearchDataSize | Data size information, consists of a numeric value and a unit. Next ID: 3 | String |
| formatted | ResearchScienceSearchDate | Representation of fields that contain dates. The formattes version, if present, contains ISO 8601 formatted date or range. Otherwise, it is an unformatted string. Next ID: 3 | String | |
| unformatted | ResearchScienceSearchDate | Representation of fields that contain dates. The formattes version, if present, contains ISO 8601 formatted date or range. Otherwise, it is an unformatted string. Next ID: 3 | String | |
| classificationSource | The classification source that determines the field of study label. | ResearchScienceSearchFieldOfStudyInfo | Stores the classification info of each field of study label. | String |
| isAboveThreshold | If set to true, it means that the probability is at least the threshold value specified from the corresponding saved model config. Thresholds for different fields may be different. | ResearchScienceSearchFieldOfStudyInfo | Stores the classification info of each field of study label. | String |
| label | A label that represents the field of study. | ResearchScienceSearchFieldOfStudyInfo | Stores the classification info of each field of study label. | String |
| probability | A score between [0, 1] outputted from the classifier indicating the probability for being a YES instance. | ResearchScienceSearchFieldOfStudyInfo | Stores the classification info of each field of study label. | float |
| id | A fingerprint id generated based on the license_class, URL or text. Since the knowledge graph requires a unique string id for the license but any filed of license can be empty, a fingerprint id can serve as a compact identifier representing the non-empty sub-fields. | ResearchScienceSearchLicense | Distribution license information. Next ID: 6 | String |
| licenseClass | A value from a controlled vocabulary that uniquely identifies a license. Unless this is set to LICENSE_CLASS_UNDEFINED_NO_MATCH or LICENSE_CLASS_UNDEFINED_CONTRADICTING_MATCHES other fields in this message should be empty. | ResearchScienceSearchLicense | Distribution license information. Next ID: 6 | String |
| licenseMid | mid for the license. | ResearchScienceSearchLicense | Distribution license information. Next ID: 6 | String |
| text | The text (usually, the name) of the distribution license. | ResearchScienceSearchLicense | Distribution license information. Next ID: 6 | String |
| url | The url for the distribution license. | ResearchScienceSearchLicense | Distribution license information. Next ID: 6 | String |
| boxCoordinates | Coordinates of the corners of the polygon in the form “lat1 long1 lat2 long2” | ResearchScienceSearchLocation | Describes the spatial information about a value in spatial-coverage definition of a dataset. Next ID: 9 | String |
| circleCoordinates | Coordinates for the circle area defined by its center and radius: “lat long, radius” | ResearchScienceSearchLocation | Describes the spatial information about a value in spatial-coverage definition of a dataset. Next ID: 9 | String |
| containedInMid | mids for locations that contain loctions in . | ResearchScienceSearchLocation | Describes the spatial information about a value in spatial-coverage definition of a dataset. Next ID: 9 | list(String) |
| locationMid | mids for locations covering the dataset, contained in the . A region may contain multiple locations that are identified by mids. | ResearchScienceSearchLocation | Describes the spatial information about a value in spatial-coverage definition of a dataset. Next ID: 9 | list(String) |
| locationMidLabel | Labels (in the preferred language of the dataset) for the mids in . | ResearchScienceSearchLocation | Describes the spatial information about a value in spatial-coverage definition of a dataset. Next ID: 9 | list(String) |
| locationName | The original name for the area covered by the dataset. | ResearchScienceSearchLocation | Describes the spatial information about a value in spatial-coverage definition of a dataset. Next ID: 9 | String |
| locationSource | ResearchScienceSearchLocation | Describes the spatial information about a value in spatial-coverage definition of a dataset. Next ID: 9 | String | |
| pointCoordinates | Latitude and longitude for a single point in the form of “lat,long”. | ResearchScienceSearchLocation | Describes the spatial information about a value in spatial-coverage definition of a dataset. Next ID: 9 | String |
| unformattedCoordinates | Unformatted coordinates describing the region. | ResearchScienceSearchLocation | Describes the spatial information about a value in spatial-coverage definition of a dataset. Next ID: 9 | String |
| impCount | imp_count stores an estimate of the number of impressions for this tuple. | ResearchScienceSearchNavboostQueryInfo | The information representing one navboost query for the dataset source_url. | number |
| lccCount | lcc_count stores an estimate of the number of long clicks for this tuple. NOTE: It is similar to query_doc_count, but calculated in different manner. | ResearchScienceSearchNavboostQueryInfo | The information representing one navboost query for the dataset source_url. | number |
| query | The query string. | ResearchScienceSearchNavboostQueryInfo | The information representing one navboost query for the dataset source_url. | String |
| queryCount | The query_count stores the counts on this query. | ResearchScienceSearchNavboostQueryInfo | The information representing one navboost query for the dataset source_url. | number |
| queryDocCount | The query_doc_count stores the number of long-clicks on this pair. | ResearchScienceSearchNavboostQueryInfo | The information representing one navboost query for the dataset source_url. | number |
| organizationMid | KG mid for the organization or person. | ResearchScienceSearchOrganization | Organization, such as the source of a dataset or a funder NOTE: source_organization_mid and source_organization_mid_label should always have the same length: the mid and label correspond to each other. We don’t use a map for consistency with Location and if we switch to map, we should switch to it in both. Next ID: 6 | list(String) |
| organizationMidLabel | Label (in the preferred language of the dataset) for the mid. | ResearchScienceSearchOrganization | Organization, such as the source of a dataset or a funder NOTE: source_organization_mid and source_organization_mid_label should always have the same length: the mid and label correspond to each other. We don’t use a map for consistency with Location and if we switch to map, we should switch to it in both. Next ID: 6 | list(String) |
| organizationName | Unreconciled organization name. We store it here only if there are no organization_mid values present. | ResearchScienceSearchOrganization | Organization, such as the source of a dataset or a funder NOTE: source_organization_mid and source_organization_mid_label should always have the same length: the mid and label correspond to each other. We don’t use a map for consistency with Location and if we switch to map, we should switch to it in both. Next ID: 6 | String |
| organizationUrl | Original organization url | ResearchScienceSearchOrganization | Organization, such as the source of a dataset or a funder NOTE: source_organization_mid and source_organization_mid_label should always have the same length: the mid and label correspond to each other. We don’t use a map for consistency with Location and if we switch to map, we should switch to it in both. Next ID: 6 | String |
| originalOrganizationName | Original name before reconciliation; empty if not reconciled. | ResearchScienceSearchOrganization | Organization, such as the source of a dataset or a funder NOTE: source_organization_mid and source_organization_mid_label should always have the same length: the mid and label correspond to each other. We don’t use a map for consistency with Location and if we switch to map, we should switch to it in both. Next ID: 6 | String |
| identifierFromSource | An identifier as provided by the dataset itself. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(String) |
| name | The names of the dataset. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(String) |
| doi | The DOI for the dataset. We assume that there is only one. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | String |
| dateUpdated | Most recent of the three dates (published, created, modified) | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | ResearchScienceSearchDate |
| datePublished | The date when the dataset was published. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | ResearchScienceSearchDate |
| alternateName | Alternate names and acronyms for the dataset. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(String) |
| locationReconciledForName | Indicates if the location has been reconciled for the dataset name. This is used by LocationExtender to avoid re-annotating the dataset name. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | boolean |
| fieldOfStudy | Field of study: a general, high-level classification of the dataset. This is only populated during indexing time and it is only populated if the classification_source is KNOWLEDGE_GRAPH or it’s above inference threshold. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(ResearchScienceSearchFieldOfStudyInfo) |
| sameAs | Ids for other instances (not different versions) of this dataset. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(String) |
| license | License for the dataset. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(ResearchScienceSearchLicense) |
| versionsSimhash | A simhash value of the fields used for identifying versions of a dataset. This will be used by the VersionClusterInfoWriter. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | String |
| description | Description of the dataset. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(String) |
| coverageEndDate | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | ResearchScienceSearchDate | |
| isAccessibleForFree | Indicates if the dataset is available for free or behind a paywal http://schema.org/isAccessibleForFree | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | String |
| coverageStartDate | The start and end date that the dataset covers. If the dataset covers a single timepoint, then start and end dates are the same. Use the ISO 8601 format for dates (e.g., 2006-05-23). | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | ResearchScienceSearchDate |
| versionEmbeddingVector | An embedding for the dataset to be used by the VersionAggregator. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(number) |
| authorList | A string representation of the authors of the dataset, collected from author and creator in raw metadata. The exact format (e.g., comma-separated, etc.) is up to the extender that populates this field. The assumption is that this string may appear in the UI “as is”. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | String |
| dateCreated | The date when the dataset was created. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | ResearchScienceSearchDate |
| topSalientTermLabel | Top salient term labels that describe the dataset document body. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(String) |
| keyword | Keywords describing the dataset. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(String) |
| hasCroissantFormat | Indicates if the dataset has croissant format (https://github.com/mlcommons/croissant). Use optional so that explicitly setting to false will ensure the value is passed along to the KG instead of being indistinguisable from being unset and thus not set in the KG. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | boolean |
| denylistStatus | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(String) | |
| datasetClassificationScore | Probability that the entity is in fact a dataset (in contrast to spam or website labelled as dataset that does not describe a dataset). | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | float |
| languageCode | The 2-letter language code for the source page for the dataset. Same as the language code in source_url_docjoin_info. Populated only when generating output for indexing. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | String |
| sourceUrlDocjoinInfo | All the information extracted from docjoin, for the source_url of this dataset, aka DatasetMetadata.source_url. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | ResearchScienceSearchSourceUrlDocjoinInfo |
| compactIdentifierFromCitation | Compact Identifier(s) extracted from the citation field. Like in the case of DOI(s) those identify the articles related to the dataset rather than the dataset itself. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(String) |
| mentionedUrls | Mentioned URLs in the description. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(String) |
| dateModified | The date when the dataset was modified. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | ResearchScienceSearchDate |
| funder | Funder of the dataset. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(ResearchScienceSearchOrganization) |
| variable | Variables that the data in the dataset captures (e.g., pressure, salinity, temperature). For now, these are just strings. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(String) |
| numberOfDatasetsAtSourceUrl | The number of datasets at the same source url as this dataset. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | integer |
| spatialCoverage | Locations that describe spatial coverage of the data. If the data covers multiple locations then each value corresponds to one such location, describing its coordinates, mid, etc. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(ResearchScienceSearchLocation) |
| sourceOrganization | Source of the dataset: unifies provider, creator, author, publisher etc. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(ResearchScienceSearchOrganization) |
| doiFromCitation | DOI(s) extracted from the citation field. In contrast to the “doi” field these DOIs identify the articles related to the dataset rather than the dataset itself. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(String) |
| indexInCluster | Index of this dataset in its cluster of replicas. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | integer |
| dataDownload | The dataset in downloadable form. There can be multiple data download entries for different file types. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(ResearchScienceSearchDataDownload) |
| scholarQuery | Query string to send to Scholar to obtain the best approximation of citations to the dataset. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | String |
| publication | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(ResearchScienceSearchCitation) | |
| catalog | Catalog that this dataset is a part of. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | ResearchScienceSearchCatalog |
| isBasedOn | A resource (most likely another dataset) from which this dataset is derived or from which it is a modification or adaption. http://schema.org/isBasedOn | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(String) |
| versionClusterInfo | Information on the version cluster that the dataset is a part of. This field is populated during the indexing time; the field is populated only if the dataset is part of a version cluster. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | ResearchScienceSearchVersionClusterInfo |
| url | urls for the dataset, including doi. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(String) |
| replica | The info of replicas of this dataset. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(ResearchScienceSearchReplica) |
| isInferred | Indicates whether the metadata was inferred using an ML model rather than from the schema.org fields. Use optional so that explicitly setting to false will ensure the value is passed along to the KG instead of being indistinguisable from being unset and thus not set in the KG. This field was originally non-optional; changing to optional is backwards compatible, but protos created prior to being optional won’t have has_is_inferred() (go/proto-proposals/proto3-presence#wire-format-semantic-changes). | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | boolean |
| metadataType | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | String | |
| scholarlyArticle | For tables and figures, contains all of the metadata for a scholarly article that was the source of this table or figure. This field is populated only if metadata_type is ‘TABLE’ or ‘FIGURE’. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | ResearchScienceSearchScholarlyArticle |
| relatedArticleUrl | The url for the article that (likely) describes this dataset. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | String |
| basicFieldsHash | A hash of the fields copied by BasicMetadataExtender and the importers. See cs/research/science_search/backend/extender/basic_metadata_extender.h for the list of fields. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | String |
| compactIdentifier | Compact Identifiers (for example “RRID:SCR_002088”) that can be resolved by Identifiers.org or N2T.net meta-resolvers. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(String) |
| imageUrl | The image urls provided by the dataset (e.g., for thumbnail images). | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(String) |
| licenseDeprecated | License for the dataset. DEPRECATED | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(String) |
| versionEmbeddingFieldsHash | A hash of the raw metadata fields used by the VersionEmbeddingExtender. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | String |
| hasTableSummaries | Indicates if the dataset has table summaries. This field is only populated during indexing time. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | boolean |
| numberOfScholarCitations | The number of articles that reference this dataset. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | integer |
| id | A unique id for the dataset. For the data from Spore, this is the spore id, such as, for example “http://accession.nodc.noaa.gov/8500223#__sid=js0” REQUIRED | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | String |
| measurementTechnique | A technique or technology used in a Dataset corresponding to the method used for measuring the corresponding variable(s) (described using variableMeasured). http://schema.org/measurementTechnique | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(String) |
| sourceUrl | Source url from which we gathered the metadata | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | String |
| fingerprint | The fingerprint of basic fields from DatasetMetadata, including: – name – description DEPRECATED | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | String |
| descriptionInHtml | Description of the dataset converted to HTML. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | list(String) |
| datasetClassificationFieldsHash | A hash of the raw metadata fields used by the QualityExtender. | ResearchScienceSearchReconciledMetadata | A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 74 | String |
| catalogName | The name of the catalog that the replica comes from. | ResearchScienceSearchReplica | Stores the information about a dataset replica. Next ID: 5 | String |
| catalogUrl | The url of the catalog that the replica comes from. | ResearchScienceSearchReplica | Stores the information about a dataset replica. Next ID: 5 | String |
| indexInCluster | The index of this replica in a cluster of replicas. | ResearchScienceSearchReplica | Stores the information about a dataset replica. Next ID: 5 | integer |
| url | Url for the replica. | ResearchScienceSearchReplica | Stores the information about a dataset replica. Next ID: 5 | String |
| citation | Proto containing all of the Scholar Metadata for this article. | ResearchScienceSearchScholarlyArticle | Data and associated metadata for a scholarly pdf article. | ScienceCitation |
| figureOrTableImage | contains the image of the figure or table cropped out of the pdf page encoded as a PNG. | ResearchScienceSearchScholarlyArticle | Data and associated metadata for a scholarly pdf article. | String |
| figureOrTableOcrText | Contains the text (as detected by OCR) contained inside the image of the figure or table. | ResearchScienceSearchScholarlyArticle | Data and associated metadata for a scholarly pdf article. | String |
| landingPageUrl | The url of the landing page for the scholarly article. | ResearchScienceSearchScholarlyArticle | Data and associated metadata for a scholarly pdf article. | String |
| pageNumber | The page number where the table and figure is located in the original pdf document. | ResearchScienceSearchScholarlyArticle | Data and associated metadata for a scholarly pdf article. | integer |
| pdfDownloadUrl | The url where the pdf file is located for the scholarly article. | ResearchScienceSearchScholarlyArticle | Data and associated metadata for a scholarly pdf article. | String |
| dataSource | ResearchScienceSearchSourceUrlDocjoinInfo | The proto containing all the information we extracted from docjoin, for the source_url of the dataset. NEXT TAG: 18 | String | |
| displayUrl | The url used to display in the google search results. | ResearchScienceSearchSourceUrlDocjoinInfo | The proto containing all the information we extracted from docjoin, for the source_url of the dataset. NEXT TAG: 18 | String |
| docid | The docid of the document. | ResearchScienceSearchSourceUrlDocjoinInfo | The proto containing all the information we extracted from docjoin, for the source_url of the dataset. NEXT TAG: 18 | String |
| indexTier | Index tiers (BASE, UNIFIED_ZEPPELIN, etc) that the document belongs to. NOTE: Each document may belong to multiple tiers. NOTE: The original data type is an enum CompositeDoc::SubIndexType. However we don’t want to depend on segindexer/compositedoc.proto because the proto is too large. Instead, we use CompositeDoc::SubIndexType_Name( subindexid) to convert into a string representation. To convert string back to CompositeDoc::SubIndexType, use CompositeDoc::SubIndexType_Parse. | ResearchScienceSearchSourceUrlDocjoinInfo | The proto containing all the information we extracted from docjoin, for the source_url of the dataset. NEXT TAG: 18 | list(String) |
| languageCode | The language of the document in the string representation of LanguageCode. Converts from Language Enum to LanguageCode through i18n/identifiers/langenclanguagecodeconverter.h Please use i18n/identifiers/languagecodeconverter.h for converting between LanguageCode and string representation. | ResearchScienceSearchSourceUrlDocjoinInfo | The proto containing all the information we extracted from docjoin, for the source_url of the dataset. NEXT TAG: 18 | String |
| latestPageUpdateDate | The syntactic date of a dataset document that reflects the publication date of the content. | ResearchScienceSearchSourceUrlDocjoinInfo | The proto containing all the information we extracted from docjoin, for the source_url of the dataset. NEXT TAG: 18 | String |
| navboostQuery | A sequence of Navboost queries for the dataset source_url. | ResearchScienceSearchSourceUrlDocjoinInfo | The proto containing all the information we extracted from docjoin, for the source_url of the dataset. NEXT TAG: 18 | list(ResearchScienceSearchNavboostQueryInfo) |
| pagerank | The page rank of the document. DEPRECATED in favour of Pagerank_NS. Do not use as it is no longer maintained in docjoins and can break at any moment. | ResearchScienceSearchSourceUrlDocjoinInfo | The proto containing all the information we extracted from docjoin, for the source_url of the dataset. NEXT TAG: 18 | integer |
| pagerankNs | The production pagerank value of the document. | ResearchScienceSearchSourceUrlDocjoinInfo | The proto containing all the information we extracted from docjoin, for the source_url of the dataset. NEXT TAG: 18 | integer |
| petacatInfo | Petacat classifications for the web document. Normally the results from calling Petacat come in a PetacatResponse, which is very flexible and extensible. This proto takes most of the flexibility away – only rephil clusters, taxonomic classifications, and binary classifications, with discretized weights. | ResearchScienceSearchSourceUrlDocjoinInfo | The proto containing all the information we extracted from docjoin, for the source_url of the dataset. NEXT TAG: 18 | FatcatCompactDocClassification |
| salientTerms | A set of salient terms extracted fromthe document. DEPRECATEAD. Moved to DatasetMetadata for performance reasons. | ResearchScienceSearchSourceUrlDocjoinInfo | The proto containing all the information we extracted from docjoin, for the source_url of the dataset. NEXT TAG: 18 | QualitySalientTermsSalientTermSet |
| scholarInfo | Science per-doc data for inclusion in websearch. | ResearchScienceSearchSourceUrlDocjoinInfo | The proto containing all the information we extracted from docjoin, for the source_url of the dataset. NEXT TAG: 18 | ScienceIndexSignal |
| sporeGraphMid | A set of entities from WebRef annotations that are in SPORE_GRAPH. | ResearchScienceSearchSourceUrlDocjoinInfo | The proto containing all the information we extracted from docjoin, for the source_url of the dataset. NEXT TAG: 18 | list(String) |
| title | The title of the document. | ResearchScienceSearchSourceUrlDocjoinInfo | The proto containing all the information we extracted from docjoin, for the source_url of the dataset. NEXT TAG: 18 | String |
| topEntity | A set of top entities from WebrefAnnotation, top is defined by topicality score, see go/topicality-score for detail. DEPRECATED. See label_to_mids_map instead. | ResearchScienceSearchSourceUrlDocjoinInfo | The proto containing all the information we extracted from docjoin, for the source_url of the dataset. NEXT TAG: 18 | list(RepositoryWebrefWebrefEntity) |
| url | The url of the document. | ResearchScienceSearchSourceUrlDocjoinInfo | The proto containing all the information we extracted from docjoin, for the source_url of the dataset. NEXT TAG: 18 | String |
| webrefEntity | A set of entities copied from WebRefEntities on cDoc. | ResearchScienceSearchSourceUrlDocjoinInfo | The proto containing all the information we extracted from docjoin, for the source_url of the dataset. NEXT TAG: 18 | list(ResearchScienceSearchSourceUrlDocjoinInfoWebrefEntityInfo) |
| deprecatedEntityType | DEPRECATED. See entity_type instead. | ResearchScienceSearchSourceUrlDocjoinInfoWebrefEntityInfo | The mid and description of a WebRefEntity. | String |
| description | The English description of the mid from the KG. | ResearchScienceSearchSourceUrlDocjoinInfoWebrefEntityInfo | The mid and description of a WebRefEntity. | String |
| entityCollectionType | ResearchScienceSearchSourceUrlDocjoinInfoWebrefEntityInfo | The mid and description of a WebRefEntity. | list(String) | |
| kgCollection | HRID of the KG collections | ResearchScienceSearchSourceUrlDocjoinInfoWebrefEntityInfo | The mid and description of a WebRefEntity. | list(String) |
| mid | The KG identifier of the WebrefEntity. | ResearchScienceSearchSourceUrlDocjoinInfoWebrefEntityInfo | The mid and description of a WebRefEntity. | String |
| indexInVersionCluster | Index of this dataset in its cluster of versions. | ResearchScienceSearchVersionClusterInfo | Stores the information about each cluster of versions. Versions are defined in go/s2-versioning. Next available tag: 4 | integer |
| numVersions | The number of versions in a Version Cluster. This is equivalent to cluster size. | ResearchScienceSearchVersionClusterInfo | Stores the information about each cluster of versions. Versions are defined in go/s2-versioning. Next available tag: 4 | integer |
| versionClusterId | A fingerprint id of the cluster of versions this dataset belongs to. This is a hash of a dataset_id in the cluster. | ResearchScienceSearchVersionClusterInfo | Stores the information about each cluster of versions. Versions are defined in go/s2-versioning. Next available tag: 4 | String |
| AccessKey | RichsnippetsDataObject | Next ID: 11 | String | |
| attribute | RichsnippetsDataObject | Next ID: 11 | list(RichsnippetsDataObjectAttribute) | |
| source | RichsnippetsDataObject | Next ID: 11 | String | |
| type | The object type. | RichsnippetsDataObject | Next ID: 11 | String |
| cdata | RichsnippetsDataObjectAttribute | Other attributes of the object. | String | |
| idata | idata holds integer data under the attribute name, and could be interpreted differently according to the attribute name. Example: stores the ImadeData.docid used to generate thumbnails. idata will not be automatically converted into xml (the default behavior), but the behavior can be overwritten if necessary. | RichsnippetsDataObjectAttribute | Other attributes of the object. | String |
| name | RichsnippetsDataObjectAttribute | Other attributes of the object. | String | |
| subobject | A data object can have other data objects nested inside it. This is needed to represent Microformats and RDFa which have nestings e.g., a review with a business with an address, or a review with a rating object. See the Webmaster Central 2009/05 blog on “Introducing Rich Snippets”. | RichsnippetsDataObjectAttribute | Other attributes of the object. | Proto2BridgeMessageSet |
| tokenize | Whether we should tokenize the value and cdata when generating restricts from this attribute. | RichsnippetsDataObjectAttribute | Other attributes of the object. | boolean |
| value | Either of cdata or value should be present. | RichsnippetsDataObjectAttribute | Other attributes of the object. | String |
| DataObject | RichsnippetsPageMap | list(RichsnippetsDataObject) | ||
| ignoreDataObject | If ignore_data_object is set to true, pagemap attachment is processed regardless of whether data object is present or not. | RichsnippetsPageMap | boolean | |
| src | RichsnippetsPageMap | String | ||
| templatetype | RichsnippetsPageMap | list(RichsnippetsPageMapTemplateType) | ||
| src | RichsnippetsPageMapTemplateType | Unused fields | String | |
| language | Audio language of video classified by Automatic Language Identification. It corresponds to the langid_result in S3LangIdSignals. | S3AudioLanguageS3AudioLanguage | S3 based Audio language information about a Watch Page. | String |
| languageConfidence | Confidence interval of the recognized language. | S3AudioLanguageS3AudioLanguage | S3 based Audio language information about a Watch Page. | String |
| speechClass | Type of detected speech. | S3AudioLanguageS3AudioLanguage | S3 based Audio language information about a Watch Page. | String |
| hatefulDerogatoryScore | SafesearchImageOffensiveAnnotation | number | ||
| imageEntitiesViolenceScore | SafesearchInternalImageSignals | A proto that stores SafeSearch internal signals that are not exported to clients. | number | |
| offensiveAnnotation | SafesearchInternalImageSignals | A proto that stores SafeSearch internal signals that are not exported to clients. | SafesearchImageOffensiveAnnotation | |
| starburstPornScore | Additional SafeSearch signals that are used to compute final scores. | SafesearchInternalImageSignals | A proto that stores SafeSearch internal signals that are not exported to clients. | number |
| starburstViolenceScore | SafesearchInternalImageSignals | A proto that stores SafeSearch internal signals that are not exported to clients. | number | |
| internalMultiLabelClassification | SafesearchVideoContentSignals | SafeSearch video content classification scores are computed based on go/golden7 video features. To access these scores see the library at: google3/quality/safesearch/video/api/video_score_info.h Next ID: 6 | SafesearchVideoContentSignalsMultiLabelClassificationInfo | |
| isAbuseWithHighConfidence | This is used by Amarna to determine whether it should notify Raffia for immediate reprocessing. This field will be generated in Amarna’s image_metadata corpus and exported to references_video_search corpus and written to ExportState.module_state.critical_metadata_checksum for determining whether Amarna should immediately notify Raffia whenever is_abuse_with_high_confidence’s value changes. | SafesearchVideoContentSignals | SafeSearch video content classification scores are computed based on go/golden7 video features. To access these scores see the library at: google3/quality/safesearch/video/api/video_score_info.h Next ID: 6 | boolean |
| scores | SafesearchVideoContentSignals | SafeSearch video content classification scores are computed based on go/golden7 video features. To access these scores see the library at: google3/quality/safesearch/video/api/video_score_info.h Next ID: 6 | map | |
| versionTag | SafesearchVideoContentSignals | SafeSearch video content classification scores are computed based on go/golden7 video features. To access these scores see the library at: google3/quality/safesearch/video/api/video_score_info.h Next ID: 6 | String | |
| videoClassifierOutput | Output of all SafeSearch video classifiers in Amarna. | SafesearchVideoContentSignals | SafeSearch video content classification scores are computed based on go/golden7 video features. To access these scores see the library at: google3/quality/safesearch/video/api/video_score_info.h Next ID: 6 | SafesearchVideoClassifierOutput |
| frameFeaturesPresent | SafesearchVideoContentSignalsMultiLabelClassificationInfo | Information about multi-label classification result (the scores and whether frame features were used). | boolean | |
| output | SafesearchVideoContentSignalsMultiLabelClassificationInfo | Information about multi-label classification result (the scores and whether frame features were used). | SafesearchVideoContentSignalsMultiLabelOutput | |
| ageIndeterminate | SafesearchVideoContentSignalsMultiLabelOutput | Output of Multi-Label video classifier. | number | |
| csam | SafesearchVideoContentSignalsMultiLabelOutput | Output of Multi-Label video classifier. | number | |
| porn | SafesearchVideoContentSignalsMultiLabelOutput | Output of Multi-Label video classifier. | number | |
| racy | SafesearchVideoContentSignalsMultiLabelOutput | Output of Multi-Label video classifier. | number | |
| violence | SafesearchVideoContentSignalsMultiLabelOutput | Output of Multi-Label video classifier. | number | |
| PatentPublicationNumber | ScienceCitation | String | ||
| ISBNVariant | ScienceCitation | list(String) | ||
| OnlineYear | ScienceCitation | integer | ||
| Number | can be 1-3 | ScienceCitation | String | |
| Anchors | All the anchor text (before, after, formal, etc) for this citation in the referring page. | ScienceCitation | list(ScienceCitationAnchor) | |
| PMID | Pubmed ID | ScienceCitation | String | |
| PatentCountry | 2-letter country code where patent was issued, see ocean/metadata/patent_record.proto::Patent_Record::country_code for EPO one patent pertains to a list of countries. | ScienceCitation | list(String) | |
| LegalCitation | The ScienceCitation is how metadata passes through the scholar system. For legal, we use the normal ScienceCitation for the metadata/citation of legal journals. For court/government documents (like opinions or statues), we wrap it in the following embedded message | ScienceCitation | LegalCitation | |
| PublicationDay | for patents, publicationD/M/Y is the date of issue, not application | ScienceCitation | integer | |
| Title | ScienceCitation | String | ||
| FileCreationYear | date of creation of the pdf/doc | ScienceCitation | integer | |
| funding | ScienceCitation | list(ScienceCitationFunding) | ||
| AuthorMetatagLeftOver | ScienceCitation | String | ||
| AbstractLanguage | ScienceCitation | String | ||
| NumBackwardLinks | for display in gws | ScienceCitation | integer | |
| FileCreationMonth | zero-indexed field | ScienceCitation | integer | |
| ParseSource | ScienceCitation | integer | ||
| PublisherAddress | address from bibtex | ScienceCitation | String | |
| AbstractSource | ScienceCitation | String | ||
| ISSN | ScienceCitation | String | ||
| VersionID | Document version identifier – fingerprint of an id computed from the url, or of bibliographic data from a publisher. Different urls for the same article from the same source have the same version id (e.g., abstract, pdf version, and html version). | ScienceCitation | String | |
| unioncatalog | ScienceCitation | list(ScienceCitationUnionCatalog) | ||
| PMCID | ScienceCitation | String | ||
| ConferenceNumber | 27 in the “27th conference on magical realism” | ScienceCitation | integer | |
| WorldViewable | Is this version of the article world viewable? | ScienceCitation | boolean | |
| OnlineDay | ScienceCitation | integer | ||
| NumGoodEmbeddedRefs | good embedded refs | ScienceCitation | integer | |
| downloadurl | ScienceCitation | list(ScienceCitationDownloadURL) | ||
| Series | ScienceCitation | String | ||
| NumSectionRefs | refs in marked section | ScienceCitation | integer | |
| NumKeyQuotes | for display in gws | ScienceCitation | integer | |
| AbstractCitationSource | The source of abstract text that is chosen by science docid assigner. | ScienceCitation | integer | |
| CitationSourceUrl | url where record came from | ScienceCitation | String | |
| Editor | ScienceCitation | list(String) | ||
| Language | ScienceCitation | String | ||
| Chapter | ScienceCitation | String | ||
| alternateabstract | ScienceCitation | list(ScienceCitationAlternateAbstract) | ||
| PublicationVenue | where published – subsumes booktitle, howpublished and journal from bibtex | ScienceCitation | String | |
| NumBackwardLinksFromLegal | hack for legal rollout | ScienceCitation | integer | |
| Keywords | ScienceCitation | list(String) | ||
| CrawledDocid | If a citation is merged from a crawled version and a metadata version, keep the normal docid fp of the crawled version for clustering FP of normal docid of crawl version | ScienceCitation | String | |
| AbstractHtmlLeftOver | Leftovers from AbstractHtml. These are usually unrecognized xml/html entities or xml/html tags | ScienceCitation | String | |
| NumForwardLinks | for display in gws | ScienceCitation | integer | |
| BorrowedFields | OR of FieldType | ScienceCitation | integer | |
| FileCreationDay | ScienceCitation | integer | ||
| AbstractText | ScienceCitation | String | ||
| PatentApplicationNumber | Note that an issued patent has a PatentNumber and can also have a PatentApplicationNumber, whereas a patent application has a PatentApplicationNumber and can also have a PatentPublicationNumber. | ScienceCitation | String | |
| TitleHtml | Version of title for display. Contains unsanitized HTML/XML. | ScienceCitation | String | |
| accessurl | ScienceCitation | list(ScienceCitationAccessURL) | ||
| ClusterDiscoveryDate | Used for logging, recommendations, and sort-by-date. Contains the earliest discovery date of the cluster, adjusted for earlier publication dates. Stored in Universal time scale (100 ns ticks since 0001 AD) because Unix timestamp would lead to negative dates for pre-1970 docs. | ScienceCitation | String | |
| PublicationMonth | month from bibtex PublicationMonth is a zero-indexed field (0 is January). | ScienceCitation | integer | |
| CitationSrc | DEPRECATED: use CitationSource | ScienceCitation | String | |
| TranslatedAuthorListHasEtAl | etal marker for the translated author list – just in case | ScienceCitation | boolean | |
| alternatetitle | ScienceCitation | list(ScienceCitationAlternateTitle) | ||
| subject | ScienceCitation | list(ScienceCitationSubject) | ||
| JOI | ScienceCitation | String | ||
| OtherID | eg ERIC doc number or TR number | ScienceCitation | String | |
| CitationSource | citation src: dblp/crossref/paper etc | ScienceCitation | integer | |
| WOSID | Web of Science ID | ScienceCitation | String | |
| NumBackwardLinksInWoS | numcited in WoS | ScienceCitation | integer | |
| NumRelated | for display in gws | ScienceCitation | integer | |
| PublicationVenueVariant | ScienceCitation | list(String) | ||
| BaseLocalID | Set when building an incremental index. Whereas BaseGlobalID is the ID of the corresponding base cluster, the local ID is the ID of an individual citation within that base cluster that corresponds to this reparse. | ScienceCitation | String | |
| CitationSourceCrawlTimestamp | Seconds since the epoch, should be consistent with CitationSourceUrl. | ScienceCitation | String | |
| PublisherId | ScienceCitation | String | ||
| SICI | ScienceCitation | String | ||
| ArxivSection | e.g. hep-ph | ScienceCitation | String | |
| author | ScienceCitation | list(ScienceCitationAuthor) | ||
| OnlineMonth | OnlineMonth is a zero-indexed field (0 is January). | ScienceCitation | integer | |
| PublisherOrg | subsumes organization, school and institution from bibtex | ScienceCitation | String | |
| AbstractHtml | Version of abstract field for display. Contains unsanitized XML/HTML. | ScienceCitation | String | |
| PatentClassification | patent classification e.g., “B24B 3100” | ScienceCitation | list(String) | |
| Type | ArticleType | ScienceCitation | integer | |
| DEPRECATEDPublisherDisplayName | these fields moved to DownloadURL where they belong | ScienceCitation | String | |
| PatentNumber | number according to USPTO/EPO/JPO scheme. | ScienceCitation | String | |
| PubvenueID | local journal number | ScienceCitation | String | |
| AbstractDisplay | ScienceCitation | String | ||
| NumHostedPages | If set, then we host this many pages of this citation’s content. Note that this field may be set to 0, in which case we should be hosting this content but have failed. DEPRECATED, moved to DownloadURL | ScienceCitation | integer | |
| Volume | ScienceCitation | integer | ||
| Edition | ScienceCitation | String | ||
| NumRelated2 | for experiments | ScienceCitation | integer | |
| ISBN | ScienceCitation | String | ||
| DocumentID | Local document identifier – url fingerprint if we know the url, or fingerprint of all fields if we don’t. Different urls have different local docids. | ScienceCitation | String | |
| AlternateVersionID | Fingerprint of the URL after applying crawl and aggregate rewrites. Different citations with the same AlternateVersionID must have the same VersionID, but not necessarily vice versa. Omitted when identical to the VersionID. | ScienceCitation | String | |
| category | ScienceCitation | list(ScienceCitationCategory) | ||
| PatentOffice | one of the above | ScienceCitation | integer | |
| ReviewTypeReason | bitmap of ReviewArticleTypeReasons | ScienceCitation | integer | |
| DspaceID | Dspace uses handle.net handles | ScienceCitation | String | |
| AbstractTypeFromSource | The original (unnormalized) type of an abstract. AbstractDisplay holds a normalized type deduced from things like tagnames, tag-attributes, keywords in documents or the placement of the abstract in the document. This field is meant for the type of the abstract identified explicitly by the source document. E.g., the value of the ‘abstract-type’ attribute from a tag in XML (‘primary abstract’, ‘summary’, ‘highlights’ etc.). | ScienceCitation | String | |
| UnmatchedInstitution | Author affiliations found in the document that we weren’t able to match up to specific authors. | ScienceCitation | list(String) | |
| NumVersions | for display in gws | ScienceCitation | integer | |
| PublicationYear | year from bibtext full year | ScienceCitation | integer | |
| DOI | Digital Object Identifier | ScienceCitation | String | |
| referencediscussion | ScienceCitation | list(ScienceCitationReferenceDiscussion) | ||
| TitleHtmlLeftOver | Leftovers from TitleHtml. These are usually unrecognized xml/html entities or xml/html tags | ScienceCitation | String | |
| translatedauthor | ScienceCitation | list(ScienceCitationTranslatedAuthor) | ||
| BorrowedAuthors | one bit per author | ScienceCitation | integer | |
| ISSNVariant | ScienceCitation | list(String) | ||
| IncrementalExpected | Is this article expected to have been indexed in the incremental? | ScienceCitation | boolean | |
| DblpId | ScienceCitation | String | ||
| BaseGlobalID | Global document identifier – only available when building increments over a known base index. This id is from the base index. | ScienceCitation | String | |
| ConferenceId | Identifier for conference series – issn-lite | ScienceCitation | String | |
| LCCN | library of congress call number | ScienceCitation | String | |
| DEPRECATEDMetadataSourceFile | ScienceCitation | String | ||
| ClearedReason | ScienceCitation | String | ||
| LevelOfDiscussion | If this is a target reference, the level of discussion of this reference. | ScienceCitation | integer | |
| AuthorListHasEtAl | whether this citation had an “et al” in the author list | ScienceCitation | boolean | |
| NumRelated3 | for experiments | ScienceCitation | integer | |
| Note | random string data – unparsed | ScienceCitation | String | |
| UnmatchedEmailAddr | Email addresses found in the document that we weren’t able to match | ScienceCitation | list(String) | |
| Pages | Using string to handle all kinds of page specifications. Internal structure is not really needed. | ScienceCitation | String | |
| AccessDay | ScienceCitationAccessURL | User-defined URL and its last access data for citation manager. | integer | |
| AccessMonth | AccessMonth is a zero-indexed field (0 is January). | ScienceCitationAccessURL | User-defined URL and its last access data for citation manager. | integer |
| AccessYear | ScienceCitationAccessURL | User-defined URL and its last access data for citation manager. | integer | |
| UrlStr | ScienceCitationAccessURL | User-defined URL and its last access data for citation manager. | String | |
| AbstractDisplay | ScienceCitationAlternateAbstract | There are templated functions that fill the abstract fields designed to take either ScienceCitation or ScienceCitation::AlternateAbstract, so these field names must match those used for the primary abstract. | String | |
| AbstractHtml | Version of abstract field for display. This may contain XML/HTML tags. | ScienceCitationAlternateAbstract | There are templated functions that fill the abstract fields designed to take either ScienceCitation or ScienceCitation::AlternateAbstract, so these field names must match those used for the primary abstract. | String |
| AbstractHtmlLeftOver | Leftovers from AbstractHtml. These are usually unrecognized xml/html entities or xml/html tags | ScienceCitationAlternateAbstract | There are templated functions that fill the abstract fields designed to take either ScienceCitation or ScienceCitation::AlternateAbstract, so these field names must match those used for the primary abstract. | String |
| AbstractLanguage | ScienceCitationAlternateAbstract | There are templated functions that fill the abstract fields designed to take either ScienceCitation or ScienceCitation::AlternateAbstract, so these field names must match those used for the primary abstract. | String | |
| AbstractText | ScienceCitationAlternateAbstract | There are templated functions that fill the abstract fields designed to take either ScienceCitation or ScienceCitation::AlternateAbstract, so these field names must match those used for the primary abstract. | String | |
| AbstractTypeFromSource | The original (unnormalized) type of an abstract. AbstractDisplay holds a normalized type deduced from things like tagnames, tag-attributes, keywords in documents or the placement of the abstract in the document. This field is meant for the type of the abstract identified explicitly by the source document. E.g., the value of the ‘abstract-type’ attribute from a tag in XML (‘primary abstract’, ‘summary’, ‘highlights’ etc.). | ScienceCitationAlternateAbstract | There are templated functions that fill the abstract fields designed to take either ScienceCitation or ScienceCitation::AlternateAbstract, so these field names must match those used for the primary abstract. | String |
| Language | ScienceCitationAlternateTitle | alternate titles (including language where available) | String | |
| Title | ScienceCitationAlternateTitle | alternate titles (including language where available) | String | |
| TitleHtml | Version of title for display. Contains unsanitized HTML/XML. | ScienceCitationAlternateTitle | alternate titles (including language where available) | String |
| TitleHtmlLeftOver | Leftovers from TitleHtml. These are usually unrecognized xml/html entities or xml/html tags | ScienceCitationAlternateTitle | alternate titles (including language where available) | String |
| DEPRECATEDSrcFP | Fingerprint of the referral document. The fingerprint should resist to small variance in the document content. DO NOT USE IT! | ScienceCitationAnchor | The anchor class holds content relevant to a citation, for example, the text before or after the citation that explains what the citation is about. | String |
| count | Number of times this anchor text appears, only consider the text itself | ScienceCitationAnchor | The anchor class holds content relevant to a citation, for example, the text before or after the citation that explains what the citation is about. | integer |
| face | font face bitmask: kBold, kItalic, etc. | ScienceCitationAnchor | The anchor class holds content relevant to a citation, for example, the text before or after the citation that explains what the citation is about. | integer |
| size | font size, in px | ScienceCitationAnchor | The anchor class holds content relevant to a citation, for example, the text before or after the citation that explains what the citation is about. | integer |
| text | Space-delimited anchor words. Text that needs segmentation (like CJK or Thai) is unsegmented. Generated by ScienceParseUtils::AppendTokenSeqToString() | ScienceCitationAnchor | The anchor class holds content relevant to a citation, for example, the text before or after the citation that explains what the citation is about. | String |
| type | one of the “Type” value defined below. | ScienceCitationAnchor | The anchor class holds content relevant to a citation, for example, the text before or after the citation that explains what the citation is about. | integer |
| weight | weight of the anchor by looking where we get this anchor text. It can be PR, court level, year, or the combination of differerent aspects. weights are 1 – 128 defined as “Weights” | ScienceCitationAnchor | The anchor class holds content relevant to a citation, for example, the text before or after the citation that explains what the citation is about. | integer |
| Comment | ScienceCitationAuthor | author names should be in the order specified in the paper | String | |
| Department | not in bibtex – from paper | ScienceCitationAuthor | author names should be in the order specified in the paper | String |
| ScienceCitationAuthor | author names should be in the order specified in the paper | String | ||
| GuessOrderType | Tracks the GuessNameOrder case used to parse this author name, defaults to 0 simply means that GuessNameOrder wasn’t used. | ScienceCitationAuthor | author names should be in the order specified in the paper | integer |
| ID | Author ID. Formatted as idtype:id | ScienceCitationAuthor | author names should be in the order specified in the paper | list(String) |
| Institution | not in bibtex – from paper | ScienceCitationAuthor | author names should be in the order specified in the paper | String |
| IsCJKForeignName | ScienceCitationAuthor | author names should be in the order specified in the paper | boolean | |
| IsCorrespondingAuthor | ScienceCitationAuthor | author names should be in the order specified in the paper | boolean | |
| LastName | ScienceCitationAuthor | author names should be in the order specified in the paper | String | |
| OtherNames | ScienceCitationAuthor | author names should be in the order specified in the paper | String | |
| SourceText | ScienceCitationAuthor | author names should be in the order specified in the paper | String | |
| Type | Type is one of the contributors types. Writers are the default. | ScienceCitationAuthor | author names should be in the order specified in the paper | integer |
| Name | ScienceCitationCategory | String | ||
| Type | ontology/set of categories for the category | ScienceCitationCategory | String | |
| DownloadDay | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | integer | |
| LegalMustInclude | e.g., in law_articles.pat | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | boolean |
| DisplayPriority | display preference score | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | integer |
| PageCount | Number of pages in the pdf2html conversion output. Only set for PDFs. For a partitioned PDF, this is the page count of the entire volume. | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | integer |
| LikelyWorldViewable | Likely to be free-to-read for everyone, after accounting for library links etc. | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | boolean |
| MetadataUrl | url of publisher metadata file | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | String |
| NoIndex | metatag: don’t display this url | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | boolean |
| ReferencesInPrevIndex | were references parsed in a previous index | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | boolean |
| CanonicalUrlfp | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | String | |
| NoSnippet | metatag: don’t show snippet | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | boolean |
| BrokenLandingPage | set if we know the landing page is broken | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | boolean |
| DownloadYear | no abbrv | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | integer |
| WorldViewable | metatag: is viewable by world | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | boolean |
| UrlAfterRedirects | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | String | |
| ContentChecksum | checksum of the page | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | String |
| ExcerptDebugLabel | label for excerpt (abstract, summary, ..) | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | String |
| ContentType | makes gws display nicer 🙂 | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | integer |
| LongChunkCount | number of long paragraphs | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | integer |
| MustInclude | e.g., in science_articles.pat | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | boolean |
| FirstDiscovered | seconds since the epoch | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | String |
| IndexPriority | indexing preference score | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | integer |
| HtmlTitle | html title of the page | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | String |
| NoArchive | metatag: don’t show cached version | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | boolean |
| DownloadMonth | DownloadMonth is a zero-indexed field (0 is January). | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | integer |
| CrawlTimestamp | seconds since the epoch | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | String |
| LikelyDifferentMetricsVenue | In the context of a given venue in Scholar Metrics, whether this URL likely does not link to the current venue. | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | boolean |
| UrlStr | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | String | |
| HostedStartPage | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | integer | |
| OutLinkCount | number of external URLs (in PDF). | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | integer |
| LikelyNoCache | badurls_nocache at indexing time | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | boolean |
| LikelyLegalJournal | e.g., in legal_journals.pat | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | boolean |
| Type | ArticleType for this particular url | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | integer |
| MaybeNoIndexReparse | Incremental only: mark as NoIndexed if this is a reparse and the base version is NoIndexed. | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | boolean |
| LikelyAheadPrint | Whether this is likely the URL for an ahead print, at indexing time. | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | boolean |
| InPrevIndex | is url included in a previous index | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | boolean |
| DisplayOrg | publisher display name | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | String |
| WordCount | number of words in content/body | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | integer |
| OceanView | describes whether url is viewable in ocean | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | ScienceOceanView |
| DMCANotice | metatag: URL; result was taken down | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | String |
| LikelyNoIndex | badurls_noreturngws at indexing time | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | boolean |
| ExcerptContent | first few lines of abstract’ish excerpt | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | String |
| HostedNumPages | explicit zero means hosting failed | ScienceCitationDownloadURL | Download URL mentioned in citation; we keep up to K of them LINT.IfChange | integer |
| Agency | values are from FundingAgency enum | ScienceCitationFunding | integer | |
| AgencyName | Text name of the agency. For analysis. Plus for agencies that don’t have an enum. | ScienceCitationFunding | String | |
| DebugExtractionInfo | Funding entries for the same agency and grant number can be merged during our extraction process so we maintain a record of all the deduped ExtractionInfo messages within the remaining entry. | ScienceCitationFunding | list(ScienceCitationFundingExtractionInfo) | |
| DebugFundingTextBlock | Text block from which the funding entry was extracted. Intended to be used for offline analysis. DEPRECATED | ScienceCitationFunding | String | |
| GrantNumber | ScienceCitationFunding | String | ||
| Recipient | funding recipient | ScienceCitationFunding | String | |
| SourceText | Original text for the funding acknowledgement | ScienceCitationFunding | String | |
| UrlBasedFundingSource | Whether this funding info was added because this article was at the exclusive repository for this agency. | ScienceCitationFunding | boolean | |
| ClearedFunding | Set when we clear all extracted funding from this citation in the parser. | ScienceCitationFundingExtractionInfo | Holds information about the source of the funding entry. | String |
| DebugFundingTextBlock | Text block context from which the funding entry was extracted. Optionally filled and intended to be used for offline analysis. | ScienceCitationFundingExtractionInfo | Holds information about the source of the funding entry. | String |
| DocPart | ScienceCitationFundingExtractionInfo | Holds information about the source of the funding entry. | String | |
| ParseSection | ScienceCitationFundingExtractionInfo | Holds information about the source of the funding entry. | String | |
| Source | ScienceCitationFundingExtractionInfo | Holds information about the source of the funding entry. | String | |
| Level | ScienceCitationReferenceDiscussion | If this is a source document, the levels of discussion of the references this document cites. | integer | |
| TargetID | ScienceCitationReferenceDiscussion | If this is a source document, the levels of discussion of the references this document cites. | String | |
| Name | e.g., “eng” | ScienceCitationSubject | subject classification | String |
| Probability | [0,1] | ScienceCitationSubject | subject classification | float |
| Department | ScienceCitationTranslatedAuthor | translated author names. we usually get these for non-english papers which provide english title/author/abstract info | String | |
| ScienceCitationTranslatedAuthor | translated author names. we usually get these for non-english papers which provide english title/author/abstract info | String | ||
| GuessOrderType | ScienceCitationTranslatedAuthor | translated author names. we usually get these for non-english papers which provide english title/author/abstract info | integer | |
| Institution | ScienceCitationTranslatedAuthor | translated author names. we usually get these for non-english papers which provide english title/author/abstract info | String | |
| Language | ScienceCitationTranslatedAuthor | translated author names. we usually get these for non-english papers which provide english title/author/abstract info | String | |
| LastName | ScienceCitationTranslatedAuthor | translated author names. we usually get these for non-english papers which provide english title/author/abstract info | String | |
| OtherNames | ScienceCitationTranslatedAuthor | translated author names. we usually get these for non-english papers which provide english title/author/abstract info | String | |
| SourceText | ScienceCitationTranslatedAuthor | translated author names. we usually get these for non-english papers which provide english title/author/abstract info | String | |
| Type | ScienceCitationTranslatedAuthor | translated author names. we usually get these for non-english papers which provide english title/author/abstract info | integer | |
| CanonicalUrlfp | ScienceCitationUnionCatalog | Create UnionCatalog as a group if we want to later add book level informations. | String | |
| MetadataUrl | url of catalog metadata file | ScienceCitationUnionCatalog | Create UnionCatalog as a group if we want to later add book level informations. | String |
| NumLibraries | Information about the number of libraries the citation appears. It should be useful for ranking. | ScienceCitationUnionCatalog | Create UnionCatalog as a group if we want to later add book level informations. | integer |
| Subject | Categories classification of the citation | ScienceCitationUnionCatalog | Create UnionCatalog as a group if we want to later add book level informations. | list(String) |
| Url | UnionCatalog url to display to users | ScienceCitationUnionCatalog | Create UnionCatalog as a group if we want to later add book level informations. | String |
| HtmlTitleFp | Fingerprint of the html title of the page. This is useful for checking if we have the same version of the page as websearch. | ScienceIndexSignal | String | |
| IndexSelectionScore | Index selection score for websearch, bigger is better: (0.5,1.0] – prefer selection into the base index, (0.0,0.5] – prefer selection into the supplemental index. | ScienceIndexSignal | number | |
| NumBackwardLinks | Summary statistics. | ScienceIndexSignal | integer | |
| NumRelated | ScienceIndexSignal | integer | ||
| NumVersions | ScienceIndexSignal | integer | ||
| PublicationDay | ScienceIndexSignal | integer | ||
| PublicationMonth | ScienceIndexSignal | integer | ||
| PublicationYear | Publication date. | ScienceIndexSignal | integer | |
| RemoveLink | Remove this URL from the index – error page, broken landing page, etc. DEPRECATED, was never used or even filled correctly. | ScienceIndexSignal | boolean | |
| ScholarId | For links from websearch to scholar. | ScienceIndexSignal | String | |
| Title | Title of the article. Its only filled in when the html title of the page isn’t good. | ScienceIndexSignal | String | |
| VisiblePrefixTerms | Length of document prefix that most users are likely to see. Only filled in when we index subscription fulltext but most users see abstracts. This is a conservative guesstimate – e.g., ACM shows fulltext to university/company subscribers (including Google employees) based on user’s IP address, but we don’t know subscriber IPs, so ACM’s PDF pages would have ~500 in this field (estimated length of abstract). | ScienceIndexSignal | integer | |
| author | ScienceIndexSignal | list(ScienceIndexSignalAuthor) | ||
| LastName | ScienceIndexSignalAuthor | String | ||
| OtherNames | ScienceIndexSignalAuthor | String | ||
| countryview | ScienceOceanView | Describes the viewability of ocean content. | list(ScienceOceanViewCountryView) | |
| CountryCode | No CountryCode means default viewability. two letter code | ScienceOceanViewCountryView | String | |
| ViewType | enum in ocean::LocaleViewability::ViewType | ScienceOceanViewCountryView | integer | |
| compressedEmbeddings | SdrEmbedding | QualityRankembedMustangMustangRankEmbedInfo | ||
| values | SdrEmbedding | list(number) | ||
| version | SdrEmbedding | integer | ||
| articleness | SdrPageAnchorsDocInfo | number | ||
| pageAnchors | SdrPageAnchorsDocInfo | list(SdrPageAnchorsSitelink) | ||
| qscore | SdrPageAnchorsDocInfo | number | ||
| sitelinkWrapper | SdrPageAnchorsDocInfo | list(SdrPageAnchorsSitelinkWrapper) | ||
| textRichness | SdrPageAnchorsDocInfo | number | ||
| embedding | Needed for relevance scoring. | SdrPageAnchorsSitelink | SdrEmbedding | |
| geometryScore | aggregate score from Section Geometry. | SdrPageAnchorsSitelink | number | |
| headingAbbrvScore | Heading Abbreviation score. | SdrPageAnchorsSitelink | number | |
| hpScore | Needed for heading/passage filtering. | SdrPageAnchorsSitelink | number | |
| level | SdrPageAnchorsSitelink | integer | ||
| scrollTo | SdrPageAnchorsSitelink | SdrScrollTo | ||
| sectionHeight | Needed for Geometry Scoring and backoffs. from Section Geometry. | SdrPageAnchorsSitelink | integer | |
| text | Heading/Reformulated text is needed to display. | SdrPageAnchorsSitelink | String | |
| abbreviatedHeadingText | SdrPageAnchorsSitelinkWrapper | This wrapper is used for passing in additional information to generate embeddings in Goldmine. | String | |
| abbrvEmbedding | SdrPageAnchorsSitelinkWrapper | This wrapper is used for passing in additional information to generate embeddings in Goldmine. | SdrEmbedding | |
| headingEmbedding | SdrPageAnchorsSitelinkWrapper | This wrapper is used for passing in additional information to generate embeddings in Goldmine. | SdrEmbedding | |
| normalizedHeadingText | SdrPageAnchorsSitelinkWrapper | This wrapper is used for passing in additional information to generate embeddings in Goldmine. | String | |
| passageEmbedding | SdrPageAnchorsSitelinkWrapper | This wrapper is used for passing in additional information to generate embeddings in Goldmine. | SdrEmbedding | |
| passageText | SdrPageAnchorsSitelinkWrapper | This wrapper is used for passing in additional information to generate embeddings in Goldmine. | String | |
| onpageMatches | SdrScrollTo | Data needed to construct a go/scroll-to text fragment. The url fragment is: #:~:text=[prefix-,]text_start,text_end | SdrScrollToOnPageMatches | |
| prefix | Prefix to help with disambiguating between multiple text matches on page. Optional. | SdrScrollTo | Data needed to construct a go/scroll-to text fragment. The url fragment is: #:~:text=[prefix-,]text_start,text_end | String |
| suffix | Suffix to help with disambiguating between multiple text matches on page. Optional. | SdrScrollTo | Data needed to construct a go/scroll-to text fragment. The url fragment is: #:~:text=[prefix-,]text_start,text_end | String |
| textEnd | End of the text span to be highlighted. Optional. | SdrScrollTo | Data needed to construct a go/scroll-to text fragment. The url fragment is: #:~:text=[prefix-,]text_start,text_end | String |
| textStart | Start of the text span to be highlighted. | SdrScrollTo | Data needed to construct a go/scroll-to text fragment. The url fragment is: #:~:text=[prefix-,]text_start,text_end | String |
| text | SdrScrollToOnPageMatches | Number of matches in the page when using text alone, prefix + text, text + suffix, and prefix + text + suffix. The match is case-insensitive to align with go/scroll-to behavior. | integer | |
| textWithPrefix | SdrScrollToOnPageMatches | Number of matches in the page when using text alone, prefix + text, text + suffix, and prefix + text + suffix. The match is case-insensitive to align with go/scroll-to behavior. | integer | |
| textWithPrefixSuffix | SdrScrollToOnPageMatches | Number of matches in the page when using text alone, prefix + text, text + suffix, and prefix + text + suffix. The match is case-insensitive to align with go/scroll-to behavior. | integer | |
| textWithSuffix | SdrScrollToOnPageMatches | Number of matches in the page when using text alone, prefix + text, text + suffix, and prefix + text + suffix. The match is case-insensitive to align with go/scroll-to behavior. | integer | |
| accountProvenance | Propagated from knowledge.answers.sensitivity.Sensitivity account_provenance. Any ambiguity between the data here and dasher_user should be resolved by the conversion to pToken in http://source/search?q=symbol:CreatePTokenFromSensitivity | SearchPolicyRankableSensitivity | Encapsulates sensitivity mode, source, and other metadata, used for ranking when there are multiple sensitivies set by default sources (eg, followon, query understanding, attentional entity). | list(QualityQrewriteAccountProvenance) |
| attentionalEntity | SearchPolicyRankableSensitivity | Encapsulates sensitivity mode, source, and other metadata, used for ranking when there are multiple sensitivies set by default sources (eg, followon, query understanding, attentional entity). | SearchPolicyRankableSensitivityAttentionalEntity | |
| dasherUser | True iff the query is from a Dasher user. | SearchPolicyRankableSensitivity | Encapsulates sensitivity mode, source, and other metadata, used for ranking when there are multiple sensitivies set by default sources (eg, followon, query understanding, attentional entity). | boolean |
| followon | SearchPolicyRankableSensitivity | Encapsulates sensitivity mode, source, and other metadata, used for ranking when there are multiple sensitivies set by default sources (eg, followon, query understanding, attentional entity). | SearchPolicyRankableSensitivityFollowOn | |
| groundingProvider | SearchPolicyRankableSensitivity | Encapsulates sensitivity mode, source, and other metadata, used for ranking when there are multiple sensitivies set by default sources (eg, followon, query understanding, attentional entity). | SearchPolicyRankableSensitivityGroundingProvider | |
| prefilter | SearchPolicyRankableSensitivity | Encapsulates sensitivity mode, source, and other metadata, used for ranking when there are multiple sensitivies set by default sources (eg, followon, query understanding, attentional entity). | SearchPolicyRankableSensitivityPrefilter | |
| qu | SearchPolicyRankableSensitivity | Encapsulates sensitivity mode, source, and other metadata, used for ranking when there are multiple sensitivies set by default sources (eg, followon, query understanding, attentional entity). | SearchPolicyRankableSensitivityQueryUnderstanding | |
| sensitivityMode | Key of a sensitivity. | SearchPolicyRankableSensitivity | Encapsulates sensitivity mode, source, and other metadata, used for ranking when there are multiple sensitivies set by default sources (eg, followon, query understanding, attentional entity). | String |
| syntheticIntent | SearchPolicyRankableSensitivity | Encapsulates sensitivity mode, source, and other metadata, used for ranking when there are multiple sensitivies set by default sources (eg, followon, query understanding, attentional entity). | SearchPolicyRankableSensitivitySyntheticIntent | |
| winningFulfillment | SearchPolicyRankableSensitivity | Encapsulates sensitivity mode, source, and other metadata, used for ranking when there are multiple sensitivies set by default sources (eg, followon, query understanding, attentional entity). | SearchPolicyRankableSensitivityFulfillment | |
| aeOrigin | SearchPolicyRankableSensitivityAttentionalEntity | Attentional entities (AE) can be pulled from arguments of interpretations, entities annotated by Aqua or QRef annotators, and entities mentioned in Assistant’s response and annotated by the fulfillment logic (see https://g3doc.corp.google.com/quality/dialog_manager/attentional_entities/g3doc/overview.md#overview). Sensitivity of AEs can be marked by (1) feature developers in a Monastery frame, (2) code to infer the sensitivity from Argument provenance, and (3) entity annotators, such as Aqua annotator and QRef annotator. See go/sensitive-ae. | String | |
| blockNonV2SearchBackends | Should e2e search candidates running in parallel with QU (eg. GBot) be blocked. | SearchPolicyRankableSensitivityFollowOn | Sensitivity is marked at end of the last turn. See go/followon-sensitivity for more details. | boolean |
| ignoreQueryUnderstanding | Iff true this follow-on sensitivity will rank above the ones determined by query understanding (QU). | SearchPolicyRankableSensitivityFollowOn | Sensitivity is marked at end of the last turn. See go/followon-sensitivity for more details. | boolean |
| propagateOnly | SearchPolicyRankableSensitivityPrefilter | Deprecated, do not use. | boolean | |
| intentOnlyNoPii | QU dectects a sensitive intent with no sensitive content (eg., [Send email]). This flag is only used to trigger a sensitive feature because as a precaution all sensitive features should check current sensitivity mode before triggering; but will NOT block any backends, which means all other features can compete fairly. | SearchPolicyRankableSensitivityQueryUnderstanding | Sensitivity is produced by QU. | boolean |
| rewrittenQuery | The rewritten query this sensitivity is for. Note different query rewrites could produce different sensitivities. | SearchPolicyRankableSensitivityQueryUnderstanding | Sensitivity is produced by QU. | String |
| tokenHmacSha1Prefix | The hash of the corresponding capability token. The value is defined to be identical to the one in acl.proto’s CapTokenMetadata: 10-byte prefix of HMAC-SHA1 of the token. The HMAC key is the following fixed (non-secret) 512-bit value: 79b1c8f4 82baf523 b8a9ab4a e960f438 c45be041 11f1f222 e8a3f64d aeb05e3d c3576acc ec649194 aede422c 4e48e0d1 ff21234a a6ed6b49 a7fa592e efd7bba3 | SecurityCredentialsCapTokenHolderProto | Represents a principal which possesses a particular secret string whose cryptographic hash is specified here. CapTokens (“Capability Tokens”) are used in ACLProto. It’s expected that ACLs with CapTokenHolders will strongly enforce them by Keystore-wrapping crypto keys for the corresponding CapTokens. | String |
| chatId | Chat IDs consist of alphanumeric characters and colons. Currently required. | SecurityCredentialsChatProto | Represents the invitees or other users associated with a Babel Chat (see http://goto/babel). Corresponds to GroupType CHAT in //social/graph/storage/proto/data.proto. | String |
| memberType | The type of Chat members to consider, e.g. “all members” vs. “invitee” These are defined by legacy_relation_id values in social.graph.storage.EdgeTypeEnum.EdgeType enum options in social/graph/storage/proto/id.proto. See chat.pb (defined in production/config/cdd/socialgraph/mixer_config/prod/node_type_config) for all valid edge types associated with chat. Currently required. | SecurityCredentialsChatProto | Represents the invitees or other users associated with a Babel Chat (see http://goto/babel). Corresponds to GroupType CHAT in //social/graph/storage/proto/data.proto. | integer |
| circleId | Circle ID is unique only relative to the owner’s Gaia ID. Currently required. | SecurityCredentialsCircleProto | Represents a Google+ Circle. Currently (12/2011), a Circle is identical to the ContactGroup with matching parameters, but Circle must only be used for true Circles and not other Focus groups, and should be preferred over ContactGroup where applicable. Soon it may become more efficient to check membership in a Circle than in a ContactGroup (see http://go/superglue). Support for this principal type is currently (12/2011) incomplete — e.g., Keystore does not support it yet (see b/5703421). | String |
| ownerGaiaId | The owner of the circle. Currently required. | SecurityCredentialsCircleProto | Represents a Google+ Circle. Currently (12/2011), a Circle is identical to the ContactGroup with matching parameters, but Circle must only be used for true Circles and not other Focus groups, and should be preferred over ContactGroup where applicable. Soon it may become more efficient to check membership in a Circle than in a ContactGroup (see http://go/superglue). Support for this principal type is currently (12/2011) incomplete — e.g., Keystore does not support it yet (see b/5703421). | String |
| requiredConsistencyTimestampUsec | If present, then tests for membership in this circle must use data known to be at least as fresh as the given (FBS-assigned) timestamp. See http://go/fbs-consistent-read-after-important-write Before using this, be sure that any service checking authorization against this circle supports checking consistency timestamps. For example, as of 12/2011, Keystore only supports this for the Moonshine configuration, and in others authorization checks will fail if the timestamp is present. | SecurityCredentialsCircleProto | Represents a Google+ Circle. Currently (12/2011), a Circle is identical to the ContactGroup with matching parameters, but Circle must only be used for true Circles and not other Focus groups, and should be preferred over ContactGroup where applicable. Soon it may become more efficient to check membership in a Circle than in a ContactGroup (see http://go/superglue). Support for this principal type is currently (12/2011) incomplete — e.g., Keystore does not support it yet (see b/5703421). | String |
| id | Format: “{identity-pool}:{subject}#” Details: go/cloud-principal-identifiers | SecurityCredentialsCloudPrincipalProto | Principal associated with a Cloud Principal representing third party user. | String |
| groupId | Group ID is unique only relative to the owner’s Gaia ID. | SecurityCredentialsContactGroupProto | A group of contacts for a given user, as described in http://cs/p#google3/focus/backend/proto/backend.proto Historically (and in still-existing ACLs), this was used to represent Google+ circles as well as contact groups, but this use is now deprecated. New code should use the CIRCLE principal type to represent Google+ circles. | String |
| ownerGaiaId | SecurityCredentialsContactGroupProto | A group of contacts for a given user, as described in http://cs/p#google3/focus/backend/proto/backend.proto Historically (and in still-existing ACLs), this was used to represent Google+ circles as well as contact groups, but this use is now deprecated. New code should use the CIRCLE principal type to represent Google+ circles. | String | |
| requiredConsistencyTimestampUsec | If present, then tests for membership in this ContactGroup must use data known to be at least as fresh as the given (FBS-assigned) timestamp. See http://go/fbs-consistent-read-after-important-write Before using this, be sure that any service checking authorization against this group supports checking consistency timestamps. For example, as of 12/2011, Keystore only supports this for the Moonshine configuration, and in others authorization checks will fail if the timestamp is present. | SecurityCredentialsContactGroupProto | A group of contacts for a given user, as described in http://cs/p#google3/focus/backend/proto/backend.proto Historically (and in still-existing ACLs), this was used to represent Google+ circles as well as contact groups, but this use is now deprecated. New code should use the CIRCLE principal type to represent Google+ circles. | String |
| SecurityCredentialsEmailOwnerProto | Represents a verified owner of the given email address. Note that a single address may have many owners, and a single user may own many addresses. (All lower-case, in display form — see com.google.gaia.client.GaiaEmail) | String | ||
| eventId | Event IDs consist of alphanumeric characters and colons. Currently required. | SecurityCredentialsEventProto | Represents the invitees or other users associated with a Google+ Event (see http://goto/events-backend-design). | String |
| memberType | The type of Event members to consider, e.g. “all members” vs. “owners” vs. “admins”. These are defined by legacy_relation_id values in social.graph.storage.EdgeTypeEnum.EdgeType enum options in social/graph/storage/proto/id.proto. See event.pb (defined in production/config/cdd/socialgraph/mixer_config/prod/node_type_config) for all valid edge types associated with event. Currently required. | SecurityCredentialsEventProto | Represents the invitees or other users associated with a Google+ Event (see http://goto/events-backend-design). | integer |
| groupId | SecurityCredentialsGaiaGroupProto | String | ||
| userId | SecurityCredentialsGaiaUserProto | A Gaia account, which may represent a user, device, service account, etc. For prod (@prod.google.com) accounts, use MdbUserProto instead. | String | |
| hostName | Lower-case, fully qualified hostname. | SecurityCredentialsHostProto | Represents a single host. Optionally, the MDB owner of the host can be specified. | String |
| hostOwner | If present, then any checks that compare this Principal to LOAS peer info must confirm the peer’s machine owner is equal to ‘host_owner’. If absent, then any peer machine owner is acceptable. | SecurityCredentialsHostProto | Represents a single host. Optionally, the MDB owner of the host can be specified. | String |
| groupName | SecurityCredentialsLdapGroupProto | String | ||
| userName | SecurityCredentialsLdapUserProto | String | ||
| groupName | SecurityCredentialsMdbGroupProto | An entity from the MDB namespace that is to be interpreted as a group. If using this for authorization, you should do an exact match of the peer role against group_name or any of the names in the Chubby expansion of the MDB group named group_name. | String | |
| gaiaId | Do not set this field. Contact credentials-eng@ if you believe you absolutely need to use it. This is the @prod.google.com Gaia ID that corresponds to the MDB user, see go/authn-merge for details. This field may always be safely ignored when performing an authorization check. | SecurityCredentialsMdbUserProto | An entity from the MDB namespace that is to be interpreted as a user. If using this for authorization, you should only do an exact match on the peer role against user_name. | String |
| userName | SecurityCredentialsMdbUserProto | An entity from the MDB namespace that is to be interpreted as a user. If using this for authorization, you should only do an exact match on the peer role against user_name. | String | |
| domain | SecurityCredentialsOAuthConsumerProto | Represents an OAuth consumer, a/k/a AuthSub target. These principals are identified by domain name (e.g., example.com). Historically, Dasher domain GAIA group IDs have been used instead, but that doesn’t work: http://go/tricky-gaia-ids | String | |
| postiniUserId | SecurityCredentialsPostiniUserProto | See http://s/?fileprint=//depot/google3/security/authentication/postini/auth_token.proto | String | |
| allAuthenticatedUsers | scope = ALL_AUTHENTICATED_USERS | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | SecurityCredentialsAllAuthenticatedUsersProto |
| capTokenHolder | scope = CAP_TOKEN_HOLDER | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | SecurityCredentialsCapTokenHolderProto |
| chat | scope = CHAT | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | SecurityCredentialsChatProto |
| circle | scope = CIRCLE | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | SecurityCredentialsCircleProto |
| cloudPrincipal | scope = CLOUD_PRINCIPAL | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | SecurityCredentialsCloudPrincipalProto |
| contactGroup | scope = CONTACT_GROUP | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | SecurityCredentialsContactGroupProto |
| emailOwner | scope = EMAIL_OWNER | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | SecurityCredentialsEmailOwnerProto |
| event | scope = EVENT | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | SecurityCredentialsEventProto |
| gaiaGroup | scope = GAIA_GROUP | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | SecurityCredentialsGaiaGroupProto |
| gaiaUser | scope = GAIA_USER | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | SecurityCredentialsGaiaUserProto |
| host | scope = HOST | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | SecurityCredentialsHostProto |
| ldapGroup | scope = LDAP_GROUP | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | SecurityCredentialsLdapGroupProto |
| ldapUser | scope = LDAP_USER | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | SecurityCredentialsLdapUserProto |
| mdbGroup | scope = MDB_GROUP | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | SecurityCredentialsMdbGroupProto |
| mdbUser | scope = MDB_USER | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | SecurityCredentialsMdbUserProto |
| oauthConsumer | scope = OAUTH_CONSUMER; | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | SecurityCredentialsOAuthConsumerProto |
| postiniUser | scope = POSTINI_USER | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | SecurityCredentialsPostiniUserProto |
| rbacRole | scope = RBAC_ROLE | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | SecurityCredentialsRbacRoleProto |
| rbacSubject | scope = RBAC_SUBJECT | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | SecurityCredentialsRbacSubjectProto |
| resourceRole | scope = RESOURCE_ROLE | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | SecurityCredentialsResourceRoleProto |
| scope | This is only optional because required enums cannot be extended. Currently required. | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | String |
| signingKeyPossessor | scope = SIGNING_KEY_POSSESSOR | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | SecurityCredentialsSigningKeyPossessorProto |
| simpleSecretHolder | scope = SIMPLE_SECRET_HOLDER | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | SecurityCredentialsSimpleSecretHolderProto |
| socialGraphNode | scope = SOCIAL_GRAPH_NODE | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | SecurityCredentialsSocialGraphNodeProto |
| square | scope = SQUARE | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | SecurityCredentialsSquareProto |
| youtubeUser | scope = YOUTUBE_USER | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | SecurityCredentialsYoutubeUserProto |
| zwiebackSession | scope = ZWIEBACK_SESSION | SecurityCredentialsPrincipalProto | A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/google/security/credentials/Principal.java google3/security/credentials/go/principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. LINT.IfChange | SecurityCredentialsZwiebackSessionProto |
| name | SecurityCredentialsRbacRoleProto | Principal associated with a given RBAC role. This principal is used by Sphinx Provisioning Service for RBAC provisionable (go/sphinx-rbacz). | String | |
| objectId | SecurityCredentialsRbacRoleProto | Principal associated with a given RBAC role. This principal is used by Sphinx Provisioning Service for RBAC provisionable (go/sphinx-rbacz). | String | |
| rbacNamespace | DEPRECATED as of 01.11.2019 | SecurityCredentialsRbacRoleProto | Principal associated with a given RBAC role. This principal is used by Sphinx Provisioning Service for RBAC provisionable (go/sphinx-rbacz). | String |
| rbacRoleName | Format: “role/z?” – “role” is the Sphinx globally unique name of the Sphinx role that provisions the RBAC role. – “/z?” suffix indicates which Zanzibar environment stores the role membership data (“/zd”: dev, “/zs”: staging, “/zp”: prod, “/zt”: local test instance). Example: “mysystem_myrole/zp” | SecurityCredentialsRbacRoleProto | Principal associated with a given RBAC role. This principal is used by Sphinx Provisioning Service for RBAC provisionable (go/sphinx-rbacz). | String |
| username | Format “username” without “@domain”, e.g., “bogdand”. | SecurityCredentialsRbacSubjectProto | Principal associated with a given RBAC subject. This principal is used by Sphinx Provisioning Service for RBAC provisionable (go/sphinx-rbacz). | String |
| applicationId | SecurityCredentialsResourceRoleProto | A type of sharing target that points to some resource’s ACL. Used to refer to the set of Principals that have the given privilege (‘role_id’) for the given resource (‘application_id’, ‘object_id’, ‘object_part’). The meaning of ‘role_id’ is interpreted only by implementations of AclRpcService and is usually dependent on ‘application_id’ All fields except object_part are required. If present, object_part must be non-empty. | String | |
| objectId | SecurityCredentialsResourceRoleProto | A type of sharing target that points to some resource’s ACL. Used to refer to the set of Principals that have the given privilege (‘role_id’) for the given resource (‘application_id’, ‘object_id’, ‘object_part’). The meaning of ‘role_id’ is interpreted only by implementations of AclRpcService and is usually dependent on ‘application_id’ All fields except object_part are required. If present, object_part must be non-empty. | String | |
| objectPart | SecurityCredentialsResourceRoleProto | A type of sharing target that points to some resource’s ACL. Used to refer to the set of Principals that have the given privilege (‘role_id’) for the given resource (‘application_id’, ‘object_id’, ‘object_part’). The meaning of ‘role_id’ is interpreted only by implementations of AclRpcService and is usually dependent on ‘application_id’ All fields except object_part are required. If present, object_part must be non-empty. | String | |
| roleId | SecurityCredentialsResourceRoleProto | A type of sharing target that points to some resource’s ACL. Used to refer to the set of Principals that have the given privilege (‘role_id’) for the given resource (‘application_id’, ‘object_id’, ‘object_part’). The meaning of ‘role_id’ is interpreted only by implementations of AclRpcService and is usually dependent on ‘application_id’ All fields except object_part are required. If present, object_part must be non-empty. | integer | |
| keymasterKeyType | This value must be from the KeyMetadata.Type enum in keymaster.proto. | SecurityCredentialsSigningKeyPossessorProto | Represents a principal who possesses a signing key corresponding to the verification key or keyset described here. | integer |
| serializedVerificationKey | The actual verification key bytes corresponding to the above type. | SecurityCredentialsSigningKeyPossessorProto | Represents a principal who possesses a signing key corresponding to the verification key or keyset described here. | String |
| serializedVerificationKeyset | The binary serialized Keymaster SerializedReader of a public keyset. The keyset must contain exactly one key. N.B.: If this field is populated, serialized_verification_key should be set to the empty string and keymaster_key_type should be set to zero. | SecurityCredentialsSigningKeyPossessorProto | Represents a principal who possesses a signing key corresponding to the verification key or keyset described here. | String |
| label | A descriptive label to help identify a relevant ACL entry or otherwise disambiguate this instance. | SecurityCredentialsSimpleSecretHolderProto | Represents a principal which possesses a particular, presumably secret, string. Useful for things like “auth keys,” used for anonymous sharing. Since representing this principal with the actual secret included reveals the secret, it’s best if the requisite condition is enforced in some other way, for example via Keystore wrapping attributes (Keystore will unwrap only if the specified secret, aka “attribute”, is presented). All that’s stored here is an identifying label. | SecurityCredentialsSimpleSecretLabelProto |
| capabilityId | ***DEPRECATED (3-Oct-2011) *** This field should be deleted when code stops using CAP_TOKEN labels. Used when type = CAP_TOKEN. When a CAP_TOKEN label appears in a SimpleSecretHolder Principal, |capability_id| must be filled in to identify one of the capabilities on the ACL. When a CAP_TOKEN label appears in a SimpleSecret Authenticator, it is NOT necessary to fill in |capability_id| — ACL Service will find the ID by searching all capabilities on the ACL for one associated with the token given by the SimpleSecret’s secret data. If |capability_id| is specified, though, then the Authenticator will only be accepted if it actually matches that particular token ID. | SecurityCredentialsSimpleSecretLabelProto | SimpleSecretProto (in authenticator.proto) and SimpleSecretHolderProto (below) share the notion of a “label”, which identifies a particular secret without (hopefully) revealing the secret. Note that a SimpleSecretLabel only disambiguates between secrets used to get access to some particular object. Two different secrets that apply to two different objects could have the same label. For example, in the common sharing model, each object has no more than one “auth key”. Therefore, the label for an auth key simply has type = AUTH_KEY with no additional information. In theory, we could add some sort of resource ID to SimpleSecretLabel to make it more explicit. However, in practice, this is never really needed. A SimpleSecret for one object is never used to authorize a request on some other object, so there is no ambiguity. Also, since SimpleSecrets must obviously be unguessable, there is no risk that a SimpleSecret intended for one object will accidentally grant access to another. | integer |
| genericLabel | Used when type = GENERIC_SECRET | SecurityCredentialsSimpleSecretLabelProto | SimpleSecretProto (in authenticator.proto) and SimpleSecretHolderProto (below) share the notion of a “label”, which identifies a particular secret without (hopefully) revealing the secret. Note that a SimpleSecretLabel only disambiguates between secrets used to get access to some particular object. Two different secrets that apply to two different objects could have the same label. For example, in the common sharing model, each object has no more than one “auth key”. Therefore, the label for an auth key simply has type = AUTH_KEY with no additional information. In theory, we could add some sort of resource ID to SimpleSecretLabel to make it more explicit. However, in practice, this is never really needed. A SimpleSecret for one object is never used to authorize a request on some other object, so there is no ambiguity. Also, since SimpleSecrets must obviously be unguessable, there is no risk that a SimpleSecret intended for one object will accidentally grant access to another. | String |
| inviteId | Used when type == INVITE. | SecurityCredentialsSimpleSecretLabelProto | SimpleSecretProto (in authenticator.proto) and SimpleSecretHolderProto (below) share the notion of a “label”, which identifies a particular secret without (hopefully) revealing the secret. Note that a SimpleSecretLabel only disambiguates between secrets used to get access to some particular object. Two different secrets that apply to two different objects could have the same label. For example, in the common sharing model, each object has no more than one “auth key”. Therefore, the label for an auth key simply has type = AUTH_KEY with no additional information. In theory, we could add some sort of resource ID to SimpleSecretLabel to make it more explicit. However, in practice, this is never really needed. A SimpleSecret for one object is never used to authorize a request on some other object, so there is no ambiguity. Also, since SimpleSecrets must obviously be unguessable, there is no risk that a SimpleSecret intended for one object will accidentally grant access to another. | String |
| type | This is optional because required enums cannot be extended. | SecurityCredentialsSimpleSecretLabelProto | SimpleSecretProto (in authenticator.proto) and SimpleSecretHolderProto (below) share the notion of a “label”, which identifies a particular secret without (hopefully) revealing the secret. Note that a SimpleSecretLabel only disambiguates between secrets used to get access to some particular object. Two different secrets that apply to two different objects could have the same label. For example, in the common sharing model, each object has no more than one “auth key”. Therefore, the label for an auth key simply has type = AUTH_KEY with no additional information. In theory, we could add some sort of resource ID to SimpleSecretLabel to make it more explicit. However, in practice, this is never really needed. A SimpleSecret for one object is never used to authorize a request on some other object, so there is no ambiguity. Also, since SimpleSecrets must obviously be unguessable, there is no risk that a SimpleSecret intended for one object will accidentally grant access to another. | String |
| sgnDomain | The fields from ccc/socialgraph/socialgraphnode.proto:SgnNode that uniquely identify a social graph node. The ‘ident’ field is not included here because its value can be changed. | SecurityCredentialsSocialGraphNodeProto | Represents a user pseudonym. Pseudonyms are linked accounts on Google and third-party services (e.g. YouTube or Twitter) and are described by a Social Graph Node. | String |
| sgnPk | SecurityCredentialsSocialGraphNodeProto | Represents a user pseudonym. Pseudonyms are linked accounts on Google and third-party services (e.g. YouTube or Twitter) and are described by a Social Graph Node. | String | |
| memberType | The type of Square members to consider, e.g. “all members” vs. “owners” vs. “admins”. These are defined by legacy_relation_id values in social.graph.storage.EdgeTypeEnum.EdgeType enum options in social/graph/storage/proto/id.proto. See square.pb (defined in production/config/cdd/socialgraph/mixer_config/prod/node_type_config) for all valid edge types associated with square. Currently required. | SecurityCredentialsSquareProto | Represents the set of members (of a given type) in a Google+ Square (see http://go/squares). A Square with default member_type is currently (1/2012) identical to the GaiaGroup with the same ID, but that is expected to change soon (see http://go/superglue). Support for this principal type is currently (1/2012) incomplete — e.g., Keystore does not support it yet (see b/5703421). | integer |
| squareId | Currently required. | SecurityCredentialsSquareProto | Represents the set of members (of a given type) in a Google+ Square (see http://go/squares). A Square with default member_type is currently (1/2012) identical to the GaiaGroup with the same ID, but that is expected to change soon (see http://go/superglue). Support for this principal type is currently (1/2012) incomplete — e.g., Keystore does not support it yet (see b/5703421). | String |
| youtubeUserId | SecurityCredentialsYoutubeUserProto | String | ||
| zwiebackSessionId | SecurityCredentialsZwiebackSessionProto | See go/zwieback. New uses of Zwieback sessions must be approved via go/zwieback-request. | String | |
| info | Used for application-specific information about the whole set of SentenceBoundaryAnnotations. Example: SAFT Team uses this to store an nlp_saft.Document proto giving any processing errors encountered. | SentenceBoundaryAnnotations | Sentence boundaries. | Proto2BridgeMessageSet |
| instance | SentenceBoundaryAnnotations | Sentence boundaries. | list(SentenceBoundaryAnnotationsInstance) | |
| begin | SentenceBoundaryAnnotationsInstance | integer | ||
| cleanText | A clean version of .text() generated by using CleanText() and stripping unnecessary whitespace. | SentenceBoundaryAnnotationsInstance | String | |
| context | Plain text context from the page within which the annotation occurred. | SentenceBoundaryAnnotationsInstance | String | |
| contextBegin | Byte offsets for the clean text context above. | SentenceBoundaryAnnotationsInstance | integer | |
| contextEnd | SentenceBoundaryAnnotationsInstance | integer | ||
| end | SentenceBoundaryAnnotationsInstance | integer | ||
| info | Used for application-specific information about this annotation. | SentenceBoundaryAnnotationsInstance | Proto2BridgeMessageSet | |
| text | Original UTF-8 document text occurring in the range [begin, end). | SentenceBoundaryAnnotationsInstance | String | |
| toIndex | Used to mark the annotations selected to be indexed. | SentenceBoundaryAnnotationsInstance | boolean | |
| polarity | Polarity represents the sentiment towards the subject. | SentimentSentiment | This proto contains the sentiment and emotions that the user is exhibiting at the time of the query. NEXT ID: 4 | String |
| userBehaviors | SentimentSentiment | This proto contains the sentiment and emotions that the user is exhibiting at the time of the query. NEXT ID: 4 | SentimentSentimentBehaviors | |
| userEmotions | The emotions that the user is feeling. | SentimentSentiment | This proto contains the sentiment and emotions that the user is exhibiting at the time of the query. NEXT ID: 4 | SentimentSentimentEmotions |
| politeness | The degree to which the user is showing politeness. | SentimentSentimentBehaviors | The set of behavior signals that the user is expressing/demonstrating that is detected by the sentiment analysis. These signals are used to help assistant determine the proper response behavior. NEXT ID = 2 | number |
| anger | SentimentSentimentEmotions | Basic emotions. NEXT ID: 7 | integer | |
| disgust | SentimentSentimentEmotions | Basic emotions. NEXT ID: 7 | integer | |
| fear | SentimentSentimentEmotions | Basic emotions. NEXT ID: 7 | integer | |
| happiness | SentimentSentimentEmotions | Basic emotions. NEXT ID: 7 | integer | |
| sadness | SentimentSentimentEmotions | Basic emotions. NEXT ID: 7 | integer | |
| surprise | SentimentSentimentEmotions | Basic emotions. NEXT ID: 7 | integer | |
| numShingles | Total number of shingles in the document. | ShingleInfoPerDocData | This message represents shingle-related information obtained from a document. | integer |
| source | A list of all sources. | ShingleInfoPerDocData | This message represents shingle-related information obtained from a document. | list(ShingleSource) |
| id | Hash-value of the URL. | ShingleSource | This message represents a source of shingles. Used by ShingleInfoPerDocData. | integer |
| numShingles | Number of shingles originating from this source. | ShingleSource | This message represents a source of shingles. Used by ShingleInfoPerDocData. | integer |
| timestamp | First-seen timestamp of the source. | ShingleSource | This message represents a source of shingles. Used by ShingleInfoPerDocData. | integer |
| inferredImageId | ShoppingWebentityShoppingAnnotationInferredImage | Images inferred from context instead of propagated from Shopping backends. The same image might be inferred via different means; then it may appear multiple times in Offer.inferred_images list with different values of inferred_image_type field. | String | |
| inferredImageSource | ShoppingWebentityShoppingAnnotationInferredImage | Images inferred from context instead of propagated from Shopping backends. The same image might be inferred via different means; then it may appear multiple times in Offer.inferred_images list with different values of inferred_image_type field. | String | |
| inferredImageType | ShoppingWebentityShoppingAnnotationInferredImage | Images inferred from context instead of propagated from Shopping backends. The same image might be inferred via different means; then it may appear multiple times in Offer.inferred_images list with different values of inferred_image_type field. | String | |
| neardupInfo | This field will only be populated if the inferred image is a neardup of an inferred image. It stores the type and source of the images it is a neardup of. | ShoppingWebentityShoppingAnnotationInferredImage | Images inferred from context instead of propagated from Shopping backends. The same image might be inferred via different means; then it may appear multiple times in Offer.inferred_images list with different values of inferred_image_type field. | list(ShoppingWebentityShoppingAnnotationInferredImageNeardupInfo) |
| inferredImageSource | ShoppingWebentityShoppingAnnotationInferredImageNeardupInfo | String | ||
| inferredImageType | ShoppingWebentityShoppingAnnotationInferredImageNeardupInfo | String | ||
| availability | ShoppingWebentityShoppingAnnotationOfferAvailabilityInfo | String | ||
| imageDocid | ShoppingWebentityShoppingAnnotationProductImage | Images from the product-level representation (i.e. GPC). These images are currently only annotated 1) when no offers are available 2) on the product level | String | |
| productImageType | ShoppingWebentityShoppingAnnotationProductImage | Images from the product-level representation (i.e. GPC). These images are currently only annotated 1) when no offers are available 2) on the product level | String | |
| count | Number of ratings/reviews aggregated to create this product rating. If there are no ratings yet, this field will be explicitly set to zero, so whether this field is set should be checked using has_count. | ShoppingWebentityShoppingAnnotationProductRating | Information about a rating provided for a product. This can represent an aggregated rating if count is set. Next Id: 7 | String |
| maxValueMillis | ShoppingWebentityShoppingAnnotationProductRating | Information about a rating provided for a product. This can represent an aggregated rating if count is set. Next Id: 7 | String | |
| minValueMillis | The lower and upper bounds of the rating values that could be submitted for the product. (Note that it is not the min/max ratings submitted for the product, it is the min/max that can hypothetically be submitted.) | ShoppingWebentityShoppingAnnotationProductRating | Information about a rating provided for a product. This can represent an aggregated rating if count is set. Next Id: 7 | String |
| source | ShoppingWebentityShoppingAnnotationProductRating | Information about a rating provided for a product. This can represent an aggregated rating if count is set. Next Id: 7 | String | |
| value | The value of this rating normalized between 0 and 5. This will not be set if count is set to 0. | ShoppingWebentityShoppingAnnotationProductRating | Information about a rating provided for a product. This can represent an aggregated rating if count is set. Next Id: 7 | float |
| valueMillis | The non-normalized aggregated value of the ratings for this product. | ShoppingWebentityShoppingAnnotationProductRating | Information about a rating provided for a product. This can represent an aggregated rating if count is set. Next Id: 7 | String |
| f1CommitTimestampMicros | ShoppingWebentityShoppingAnnotationSoriVersionId | Versioning Information used for Logging Purposes. See go/sori-logjoining. | String | |
| opaqueSoriId | ShoppingWebentityShoppingAnnotationSoriVersionId | Versioning Information used for Logging Purposes. See go/sori-logjoining. | AdsShoppingReportingOffersSerializedSoriId | |
| DEPRECATEDSourceTitle | DEPRECATED DEPRECATED DEPRECATED In case you didn’t realize, these fields are (and have been for some time) deprecated. We’ll stop pushing their data to production soon (probably Feb/09) and after a few weeks we’ll probably remove them. | Sitemap | Note: If you are going to populate any new field in this proto, you probably need to go through the go/dj-new-field and go/index-changes process. | String |
| TargetGroups | One Sitemap can contain multiple TargetGroups, but only one of them will be displayed to the user – this decision will be made at displaying time and can take into account various factors, such as the users’ language and country, currently running experiments, etc. | Sitemap | Note: If you are going to populate any new field in this proto, you probably need to go through the go/dj-new-field and go/index-changes process. | list(QualitySitemapTargetGroup) |
| deprecatedTarget | Sitemap | Note: If you are going to populate any new field in this proto, you probably need to go through the go/dj-new-field and go/index-changes process. | list(SitemapDEPRECATED_Target) | |
| pageAnchorsDocInfo | This field is populated in the Sitemap MDU subpopulator from cdoc data. This is used to store page anchors information for TopicTagsScrolltoFlow. | Sitemap | Note: If you are going to populate any new field in this proto, you probably need to go through the go/dj-new-field and go/index-changes process. | SdrPageAnchorsDocInfo |
| searchInSite | Enable site search. | Sitemap | Note: If you are going to populate any new field in this proto, you probably need to go through the go/dj-new-field and go/index-changes process. | boolean |
| sitemapType | Sitemap | Note: If you are going to populate any new field in this proto, you probably need to go through the go/dj-new-field and go/index-changes process. | String | |
| sourceOrgfp | prevents cross-domain forwarding | Sitemap | Note: If you are going to populate any new field in this proto, you probably need to go through the go/dj-new-field and go/index-changes process. | String |
| sourceUrl | Sitemap | Note: If you are going to populate any new field in this proto, you probably need to go through the go/dj-new-field and go/index-changes process. | String | |
| subresultList | This field is populated in the Sitemap MDU subpopulator from cdoc data. It’s not set in the cdoc Sitemap. | Sitemap | Note: If you are going to populate any new field in this proto, you probably need to go through the go/dj-new-field and go/index-changes process. | QualitySitemapSubresultList |
| DEPRECATEDAnchor | SitemapDEPRECATED_Target | String | ||
| DEPRECATEDRunningAnchor | SitemapDEPRECATED_Target | boolean | ||
| DEPRECATEDTitle | SitemapDEPRECATED_Target | String | ||
| displaytitle | SitemapDEPRECATED_Target | String | ||
| score | optional, exclude to save space | SitemapDEPRECATED_Target | integer | |
| url | SitemapDEPRECATED_Target | String | ||
| DEPRECATEDDesktopCanonicalDocid | If set, this page is a smartphone dup, a page serving equivalent contents as another URL (desktop canonical), but in smartphone-optimized style. This field holds the docid of the desktop canonical. | SmartphonePerDocData | This message is used for storing smartphone related information. Note: MobilePerDocData is a similar message, but it’s for lowend mobile. | String |
| DEPRECATEDMobileHomepageDocid | Mobile URL for homepages, predicted by the URL rewrite rules. See go/mobile-homepage-prediction. | SmartphonePerDocData | This message is used for storing smartphone related information. Note: MobilePerDocData is a similar message, but it’s for lowend mobile. | String |
| adsDensityInterstitialViolationStrength | Indicates if the page is violating mobile ads density interstitial policy and the violation strength. See go/interstitials-for-ads and http://ariane/268642 for details. To save indexing space, we convert the double values in [0.0, 1.0] to intergers in range [0, 1000] by using floor(value * 1000). | SmartphonePerDocData | This message is used for storing smartphone related information. Note: MobilePerDocData is a similar message, but it’s for lowend mobile. | integer |
| isErrorPage | Indicates if the page serves error to smartphone crawler. go/ramsey-sp404demotion | SmartphonePerDocData | This message is used for storing smartphone related information. Note: MobilePerDocData is a similar message, but it’s for lowend mobile. | boolean |
| isN1Redirect | Indicates if the page has mobile N-1 redirection. go/ramsey-n1demotion | SmartphonePerDocData | This message is used for storing smartphone related information. Note: MobilePerDocData is a similar message, but it’s for lowend mobile. | boolean |
| isSmartphoneOptimized | Indicates if the page is rendered in a friendly manner on smartphones. We use this field as tri-state: “unset” means the rendering result classification is not available, and “set as false” means that the page is rendered in unfriendly manner on smartphones. See also go/modena-ranking. | SmartphonePerDocData | This message is used for storing smartphone related information. Note: MobilePerDocData is a similar message, but it’s for lowend mobile. | boolean |
| isWebErrorMobileContent | Indicates if the current URL serves error page to desktop crawler and non error page to smartphone crawler. | SmartphonePerDocData | This message is used for storing smartphone related information. Note: MobilePerDocData is a similar message, but it’s for lowend mobile. | boolean |
| maximumFlashRatio | The ratio of the area of the largest Flash to the render area. | SmartphonePerDocData | This message is used for storing smartphone related information. Note: MobilePerDocData is a similar message, but it’s for lowend mobile. | float |
| violatesMobileInterstitialPolicy | Indicates if the page is violating mobile interstitial policy and should be demoted. See go/interstitials-ranking-dd for details. | SmartphonePerDocData | This message is used for storing smartphone related information. Note: MobilePerDocData is a similar message, but it’s for lowend mobile. | boolean |
| imagesearchDocid | Source imagesearch docid | SmearedWebLandingPageEntry | For legacy purposes, cdocs contain a repeated list of *Entry, whereas it’s more convenient elsewhere to contain this information within its own protocol buffer. | String |
| webDocid | Docid of web landing page | SmearedWebLandingPageEntry | For legacy purposes, cdocs contain a repeated list of *Entry, whereas it’s more convenient elsewhere to contain this information within its own protocol buffer. | String |
| height | SnapshotBox | A simple 2D box represented by an (x, y) co-ordinate, width and height. Copied from htmlrender_webkit_headless_proto.Document to avoid additional dependency. | integer | |
| width | SnapshotBox | A simple 2D box represented by an (x, y) co-ordinate, width and height. Copied from htmlrender_webkit_headless_proto.Document to avoid additional dependency. | integer | |
| x | SnapshotBox | A simple 2D box represented by an (x, y) co-ordinate, width and height. Copied from htmlrender_webkit_headless_proto.Document to avoid additional dependency. | integer | |
| y | SnapshotBox | A simple 2D box represented by an (x, y) co-ordinate, width and height. Copied from htmlrender_webkit_headless_proto.Document to avoid additional dependency. | integer | |
| boundingBox | SnapshotImageNode | SnapshotBox | ||
| isExternal | An image is considered external iff both: 1. The image appears in a link that is not in the same org as the document, or the target URL is in a different org. 2. The image src is not in the same org as the document. | SnapshotImageNode | boolean | |
| url | The absolute url of the image as present in the page. | SnapshotImageNode | String | |
| imageNode | SnapshotSnapshotDocument | list(SnapshotImageNode) | ||
| metaNoPreview | SnapshotSnapshotDocument | boolean | ||
| metaNoSnippet | These are set from tags in the web page: | SnapshotSnapshotDocument | boolean | |
| teradoc | If this is present it supercedes all the above data. | SnapshotSnapshotDocument | TeragoogleDocumentInfo | |
| textNode | SnapshotSnapshotDocument | list(SnapshotTextNode) | ||
| title | SnapshotSnapshotDocument | String | ||
| countDistinctResources | The number of distinct resources fetched to render the content. This may aid the calculation of total page load time for user experience. For example, if total_content_length is only a few dozen kilobytes, but that is from fetching 100 distinct resources, total page load time might be much higher than the total_content_length would otherwise infer. | SnapshotSnapshotMetadata | integer | |
| crawlTimestamp | The time at which the main resource of the Snapshot was fetched, in seconds since epoch. Note that the various page dependencies may have been fetched at much earlier points in time (hours, maybe days) and that this could be off from the actual rendering time. | SnapshotSnapshotMetadata | String | |
| snapshotDocument | SnapshotSnapshotMetadata | SnapshotSnapshotDocument | ||
| snapshotQualityScore | The score here corresponds to the score in Snapshot, a number between 0.0 and 1.0 (higher the better). | SnapshotSnapshotMetadata | number | |
| totalContentSize | Number of bytes fetched to render the content. For example, to render a web page, this value would include the HTML, stylesheets, images, and all other dependencies. This can be used to calculate a coarse estimate of the total page load time a user might experience. | SnapshotSnapshotMetadata | String | |
| boundingBox | SnapshotTextNode | The SnapshotDocument contains a list of TextNode’s. Each node contains a string of text of the webpage, its bounding box in the agove snapshot image, and its font size (in number of pixels in the snapshot, which could be a fraction number since the snapshot image is typically shrinked). This list of text nodes are extracted from the output from the rendering service: htmlrender_webkit_headless_proto.Document The extraction is done by TrimDocument defined in ./shared/doctrimmer.cc | SnapshotBox | |
| fontSize | SnapshotTextNode | The SnapshotDocument contains a list of TextNode’s. Each node contains a string of text of the webpage, its bounding box in the agove snapshot image, and its font size (in number of pixels in the snapshot, which could be a fraction number since the snapshot image is typically shrinked). This list of text nodes are extracted from the output from the rendering service: htmlrender_webkit_headless_proto.Document The extraction is done by TrimDocument defined in ./shared/doctrimmer.cc | number | |
| inLink | One if the current text node is within a link; otherwise zero/not present. | SnapshotTextNode | The SnapshotDocument contains a list of TextNode’s. Each node contains a string of text of the webpage, its bounding box in the agove snapshot image, and its font size (in number of pixels in the snapshot, which could be a fraction number since the snapshot image is typically shrinked). This list of text nodes are extracted from the output from the rendering service: htmlrender_webkit_headless_proto.Document The extraction is done by TrimDocument defined in ./shared/doctrimmer.cc | integer |
| maxSplit | A value in the range [0,7] (zero if not present) indicating the most “powerful” splitting tag since the last text node. See “enum Category” in mustang/snippets/taginfo.h. | SnapshotTextNode | The SnapshotDocument contains a list of TextNode’s. Each node contains a string of text of the webpage, its bounding box in the agove snapshot image, and its font size (in number of pixels in the snapshot, which could be a fraction number since the snapshot image is typically shrinked). This list of text nodes are extracted from the output from the rendering service: htmlrender_webkit_headless_proto.Document The extraction is done by TrimDocument defined in ./shared/doctrimmer.cc | integer |
| text | SnapshotTextNode | The SnapshotDocument contains a list of TextNode’s. Each node contains a string of text of the webpage, its bounding box in the agove snapshot image, and its font size (in number of pixels in the snapshot, which could be a fraction number since the snapshot image is typically shrinked). This list of text nodes are extracted from the output from the rendering service: htmlrender_webkit_headless_proto.Document The extraction is done by TrimDocument defined in ./shared/doctrimmer.cc | String | |
| candidateInfo | Candidates are ordered by their id. | SnippetExtraInfo | list(SnippetExtraInfoSnippetCandidateInfo) | |
| containUserQuotes | Indicates that the snippet candidates all contain uesr quotes. | SnippetExtraInfo | boolean | |
| containVulgarCandidates | Indicates if there are any vulgar snippet candidates. | SnippetExtraInfo | boolean | |
| disableNg3Scoring | Indicates that SR side should disable the ng3 scoring and soly rely on the SnippetBrain scoring for selecting the final candidate. E.g. this can happen when the offline snippet generation routine is triggered. | SnippetExtraInfo | boolean | |
| disableQueryFeatures | Indicates whether the query relevance features is disabled or not in Muppet scoring. | SnippetExtraInfo | boolean | |
| forceLeadingTextOrMeta | Indicates to not add any new candidates in SnippetFlow. | SnippetExtraInfo | boolean | |
| snippetBrainSelectedCandidateIndex | Snippet candidate index selected by snippet brain model. This field will get populated in SnippetFlow in superroot. go/snippets-brain | SnippetExtraInfo | integer | |
| snippetsbrainModelInfo | SnippetsBrain model information for snippets popup debug. | SnippetExtraInfo | SnippetExtraInfoSnippetsBrainModelInfo | |
| boldedRanges | Bolded ranges in the printed snippet lines. | SnippetExtraInfoSnippetCandidateInfo | Next ID: 15 | list(QualitySnippetsTruncationSnippetBoldedRange) |
| extendedSnippet | SnippetExtraInfoSnippetCandidateInfo | Next ID: 15 | SnippetExtraInfoSnippetCandidateInfoExtendedSnippet | |
| id | Candidate identifier number, unique among all snippet candidates under each document in each request. What does this number mean: – Muppet candidates: This equals to the candidate’s rank by Muppet snippets scorer. – Superroot candidates: No specific meaning, this number should be larger than that of Muppet candidates. This field is used to: – Verify whether snippet brain chooses a different snippet from Muppet (the one chosen by Muppet is always in id 0). – Print debugging information and sort candidates in debug output. | SnippetExtraInfoSnippetCandidateInfo | Next ID: 15 | integer |
| isMuppetSelectedSnippet | If this snippet is chosen by Muppet. | SnippetExtraInfoSnippetCandidateInfo | Next ID: 15 | boolean |
| isSnippetBrainBoldingTriggered | If SnippetsBrain bolding model triggered and a bolding span is generated. | SnippetExtraInfoSnippetCandidateInfo | Next ID: 15 | boolean |
| listInfo | List information for this candidate, only populated for RADISH_LIST snippets. | SnippetExtraInfoSnippetCandidateInfo | Next ID: 15 | MustangReposWwwSnippetsOrganicListSnippetResponse |
| scoringInfo | SnippetExtraInfoSnippetCandidateInfo | Next ID: 15 | SnippetExtraInfoSnippetScoringInfo | |
| sentenceStarts | Sentence starting positions in the printed snippet lines. | SnippetExtraInfoSnippetCandidateInfo | Next ID: 15 | list(QualitySnippetsTruncationSnippetBoldedRangePosition) |
| snippet | Muppet fills snippet lines in `snippet` field. | SnippetExtraInfoSnippetCandidateInfo | Next ID: 15 | list(String) |
| snippetText | `snippet_text` will be filled by snippet brain flow in SR for model scoring and debugging purpose. | SnippetExtraInfoSnippetCandidateInfo | Next ID: 15 | String |
| snippetType | SnippetExtraInfoSnippetCandidateInfo | Next ID: 15 | String | |
| numChars | SnippetExtraInfoSnippetCandidateInfoExtendedSnippet | The extended version of this snippet. | integer | |
| snippetText | SnippetExtraInfoSnippetCandidateInfoExtendedSnippet | The extended version of this snippet. | String | |
| ng3ModelName | SnippetExtraInfoSnippetsBrainModelInfo | Log model name, partition and input processor used to generate SnippetsBrain scores, if SnippetsBrain debugging is enabled. | String | |
| snippetsbrainModelName | The below fields are populated by SnippetFlow in superroot. | SnippetExtraInfoSnippetsBrainModelInfo | Log model name, partition and input processor used to generate SnippetsBrain scores, if SnippetsBrain debugging is enabled. | String |
| snippetsbrainModelPartition | SnippetExtraInfoSnippetsBrainModelInfo | Log model name, partition and input processor used to generate SnippetsBrain scores, if SnippetsBrain debugging is enabled. | String | |
| snippetsbrainTokenizerType | SnippetExtraInfoSnippetsBrainModelInfo | Log model name, partition and input processor used to generate SnippetsBrain scores, if SnippetsBrain debugging is enabled. | String | |
| brainNg3Score | SnippetExtraInfoSnippetScoringInfo | Next ID: 9 | number | |
| brainScore | The below fields are populated by SnippetFlow in superroot. Score generated from snippet brain model. go/snippets-brain | SnippetExtraInfoSnippetScoringInfo | Next ID: 9 | number |
| features | Snippets ranklab features generated by scorer V2. | SnippetExtraInfoSnippetScoringInfo | Next ID: 9 | QualityPreviewRanklabSnippet |
| finalScore | Final snippet score by chooser. | SnippetExtraInfoSnippetScoringInfo | Next ID: 9 | number |
| rankBySnippetFlow | Final rank given by SnippetFlow. | SnippetExtraInfoSnippetScoringInfo | Next ID: 9 | integer |
| piece | SnippetsLeadingtextLeadingTextAnnotation | Leading text which may consist of multiple pieces. | list(SnippetsLeadingtextLeadingTextAnnotationPiece) | |
| pieceType | SnippetsLeadingtextLeadingTextAnnotation | Leading text which may consist of multiple pieces. | String | |
| type | Type of this leading text. Should be an enum of LeadingTextInfo.LeadingTextType | SnippetsLeadingtextLeadingTextAnnotation | Leading text which may consist of multiple pieces. | integer |
| begin | A piece of leading text is text within [begin, end). For example, a document is “ABCDEF”. If we want to set leading text as ‘CD’, the value of begin is byte offset of ‘C’, the value of end is byte offset of ‘E’. end == -1 means to the end of document. | SnippetsLeadingtextLeadingTextAnnotationPiece | integer | |
| beginText | UTF8 text, for alignment when using reusableinfo. Those text are not available in docjoins. | SnippetsLeadingtextLeadingTextAnnotationPiece | String | |
| end | SnippetsLeadingtextLeadingTextAnnotationPiece | integer | ||
| endText | SnippetsLeadingtextLeadingTextAnnotationPiece | String | ||
| matchedPattern | Matched dom path string for debugging. | SnippetsLeadingtextLeadingTextAnnotationPiece | String | |
| beginPos | Leading text start position, byte offset of page content. The offset is got in ParseMaster. So it is the offset after the content is converted to UTF8. | SnippetsLeadingtextLeadingTextInfo | integer | |
| leadingtext | Note: You can also use it to save multiple leading text candidates. | SnippetsLeadingtextLeadingTextInfo | list(SnippetsLeadingtextLeadingTextAnnotation) | |
| text | UTF8 text, for alignment when using reusableinfo. The text is not available in docjoins. | SnippetsLeadingtextLeadingTextInfo | String | |
| type | Type of leading text which is optimized for this type of document. | SnippetsLeadingtextLeadingTextInfo | String | |
| embedItem | An embed represents an external entity. See go/es-embeds. | SocialCommonAttachmentAttachment | An Attachment represents a linked entity associated with a piece of social content. This may be a 1st-party or 3rd-party entity. In the Papyrus context, an Attachment is part of a Cent, and sits alongside the main content of the cent, which is represented as a sequence of Segments. Right now an Attachment is just a wrapper around an Embed, but we provide the extra layer of abstraction since, as Embeds move to separate storage in Briefcase, we may want to add additional fields that are not part of the Embed proper, but that (for example) relate to the usage of the linked content within the particular post/cent. | EmbedsEmbedClientItem |
| id | An id to uniquely identify an attachment when several attachments are in a collection. | SocialCommonAttachmentAttachment | An Attachment represents a linked entity associated with a piece of social content. This may be a 1st-party or 3rd-party entity. In the Papyrus context, an Attachment is part of a Cent, and sits alongside the main content of the cent, which is represented as a sequence of Segments. Right now an Attachment is just a wrapper around an Embed, but we provide the extra layer of abstraction since, as Embeds move to separate storage in Briefcase, we may want to add additional fields that are not part of the Embed proper, but that (for example) relate to the usage of the linked content within the particular post/cent. | String |
| bold | SocialCommonFormatting | Formatting information for a segment. | boolean | |
| highlight | This indicates that the segment should be rendered as highlighted or visually emphasized. | SocialCommonFormatting | Formatting information for a segment. | boolean |
| italics | SocialCommonFormatting | Formatting information for a segment. | boolean | |
| strikethrough | SocialCommonFormatting | Formatting information for a segment. | boolean | |
| style | If set, this indicates that the segment should be rendered with the specified style. The absence of an explicit style represents “no style”, i.e. the segment can be rendered with the default style chosen by the application. | SocialCommonFormatting | Formatting information for a segment. | String |
| underline | SocialCommonFormatting | Formatting information for a segment. | boolean | |
| searchText | SocialCommonHashtagData | Hashtag metadata, for HASHTAG segments. For a hashtag, the “text” field should contain the display text, and the search_text field should represent the topic being referenced, without the hash symbol; for example, we might have: text = “#Google” hashtag_data.search_text = “Google” Another example: text = “#pikachu” hashtag_data.search_text = “Pokemon” Both strings should be considered part of the searchable text. In go/sbe, both are indexed and searchable. | String | |
| attachment | An Attachment represents the structured entity to which we are linking. It contains an Embed (apps/tacotown/proto/embeds/embed_client.proto) with fields specific to the appropriate type of linked entity. For example, if we are linking to a photo album, the Embed may include the album ID and gaia ID of the creator. Clients that understand the Embed type within the Attachment may construct and/or decorate their link appropriately e.g. to make use of type-specific functionality or first-party integrations. The link_target and (if appropriate) display_url fields must still be set even when an Attachment is present, so that clients who do not know how to interpret the Attachment can fall back to those fields, and render the Segment as an ordinary web link. N.B. Even when an Attachment is present, the intention of a “LINK” Segment is for the Segment to be presented inline with the rest of the text of a post or comment, with a clickable link or other UI suitable for inlining (though the client may modify the UI based on Attachment data, e.g. to add appropriate hovers, icons, etc.). When an entity is intended to be rendered separately from the main body of the post/comment, a separate Attachment proto can be added outside the set of Segments. N.B. Within the Attachment, fields of EmbedClientItem have their own visibility annotations, which should be enforced separately from Segment visibility annotations. See: apps/tacotown/proto/embeds/embed_annotations.proto | SocialCommonLinkData | Link metadata, for LINK segments. Anchor text should be stored in the “text” field of the Segment, which can also serve as a fallback. | SocialCommonAttachmentAttachment |
| attachmentRenderHint | The hint to use when rendering the associated attachment. Ignored if there is no associated attachment. | SocialCommonLinkData | Link metadata, for LINK segments. Anchor text should be stored in the “text” field of the Segment, which can also serve as a fallback. | String |
| displayUrl | If we wish to show the user a different (e.g. shortened) version of the URL for display purposes, then that version should be set here. If this field isn’t set, link_target will be used for both purposes. | SocialCommonLinkData | Link metadata, for LINK segments. Anchor text should be stored in the “text” field of the Segment, which can also serve as a fallback. | String |
| linkTarget | link_target is the URL to navigate to when clicked. This could be the original URL, or a URL signed by the GWS URL signing service. | SocialCommonLinkData | Link metadata, for LINK segments. Anchor text should be stored in the “text” field of the Segment, which can also serve as a fallback. | String |
| linkType | LinkType is an optional field that provides additional information regarding link target. For example, link type can be identified as the SELF_LINK when the request was executed from the same link as the link target. | SocialCommonLinkData | Link metadata, for LINK segments. Anchor text should be stored in the “text” field of the Segment, which can also serve as a fallback. | String |
| title | Title is an optional field that provides a short string that describes the link or its destination. User interfaces often use title as a tooltip or for accessibility purposes. However, they are of course free to present this data in any form. This field is plain text. | SocialCommonLinkData | Link metadata, for LINK segments. Anchor text should be stored in the “text” field of the Segment, which can also serve as a fallback. | String |
| kgEntityConfidence | For lightweight scoring in serving time. | SocialCommonSearchLinkData | SearchLink metadata, for SEARCH_LINK segments. For a search link, the “text” field should contain the display text. This is currently not indexed. | number |
| mid | MID of the KG entity being linked. | SocialCommonSearchLinkData | SearchLink metadata, for SEARCH_LINK segments. For a search link, the “text” field should contain the display text. This is currently not indexed. | String |
| queryBroadnessScore | SocialCommonSearchLinkData | SearchLink metadata, for SEARCH_LINK segments. For a search link, the “text” field should contain the display text. This is currently not indexed. | number | |
| formatting | Formatting to be applied when rendering the Segment. For all segment types, this is the standard way of representing that the Segment should be rendered in bold, italics, etc. | SocialCommonSegment | SocialCommonFormatting | |
| hashtagData | For HASHTAG type: | SocialCommonSegment | SocialCommonHashtagData | |
| linkData | Type-specific metadata. At most one of these should be populated, and the one that is populated should correspond to the type of the Segment. For LINK type: | SocialCommonSegment | SocialCommonLinkData | |
| searchLinkData | For SEARCH_LINK type: | SocialCommonSegment | SocialCommonSearchLinkData | |
| text | Text content of the Segment. As a general rule, this field should contain the actual text that should be rendered in the UI. Thus, for a hashtag, it should be “#Foo”, and for a link, it should be the display text. Clients that do not understand a particular segment type may use this text, along with the Formatting info below, as a fallback for display. The field is not required — if all relevant information is carried in other metadata fields and there is no need for a fallback, or it is not practical for a fallback to be provided for any other reason, the field may be left blank. A standard example would be a user reference being transmitted between server layers, where a gaia-ID representation may be sufficient and there is no need for a textual fallback. In such a case, it would be valid and useful – though not required – for servers to compute and populate a fallback on the serving path. | SocialCommonSegment | String | |
| type | Type of Segment. | SocialCommonSegment | String | |
| userMentionData | For USER_MENTION type: | SocialCommonSegment | SocialCommonUserMentionData | |
| segments | SocialCommonSegments | Segments (go/social-segments) represent structured social content, e.g. the contents of a G+ stream post or chat message. A single post or message may consist of a sequence of segments, each representing a type of content, e.g. plain text, hash tag, mention, etc. Segments correspond approximately to units of content delimited by HTML tags, so that a piece of bolded text would be a distinct Segment, a link would be a distinct Segment, and so forth. A single Segment may have multiple such qualifiers; e.g. it may be a bold link; in this case, information about all such qualifiers will be encoded in the Segment proto. | list(SocialCommonSegment) | |
| SocialCommonUserMentionData | Person metadata, for USER_MENTION segments. Should always contain at least one of user_gaia_id, user_id, email or user. The exact set of populated fields may differ depending on the context and the level in the serving stack; for example, emails will be elided on the viewing path. But as a general rule, a proto having any one of the four is valid, subject to the standard constraints of the applied annotations — that is, communication between servers and clients will ignore jspb.ignore fields, and communication between servers and other servers (or between servers and storage) will ignore client_only fields. For more on the annotations, see the comments in social/common/segment_annotations.proto | String | ||
| user | If the principal is backed by a gaia id, DO NOT use this field. Use user_gaia_id/user_id fields instead. | SocialCommonUserMentionData | Person metadata, for USER_MENTION segments. Should always contain at least one of user_gaia_id, user_id, email or user. The exact set of populated fields may differ depending on the context and the level in the serving stack; for example, emails will be elided on the viewing path. But as a general rule, a proto having any one of the four is valid, subject to the standard constraints of the applied annotations — that is, communication between servers and clients will ignore jspb.ignore fields, and communication between servers and other servers (or between servers and storage) will ignore client_only fields. For more on the annotations, see the comments in social/common/segment_annotations.proto | SecurityCredentialsPrincipalProto |
| userGaiaId | An unobfuscated gaia ID: | SocialCommonUserMentionData | Person metadata, for USER_MENTION segments. Should always contain at least one of user_gaia_id, user_id, email or user. The exact set of populated fields may differ depending on the context and the level in the serving stack; for example, emails will be elided on the viewing path. But as a general rule, a proto having any one of the four is valid, subject to the standard constraints of the applied annotations — that is, communication between servers and clients will ignore jspb.ignore fields, and communication between servers and other servers (or between servers and storage) will ignore client_only fields. For more on the annotations, see the comments in social/common/segment_annotations.proto | String |
| userId | An obfuscated gaia ID: | SocialCommonUserMentionData | Person metadata, for USER_MENTION segments. Should always contain at least one of user_gaia_id, user_id, email or user. The exact set of populated fields may differ depending on the context and the level in the serving stack; for example, emails will be elided on the viewing path. But as a general rule, a proto having any one of the four is valid, subject to the standard constraints of the applied annotations — that is, communication between servers and clients will ignore jspb.ignore fields, and communication between servers and other servers (or between servers and storage) will ignore client_only fields. For more on the annotations, see the comments in social/common/segment_annotations.proto | String |
| SocialDiscoveryExternalEntityKey | An entity key with an obfuscated gaia id that can be used externally. | String | ||
| phone | SocialDiscoveryExternalEntityKey | An entity key with an obfuscated gaia id that can be used externally. | String | |
| profileId | Obfuscated GAIA id. | SocialDiscoveryExternalEntityKey | An entity key with an obfuscated gaia id that can be used externally. | String |
| data | Set of column-name and value for the given mimetype. The semantic meaning of the column values is mime-type specific. For example they may contain app_specific_endpoint_ids for WhatsApp. This is uploaded from CP2 http://go/cp2-data1 through http://go/cp2-data14. | SocialGraphApiAppContactData | Contains a mimetype supported by a third-party app together with additional ids and other data that the apps use to complete the action for the given mimetype. For example, an app_specific_endpoint_id that corresponds to a WhatsApp Profile. Full Design: go/3p-contact-upload LINT.IfChange | list(SocialGraphApiDataColumn) |
| mimetype | The mimetype of the action defined by the third-party app. | SocialGraphApiAppContactData | Contains a mimetype supported by a third-party app together with additional ids and other data that the apps use to complete the action for the given mimetype. For example, an app_specific_endpoint_id that corresponds to a WhatsApp Profile. Full Design: go/3p-contact-upload LINT.IfChange | String |
| columnName | The name of the column in CP2 for raw_contact_data. | SocialGraphApiDataColumn | LINT.IfChange | String |
| value | The value of the data inside column. | SocialGraphApiDataColumn | LINT.IfChange | String |
| id | This string will represent either the device make and model in the case of FSA2, or the device model in the case of FSA1. | SocialGraphApiProtoAndroidDeviceInfo | String | |
| birthdayDecorationVisibility | SocialGraphApiProtoBirthdayDecoration | String | ||
| mutationContext | SocialGraphApiProtoContactCreateContext | The ContactEditContext message is a wrapper around the generic ContactMutationContext data to represent when and where a contact create was performed. | SocialGraphApiProtoContactMutationContext | |
| mutationContext | The general mutation context data | SocialGraphApiProtoContactDeletionContext | The ContactDeletionContext message is a wrapper around the generic ContactMutationContext data, and will include any needed delete specific data. NOTE: Before using this message please review go/people-api-contact-deletion-context | SocialGraphApiProtoContactMutationContext |
| mutationContext | SocialGraphApiProtoContactEditContext | The ContactEditContext message is a wrapper around the generic ContactMutationContext data to represent when and where a contact edit was performed. | SocialGraphApiProtoContactMutationContext | |
| androidDeviceInfo | Android device info should always be set when using either ANDROID_FSA1 or ANDROID_FSA2 as the source of the delete. | SocialGraphApiProtoContactMutationContext | This message is the generic mutation message which will encapsulate the fields which are shared between the create, update, and delete actions, including source of change, timestamp, and metadata messages passed in from the source for any source specific data (such as phone name/model from FSA). | SocialGraphApiProtoAndroidDeviceInfo |
| hostAppInfo | Host app info should always be set when using CONTACTS_COMPANION as the source. | SocialGraphApiProtoContactMutationContext | This message is the generic mutation message which will encapsulate the fields which are shared between the create, update, and delete actions, including source of change, timestamp, and metadata messages passed in from the source for any source specific data (such as phone name/model from FSA). | SocialGraphApiProtoHostAppInfo |
| source | The source of a mutate should provide all needed information a user should know, and should be enough information for the front end to generate a proper human readable string to describe the mutate to the user. | SocialGraphApiProtoContactMutationContext | This message is the generic mutation message which will encapsulate the fields which are shared between the create, update, and delete actions, including source of change, timestamp, and metadata messages passed in from the source for any source specific data (such as phone name/model from FSA). | String |
| thirdPartyInfo | Third party info should always be set when using THIRD_PARTY as the source. | SocialGraphApiProtoContactMutationContext | This message is the generic mutation message which will encapsulate the fields which are shared between the create, update, and delete actions, including source of change, timestamp, and metadata messages passed in from the source for any source specific data (such as phone name/model from FSA). | SocialGraphApiProtoThirdPartyInfo |
| timestamp | Timestamp representing when the contact was mutated. This should not be set on write, as it is the job of focus backend to determine this timestamp. This field will be populated on read with the data written by FBS. | SocialGraphApiProtoContactMutationContext | This message is the generic mutation message which will encapsulate the fields which are shared between the create, update, and delete actions, including source of change, timestamp, and metadata messages passed in from the source for any source specific data (such as phone name/model from FSA). | DateTime |
| contactActiveState | Indicates if any reminders are active for entire contact. This will affect both connection reminders and date reminders such as birthday reminders. This is required. | SocialGraphApiProtoContactPromptSettings | String | |
| deletionContext | A trashed contact may have deletion context set, which indicates where and when the contact was trashed. Deletion context is cleared when the contact is untrashed. | SocialGraphApiProtoContactState | Contact state and related metadata. See go/fbs-contacts-trash. | SocialGraphApiProtoContactDeletionContext |
| deletionState | SocialGraphApiProtoContactState | Contact state and related metadata. See go/fbs-contacts-trash. | String | |
| overlay | Settings that describe how the decoration should be overlaid on the photo. | SocialGraphApiProtoDecorationOverlay | Settings that control how a SIBS decoration overlay is displayed. | SocialGraphApiProtoPhotoOverlay |
| sibsId | SIBS ID of the decoration that is overlaid on the photo. | SocialGraphApiProtoDecorationOverlay | Settings that control how a SIBS decoration overlay is displayed. | String |
| id | Required. The id for a delegated group. | SocialGraphApiProtoDelegatedGroupId | Represents a delegated group id, delegated groups refer to groups that are owned by another gaiaId, but this user has access to. | String |
| source | SocialGraphApiProtoDisplayNameSource | String | ||
| hostAppName | This string will represent the info for the host app to the Companion sidebar | SocialGraphApiProtoHostAppInfo | String | |
| contentVersion | Identifies the most recent version of this photo. Use this as a FIFE param (ie -iv12) to prevent reads of a stale version. | SocialGraphApiProtoImageReference | A reference to a photo in either Photos Backend or SGI storage. This message should be treated as an opaque blob to avoid a dependency on a specific storage backend. This version of ImageReference is visible outside of SGBE. Do not add fields that should not be exposed outside of Profile Service and Image Service. | String |
| mediaId | Unique identifier for the photo. For now, this will always be a Photos Backend media key. | SocialGraphApiProtoImageReference | A reference to a photo in either Photos Backend or SGI storage. This message should be treated as an opaque blob to avoid a dependency on a specific storage backend. This version of ImageReference is visible outside of SGBE. Do not add fields that should not be exposed outside of Profile Service and Image Service. | String |
| partialNameOptions | Required. Describes which shortening option the user implicitly chose for their limited profile. E.g., if ‘John Doe’ chose ‘John D.’, they implicitly chose: partial_name_options { given_name_spec { show_all: true } family_name_spec: { show_initial: true truncation_indicator: PERIOD } } While we’ll in all cases serve the actual name chosen by the user for limited profiles (stored below), we’ll use this information to recompute the default limited profile to be rendered to users when they change their core name. | SocialGraphApiProtoLimitedProfileNameSettings | SocialGraphApiProtoPartialNameOptions | |
| verbatimFullName | The actual textual name that was chosen by the user in the UI. E.g., if ‘John Doe’ chose ‘John D.’, this holds ‘John D.’. While `partial_name_options` allows the limited profile name to be computed from the core name, the resulting shortened name might change across different versions of the name shortening logic, and we want to preserve the user’s choice verbatim whenever possible. This field will be cleared when the two conditions below are met: (1) A successful core name change is not accompanied by a limited profile settings update and (2) The shortened name computed from `partial_name_options` yields a different result than what is originally stored in `verbatim_full_name`. When this happens, the limited profile is effectively *disabled*. E.g., if ‘John Doe’ from the example above changes their name to ‘Jane Doe’ and no LimitedProfileSettings are provided, `Jane D.` is the resulting shortened name. Therefore `verbatim_full_name` will be cleared and the limited profile settings will be disabled. On the other hand, if they change their name to `John Dõe`, the resulting shortened name remains `John D.`, and `verbatim_full_name` is kept as is. | SocialGraphApiProtoLimitedProfileNameSettings | String | |
| profilePictureOption | SocialGraphApiProtoLimitedProfilePictureSettings | String | ||
| androidMessages | Created with user input in Android Messages. | SocialGraphApiProtoLimitedProfileSettings | Next ID: 10 | boolean |
| disableReason | Indicates why the limited profile has been disabled. Will be set iff the limited profile is disabled. Note: When mutating limited profiles, in order to disable them, MutateDataRequest.DisableLimitedProfile must be true. Currently, disables are only performed server-side, so this is read-only for clients. | SocialGraphApiProtoLimitedProfileSettings | Next ID: 10 | String |
| gpayOobe | Created with user input in GPay OOBE. This is not currently used because GPay does not setup mini profile, this might change in the future. | SocialGraphApiProtoLimitedProfileSettings | Next ID: 10 | boolean |
| lastUpdateTime | Timestamp indicating when the settings were last stored. Read-only field. | SocialGraphApiProtoLimitedProfileSettings | Next ID: 10 | DateTime |
| legacyDiscoverability | A user who had legacy discoverability had a Limited Profile autogenerated for them, either through a healer or in the live path in FBS. | SocialGraphApiProtoLimitedProfileSettings | Next ID: 10 | String |
| myAccount | Created with user input in MyAccount UI. | SocialGraphApiProtoLimitedProfileSettings | Next ID: 10 | boolean |
| nameSettings | Required. Defines how the name should be formatted in the limited profile. | SocialGraphApiProtoLimitedProfileSettings | Next ID: 10 | SocialGraphApiProtoLimitedProfileNameSettings |
| profilePictureSettings | DEPRECATED. Profile picture choices are controlled through the ACL of the Photo field. | SocialGraphApiProtoLimitedProfileSettings | Next ID: 10 | SocialGraphApiProtoLimitedProfilePictureSettings |
| monthDay | Absolute day of the month (if positive) or relative day from the end of the month (if negative). Example: 2nd and 20th of the month [2, 20]. Example: Last day of the month [-1]. Positive values should correspond to actual calendar day number (indexing starts at 1). | SocialGraphApiProtoMonthlyDayRecurrence | Pattern for a MONTHLY recurrence. This Monthly reccurence supports: 1. Absolute days of the month (i.e. the 1st and 15th) 2. Relative day from the end of the month (i.e. -1 for last day, -2 for second-to-last day). Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) | list(integer) |
| useLastDayIfMonthDayPastEnd | If true, month_day beyond the end of month (i.e. month_day=31 in February) will default to the last day of the month. | SocialGraphApiProtoMonthlyDayRecurrence | Pattern for a MONTHLY recurrence. This Monthly reccurence supports: 1. Absolute days of the month (i.e. the 1st and 15th) 2. Relative day from the end of the month (i.e. -1 for last day, -2 for second-to-last day). Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) | boolean |
| monthlyDayRecurrence | SocialGraphApiProtoMonthlyRecurrence | A MONTHLY recurrence can be one of a MonthlyDayRecurrence or MonthlyWeekdayRecurrence but not both. Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) | SocialGraphApiProtoMonthlyDayRecurrence | |
| monthlyWeekdayRecurrence | SocialGraphApiProtoMonthlyRecurrence | A MONTHLY recurrence can be one of a MonthlyDayRecurrence or MonthlyWeekdayRecurrence but not both. Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) | SocialGraphApiProtoMonthlyWeekdayRecurrence | |
| weekDay | The nth occurrence of week_day to match. I.e. For 3rd Wednesday of the month, week_day = WEDNESDAY and week_day_number = 3. Values beyond the end of the month are skipped. | SocialGraphApiProtoMonthlyWeekdayRecurrence | Pattern for a MONTHLY recurrence. This Monthly reccurence supports: 1. The nth specific weekday of the month. For example, the 3rd Wednesday of the month. This represents the 3rd instance of a Wednesday of the month, regardless of what weekday the month started on. It does not necessarily mean the Wednesday on the 3rd week of the month. Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) | String |
| weekDayNumber | SocialGraphApiProtoMonthlyWeekdayRecurrence | Pattern for a MONTHLY recurrence. This Monthly reccurence supports: 1. The nth specific weekday of the month. For example, the 3rd Wednesday of the month. This represents the 3rd instance of a Wednesday of the month, regardless of what weekday the month started on. It does not necessarily mean the Wednesday on the 3rd week of the month. Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) | integer | |
| audioSource | Stored. Updated on pronunciation creates and updates. | SocialGraphApiProtoNamePronunciationAudioMetadata | Metadata for a user’s name pronunciation audio. Proto message is shared between merged_person and FBS. | String |
| audioState | Stored. | SocialGraphApiProtoNamePronunciationAudioMetadata | Metadata for a user’s name pronunciation audio. Proto message is shared between merged_person and FBS. | String |
| daysBeforeActiveDate | Positive number of days before active date. The value 0 will denote a notification on the same day. | SocialGraphApiProtoNotificationTrigger | Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) | integer |
| notificationTimeOfDay | Time of day that notification is sent to user. This is local to the user’s device. | SocialGraphApiProtoNotificationTrigger | Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) | GoogleTypeTimeOfDay |
| language | IETF BCP-47 language code that should be used for localizing the name computation (go/bcp-47). If not provided, we’ll use the name origin detector to infer it. If unable to detect, “en” will be assumed. | SocialGraphApiProtoPartialNameOptions | For general information about Limited Profiles, see go/limited-profiles-api. LINT.IfChange | String |
| parsedDisplayNameSpec | SocialGraphApiProtoPartialNameOptions | For general information about Limited Profiles, see go/limited-profiles-api. LINT.IfChange | SocialGraphApiProtoPartialNameOptionsParsedDisplayNameSpec | |
| twoPartNameSpec | SocialGraphApiProtoPartialNameOptions | For general information about Limited Profiles, see go/limited-profiles-api. LINT.IfChange | SocialGraphApiProtoPartialNameOptionsTwoPartNameSpec | |
| hideAll | Completely omit that part of the name. | SocialGraphApiProtoPartialNameOptionsNamePartSpec | Specifies how each piece of the name should be handled. Names are structured into given name and family name and this allows an independent specification for each of these pieces. Very limited preprocessing is done for this option (leading whitespace trimming mostly). Composed names are treated as a single unit and are not broken down. | boolean |
| showAll | Show the complete name. Note that this does not express the same semantics as show_first_n_chars=length_of_name, because when regenerating a shortened name the new name could have more characters, thus yielding a different result. | SocialGraphApiProtoPartialNameOptionsNamePartSpec | Specifies how each piece of the name should be handled. Names are structured into given name and family name and this allows an independent specification for each of these pieces. Very limited preprocessing is done for this option (leading whitespace trimming mostly). Composed names are treated as a single unit and are not broken down. | boolean |
| showFirstNChars | Show first `n` characters. Same note about characters referring to “grapheme_clusters” applies. | SocialGraphApiProtoPartialNameOptionsNamePartSpec | Specifies how each piece of the name should be handled. Names are structured into given name and family name and this allows an independent specification for each of these pieces. Very limited preprocessing is done for this option (leading whitespace trimming mostly). Composed names are treated as a single unit and are not broken down. | integer |
| showInitial | Show only the initial, i.e., a single character. Note that “character” refers to “user-perceived” characters, aka a “grapheme cluster”. See go/morphology for more details. | SocialGraphApiProtoPartialNameOptionsNamePartSpec | Specifies how each piece of the name should be handled. Names are structured into given name and family name and this allows an independent specification for each of these pieces. Very limited preprocessing is done for this option (leading whitespace trimming mostly). Composed names are treated as a single unit and are not broken down. | boolean |
| truncationIndicator | Which truncation indicator to use after the shortened piece of the name. Will be ignored for the `hide_all` or `show_all` options. | SocialGraphApiProtoPartialNameOptionsNamePartSpec | Specifies how each piece of the name should be handled. Names are structured into given name and family name and this allows an independent specification for each of these pieces. Very limited preprocessing is done for this option (leading whitespace trimming mostly). Composed names are treated as a single unit and are not broken down. | String |
| allInitialsFromParsedName | Extract an initial from each parsed name. For example, “Niels Henrik David Bohr” yields “N. H. D. B.”. Other special cases are treated as follows: | SocialGraphApiProtoPartialNameOptionsParsedDisplayNameSpec | These options use more sophisticated logic from a location-aware name detector to parse the full name of a user into structured parts and operate on those parts. For more information on how names are parsed, see the NameOccurrence proto definition: http://google3/quality/peoplesearch/namedetector/detector/proto/name_occurrence.proto?l=50&rcl=334484707 In general, when parsing display names the following rules will apply to *all* specs: – Hyphenated names are broken down: “Angelina Jollie-Pit” is pre-processed as “Angelina Jollie Pitt”; – Prefixes are ignored: “Prof. Albus Dumbledore” is pre-processed as “Albus Dumbledore”; – Auxiliaries are ignored: “Luís de Camões” is pre-processed as “Luís Camões”. Next ID: 8 | boolean |
| firstInitialAndFirstLastName | Show the initial of the very first name and the first last name, e.g. “Hugo Daniel Hernandez Garcia” yields “H. Hernandez”. | SocialGraphApiProtoPartialNameOptionsParsedDisplayNameSpec | These options use more sophisticated logic from a location-aware name detector to parse the full name of a user into structured parts and operate on those parts. For more information on how names are parsed, see the NameOccurrence proto definition: http://google3/quality/peoplesearch/namedetector/detector/proto/name_occurrence.proto?l=50&rcl=334484707 In general, when parsing display names the following rules will apply to *all* specs: – Hyphenated names are broken down: “Angelina Jollie-Pit” is pre-processed as “Angelina Jollie Pitt”; – Prefixes are ignored: “Prof. Albus Dumbledore” is pre-processed as “Albus Dumbledore”; – Auxiliaries are ignored: “Luís de Camões” is pre-processed as “Luís Camões”. Next ID: 8 | boolean |
| firstInitialAndVeryLastName | Show the initial of the very first name and the very last name, e.g. “Ana Maria Silva” yields “A. Silva”. | SocialGraphApiProtoPartialNameOptionsParsedDisplayNameSpec | These options use more sophisticated logic from a location-aware name detector to parse the full name of a user into structured parts and operate on those parts. For more information on how names are parsed, see the NameOccurrence proto definition: http://google3/quality/peoplesearch/namedetector/detector/proto/name_occurrence.proto?l=50&rcl=334484707 In general, when parsing display names the following rules will apply to *all* specs: – Hyphenated names are broken down: “Angelina Jollie-Pit” is pre-processed as “Angelina Jollie Pitt”; – Prefixes are ignored: “Prof. Albus Dumbledore” is pre-processed as “Albus Dumbledore”; – Auxiliaries are ignored: “Luís de Camões” is pre-processed as “Luís Camões”. Next ID: 8 | boolean |
| knowledgeGraphNameShortening | Shorten the display name using the Knowledge Graph name shortener (go/short-names). | SocialGraphApiProtoPartialNameOptionsParsedDisplayNameSpec | These options use more sophisticated logic from a location-aware name detector to parse the full name of a user into structured parts and operate on those parts. For more information on how names are parsed, see the NameOccurrence proto definition: http://google3/quality/peoplesearch/namedetector/detector/proto/name_occurrence.proto?l=50&rcl=334484707 In general, when parsing display names the following rules will apply to *all* specs: – Hyphenated names are broken down: “Angelina Jollie-Pit” is pre-processed as “Angelina Jollie Pitt”; – Prefixes are ignored: “Prof. Albus Dumbledore” is pre-processed as “Albus Dumbledore”; – Auxiliaries are ignored: “Luís de Camões” is pre-processed as “Luís Camões”. Next ID: 8 | boolean |
| truncationIndicator | Which truncation indicator to use after each shortened part of the name. Will be ignored for the `knowledge_graph_name_shortening` option. | SocialGraphApiProtoPartialNameOptionsParsedDisplayNameSpec | These options use more sophisticated logic from a location-aware name detector to parse the full name of a user into structured parts and operate on those parts. For more information on how names are parsed, see the NameOccurrence proto definition: http://google3/quality/peoplesearch/namedetector/detector/proto/name_occurrence.proto?l=50&rcl=334484707 In general, when parsing display names the following rules will apply to *all* specs: – Hyphenated names are broken down: “Angelina Jollie-Pit” is pre-processed as “Angelina Jollie Pitt”; – Prefixes are ignored: “Prof. Albus Dumbledore” is pre-processed as “Albus Dumbledore”; – Auxiliaries are ignored: “Luís de Camões” is pre-processed as “Luís Camões”. Next ID: 8 | String |
| veryFirstNameAndAllInitials | Show the full very first name and all the other initials, e.g. “Ana Maria Silva” yields “Ana M. S.”. | SocialGraphApiProtoPartialNameOptionsParsedDisplayNameSpec | These options use more sophisticated logic from a location-aware name detector to parse the full name of a user into structured parts and operate on those parts. For more information on how names are parsed, see the NameOccurrence proto definition: http://google3/quality/peoplesearch/namedetector/detector/proto/name_occurrence.proto?l=50&rcl=334484707 In general, when parsing display names the following rules will apply to *all* specs: – Hyphenated names are broken down: “Angelina Jollie-Pit” is pre-processed as “Angelina Jollie Pitt”; – Prefixes are ignored: “Prof. Albus Dumbledore” is pre-processed as “Albus Dumbledore”; – Auxiliaries are ignored: “Luís de Camões” is pre-processed as “Luís Camões”. Next ID: 8 | boolean |
| veryFirstNameOnly | Show the very first name only, e.g. “Ana Maria Silva” yields “Ana”. | SocialGraphApiProtoPartialNameOptionsParsedDisplayNameSpec | These options use more sophisticated logic from a location-aware name detector to parse the full name of a user into structured parts and operate on those parts. For more information on how names are parsed, see the NameOccurrence proto definition: http://google3/quality/peoplesearch/namedetector/detector/proto/name_occurrence.proto?l=50&rcl=334484707 In general, when parsing display names the following rules will apply to *all* specs: – Hyphenated names are broken down: “Angelina Jollie-Pit” is pre-processed as “Angelina Jollie Pitt”; – Prefixes are ignored: “Prof. Albus Dumbledore” is pre-processed as “Albus Dumbledore”; – Auxiliaries are ignored: “Luís de Camões” is pre-processed as “Luís Camões”. Next ID: 8 | boolean |
| familyNameSpec | SocialGraphApiProtoPartialNameOptionsTwoPartNameSpec | Holds the name specs for the two parts of a name, as they are structured in storage (given and family). | SocialGraphApiProtoPartialNameOptionsNamePartSpec | |
| givenNameSpec | SocialGraphApiProtoPartialNameOptionsTwoPartNameSpec | Holds the name specs for the two parts of a name, as they are structured in storage (given and family). | SocialGraphApiProtoPartialNameOptionsNamePartSpec | |
| relativePosition | Top left position of the overlay relative to the user’s avatar. | SocialGraphApiProtoPhotoOverlay | Settings that control how a photo overlay is displayed. | SocialGraphApiProtoRelativePosition |
| relativeScale | Scale of the overlay relative to the user’s avatar. | SocialGraphApiProtoPhotoOverlay | Settings that control how a photo overlay is displayed. | SocialGraphApiProtoRelativeScale |
| activeState | Indicates if this prompt is active regardless of its reccurrence date, dismiss date or notification triggers. This is required. | SocialGraphApiProtoPrompt | Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) | String |
| content | SocialGraphApiProtoPrompt | Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) | SocialGraphApiProtoPromptContent | |
| lastDismissDate | The most recent day the user dismissed this prompt. Empty means the user has never dismissed the prompt. | SocialGraphApiProtoPrompt | Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) | GoogleTypeDate |
| notificationTriggers | If this is empty, only the “Prompt Spark” will be displayed (in the time-range read from per type config), no push notifications will be shown. If push notification are configured with this field, the “Prompt Spark” time-range will be determined by earliest notification value here. | SocialGraphApiProtoPrompt | Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) | list(SocialGraphApiProtoNotificationTrigger) |
| purpose | Read-only. This is derived from the containing field value. | SocialGraphApiProtoPrompt | Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) | String |
| recurrence | How frequently will this prompt occur and how many times. | SocialGraphApiProtoPrompt | Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) | SocialGraphApiProtoRecurrence |
| uniquePromptId | Prompt ID is generated by server on initial mutate. | SocialGraphApiProtoPrompt | Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) | String |
| title | Title of prompt/spark being sent. | SocialGraphApiProtoPromptContent | Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) and in Custard response to client apps that read Prompts. | String |
| pronounEntry | SocialGraphApiProtoPronounData | Design doc: go/pronouns-backend Represents a user’s preferred pronouns. | list(SocialGraphApiProtoPronounEntry) | |
| languageCode | Locale option in which the pronouns were set, in the BCP-47 format. Set by the client at write time. | SocialGraphApiProtoPronounEntry | String | |
| pronounType | The pronoun entry type that the user has selected. This indicates which locale-independent classification of pronoun was selected (or optionally, if it is a custom field). | SocialGraphApiProtoPronounEntry | String | |
| value | The user’s preferred pronouns. Eg. “they / them”. This is a human-readable string to be displayed as the user’s pronoun. Set at write-time, regardless of pronoun-type. Value is returned as it was set (no localization). | SocialGraphApiProtoPronounEntry | String | |
| learningSessionId | All pronunciations with the same learning_session_id were learnt in the same learning flow, e.g. multiple name segments learnt simultaneously from a recording in the Your People UI. | SocialGraphApiProtoPronunciation | Stores the pronunciation as phoneme for the given word/text. Next ID: 8 | String |
| learningSource | SocialGraphApiProtoPronunciation | Stores the pronunciation as phoneme for the given word/text. Next ID: 8 | String | |
| locale | The locale used when learning the pronunciation. BCP-47 language code, e.g. “en-US”. | SocialGraphApiProtoPronunciation | Stores the pronunciation as phoneme for the given word/text. Next ID: 8 | String |
| phonemes | Phoneme sequence representing how the user pronounces |token|. Format is specified by the phonology_type type field, e.g. go/psampa is the preferred phonology type used by the TTS team. | SocialGraphApiProtoPronunciation | Stores the pronunciation as phoneme for the given word/text. Next ID: 8 | String |
| phonologyType | SocialGraphApiProtoPronunciation | Stores the pronunciation as phoneme for the given word/text. Next ID: 8 | String | |
| spellingHint | An optional user-specified spelling of this token, to improve pronunciation learning success rate. E.g. the token may be “Jana” and the spelling hint “jah-nah”. | SocialGraphApiProtoPronunciation | Stores the pronunciation as phoneme for the given word/text. Next ID: 8 | String |
| token | Corresponds to a word segment of the contact name. E.g. for a contact with given name “John Doe”, last name “Smith” and nickname “Best Dad”, |token| can be any of {John, Doe, Smith, Best, Dad}. | SocialGraphApiProtoPronunciation | Stores the pronunciation as phoneme for the given word/text. Next ID: 8 | String |
| pronunciation | SocialGraphApiProtoPronunciations | Container proto for repeated pronunciation objects. For example, a set of pronunciations that can be added to a single name field. | list(SocialGraphApiProtoPronunciation) | |
| dailyRecurrence | SocialGraphApiProtoRecurrence | Flexible Recurrence proto to be used with People Prompts. Examples: Single recurrence that occurs on a specific date: single_recurrence { date { year: 2022 month: 11 day: 17 } } Yearly recurrence such as a birthday or anniversary: yearly_recurrence { monthly_pattern { monthly_day_recurrence { month_day: 17 } } months: JULY } Weekly reccurrence such as: every two weeks on Monday: every: 2 weekly_recurrence { week_day: MONDAY } Monthly recurrence such as: third Thursday of every month: monthly_recurrence { monthly_weekday_recurrence { week_day: THURSDAY week_day_number: 3 } } Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) The canonical recurrence validation function is located here: http://google3/java/com/google/social/people/prompts/util/PromptValidators.java?q=func:%5CbvalidateRecurrence%5Cb | SocialGraphApiProtoDailyRecurrence | |
| every | Multiplier on the frequency of the recurrence. Use this to specify patterns that recur every X days, months, years, etc. Must be a positive int. Example: [remind me to call mom every 2nd week]. If this field isn’t set, it will default to 1 (every day,every week, etc). This field is ignored when recurrence_data is a SingleRecurrence. Optional. | SocialGraphApiProtoRecurrence | Flexible Recurrence proto to be used with People Prompts. Examples: Single recurrence that occurs on a specific date: single_recurrence { date { year: 2022 month: 11 day: 17 } } Yearly recurrence such as a birthday or anniversary: yearly_recurrence { monthly_pattern { monthly_day_recurrence { month_day: 17 } } months: JULY } Weekly reccurrence such as: every two weeks on Monday: every: 2 weekly_recurrence { week_day: MONDAY } Monthly recurrence such as: third Thursday of every month: monthly_recurrence { monthly_weekday_recurrence { week_day: THURSDAY week_day_number: 3 } } Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) The canonical recurrence validation function is located here: http://google3/java/com/google/social/people/prompts/util/PromptValidators.java?q=func:%5CbvalidateRecurrence%5Cb | integer |
| monthlyRecurrence | SocialGraphApiProtoRecurrence | Flexible Recurrence proto to be used with People Prompts. Examples: Single recurrence that occurs on a specific date: single_recurrence { date { year: 2022 month: 11 day: 17 } } Yearly recurrence such as a birthday or anniversary: yearly_recurrence { monthly_pattern { monthly_day_recurrence { month_day: 17 } } months: JULY } Weekly reccurrence such as: every two weeks on Monday: every: 2 weekly_recurrence { week_day: MONDAY } Monthly recurrence such as: third Thursday of every month: monthly_recurrence { monthly_weekday_recurrence { week_day: THURSDAY week_day_number: 3 } } Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) The canonical recurrence validation function is located here: http://google3/java/com/google/social/people/prompts/util/PromptValidators.java?q=func:%5CbvalidateRecurrence%5Cb | SocialGraphApiProtoMonthlyRecurrence | |
| recurrenceEndDate | Ends at abstract DateTime. (inclusive) | SocialGraphApiProtoRecurrence | Flexible Recurrence proto to be used with People Prompts. Examples: Single recurrence that occurs on a specific date: single_recurrence { date { year: 2022 month: 11 day: 17 } } Yearly recurrence such as a birthday or anniversary: yearly_recurrence { monthly_pattern { monthly_day_recurrence { month_day: 17 } } months: JULY } Weekly reccurrence such as: every two weeks on Monday: every: 2 weekly_recurrence { week_day: MONDAY } Monthly recurrence such as: third Thursday of every month: monthly_recurrence { monthly_weekday_recurrence { week_day: THURSDAY week_day_number: 3 } } Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) The canonical recurrence validation function is located here: http://google3/java/com/google/social/people/prompts/util/PromptValidators.java?q=func:%5CbvalidateRecurrence%5Cb | GoogleTypeDateTime |
| recurrenceStart | The start of the recurrence can be represented as a DateTime. This field is ignored when recurrence_data is a SingleRecurrence. | SocialGraphApiProtoRecurrence | Flexible Recurrence proto to be used with People Prompts. Examples: Single recurrence that occurs on a specific date: single_recurrence { date { year: 2022 month: 11 day: 17 } } Yearly recurrence such as a birthday or anniversary: yearly_recurrence { monthly_pattern { monthly_day_recurrence { month_day: 17 } } months: JULY } Weekly reccurrence such as: every two weeks on Monday: every: 2 weekly_recurrence { week_day: MONDAY } Monthly recurrence such as: third Thursday of every month: monthly_recurrence { monthly_weekday_recurrence { week_day: THURSDAY week_day_number: 3 } } Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) The canonical recurrence validation function is located here: http://google3/java/com/google/social/people/prompts/util/PromptValidators.java?q=func:%5CbvalidateRecurrence%5Cb | GoogleTypeDateTime |
| repeatCount | Will repeat only a finite number of times. This is the original number of times the recurrence will repeat and not how many times are left for it to repeat. This end type is not currently supported. | SocialGraphApiProtoRecurrence | Flexible Recurrence proto to be used with People Prompts. Examples: Single recurrence that occurs on a specific date: single_recurrence { date { year: 2022 month: 11 day: 17 } } Yearly recurrence such as a birthday or anniversary: yearly_recurrence { monthly_pattern { monthly_day_recurrence { month_day: 17 } } months: JULY } Weekly reccurrence such as: every two weeks on Monday: every: 2 weekly_recurrence { week_day: MONDAY } Monthly recurrence such as: third Thursday of every month: monthly_recurrence { monthly_weekday_recurrence { week_day: THURSDAY week_day_number: 3 } } Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) The canonical recurrence validation function is located here: http://google3/java/com/google/social/people/prompts/util/PromptValidators.java?q=func:%5CbvalidateRecurrence%5Cb | integer |
| repeatForever | Will continue to repeat until prompt is deleted. | SocialGraphApiProtoRecurrence | Flexible Recurrence proto to be used with People Prompts. Examples: Single recurrence that occurs on a specific date: single_recurrence { date { year: 2022 month: 11 day: 17 } } Yearly recurrence such as a birthday or anniversary: yearly_recurrence { monthly_pattern { monthly_day_recurrence { month_day: 17 } } months: JULY } Weekly reccurrence such as: every two weeks on Monday: every: 2 weekly_recurrence { week_day: MONDAY } Monthly recurrence such as: third Thursday of every month: monthly_recurrence { monthly_weekday_recurrence { week_day: THURSDAY week_day_number: 3 } } Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) The canonical recurrence validation function is located here: http://google3/java/com/google/social/people/prompts/util/PromptValidators.java?q=func:%5CbvalidateRecurrence%5Cb | SocialGraphApiProtoRecurrenceRepeatForever |
| singleRecurrence | SocialGraphApiProtoRecurrence | Flexible Recurrence proto to be used with People Prompts. Examples: Single recurrence that occurs on a specific date: single_recurrence { date { year: 2022 month: 11 day: 17 } } Yearly recurrence such as a birthday or anniversary: yearly_recurrence { monthly_pattern { monthly_day_recurrence { month_day: 17 } } months: JULY } Weekly reccurrence such as: every two weeks on Monday: every: 2 weekly_recurrence { week_day: MONDAY } Monthly recurrence such as: third Thursday of every month: monthly_recurrence { monthly_weekday_recurrence { week_day: THURSDAY week_day_number: 3 } } Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) The canonical recurrence validation function is located here: http://google3/java/com/google/social/people/prompts/util/PromptValidators.java?q=func:%5CbvalidateRecurrence%5Cb | SocialGraphApiProtoSingleRecurrence | |
| weeklyRecurrence | SocialGraphApiProtoRecurrence | Flexible Recurrence proto to be used with People Prompts. Examples: Single recurrence that occurs on a specific date: single_recurrence { date { year: 2022 month: 11 day: 17 } } Yearly recurrence such as a birthday or anniversary: yearly_recurrence { monthly_pattern { monthly_day_recurrence { month_day: 17 } } months: JULY } Weekly reccurrence such as: every two weeks on Monday: every: 2 weekly_recurrence { week_day: MONDAY } Monthly recurrence such as: third Thursday of every month: monthly_recurrence { monthly_weekday_recurrence { week_day: THURSDAY week_day_number: 3 } } Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) The canonical recurrence validation function is located here: http://google3/java/com/google/social/people/prompts/util/PromptValidators.java?q=func:%5CbvalidateRecurrence%5Cb | SocialGraphApiProtoWeeklyRecurrence | |
| yearlyRecurrence | SocialGraphApiProtoRecurrence | Flexible Recurrence proto to be used with People Prompts. Examples: Single recurrence that occurs on a specific date: single_recurrence { date { year: 2022 month: 11 day: 17 } } Yearly recurrence such as a birthday or anniversary: yearly_recurrence { monthly_pattern { monthly_day_recurrence { month_day: 17 } } months: JULY } Weekly reccurrence such as: every two weeks on Monday: every: 2 weekly_recurrence { week_day: MONDAY } Monthly recurrence such as: third Thursday of every month: monthly_recurrence { monthly_weekday_recurrence { week_day: THURSDAY week_day_number: 3 } } Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) The canonical recurrence validation function is located here: http://google3/java/com/google/social/people/prompts/util/PromptValidators.java?q=func:%5CbvalidateRecurrence%5Cb | SocialGraphApiProtoYearlyRecurrence | |
| x | SocialGraphApiProtoRelativePosition | Position relative to the user’s avatar. 0 = top/left, 1 = bottom/right. | number | |
| y | SocialGraphApiProtoRelativePosition | Position relative to the user’s avatar. 0 = top/left, 1 = bottom/right. | number | |
| x | SocialGraphApiProtoRelativeScale | Scale relative to the user’s avatar. x and y range from 0 (exclusive) to 1 (inclusive). | number | |
| y | SocialGraphApiProtoRelativeScale | Scale relative to the user’s avatar. x and y range from 0 (exclusive) to 1 (inclusive). | number | |
| description | A free-text summary that the user inputs. E.g. “Coder by day, jazz guitarist by night.” | SocialGraphApiProtoSearchProfileData | Data contained in every search profile. go/janata-profile-in-sgbe. | String |
| education | SocialGraphApiProtoSearchProfileData | Data contained in every search profile. go/janata-profile-in-sgbe. | list(SocialGraphApiProtoSearchProfileEducation) | |
| interest | SocialGraphApiProtoSearchProfileData | Data contained in every search profile. go/janata-profile-in-sgbe. | list(SocialGraphApiProtoSearchProfileEntity) | |
| language | Indicates the language of this search profile. Use ISO-639 2-letter language code to specifying the language that this profile is created in. | SocialGraphApiProtoSearchProfileData | Data contained in every search profile. go/janata-profile-in-sgbe. | String |
| location | SocialGraphApiProtoSearchProfileData | Data contained in every search profile. go/janata-profile-in-sgbe. | list(SocialGraphApiProtoSearchProfileLocation) | |
| metadata | SocialGraphApiProtoSearchProfileData | Data contained in every search profile. go/janata-profile-in-sgbe. | SocialGraphApiProtoSearchProfileMetadata | |
| occupation | SocialGraphApiProtoSearchProfileData | Data contained in every search profile. go/janata-profile-in-sgbe. | list(SocialGraphApiProtoSearchProfileEntity) | |
| publicEmail | This is the email that the user has chosen to display on their “SearchCard” publicly. | SocialGraphApiProtoSearchProfileData | Data contained in every search profile. go/janata-profile-in-sgbe. | list(String) |
| publicPhoneNumber | This is the phone number that the user has chosen to display on their “SearchCard” publicly. | SocialGraphApiProtoSearchProfileData | Data contained in every search profile. go/janata-profile-in-sgbe. | list(String) |
| socialLink | SocialGraphApiProtoSearchProfileData | Data contained in every search profile. go/janata-profile-in-sgbe. | list(SocialGraphApiProtoSearchProfileSocialLink) | |
| website | SocialGraphApiProtoSearchProfileData | Data contained in every search profile. go/janata-profile-in-sgbe. | list(String) | |
| workplace | SocialGraphApiProtoSearchProfileData | Data contained in every search profile. go/janata-profile-in-sgbe. | list(SocialGraphApiProtoSearchProfileWorkplace) | |
| endTime | SocialGraphApiProtoSearchProfileEducation | Wraps information about a user’s eductational background. | GoogleTypeDate | |
| fieldOfStudy | SocialGraphApiProtoSearchProfileEducation | Wraps information about a user’s eductational background. | list(SocialGraphApiProtoSearchProfileEntity) | |
| institution | SocialGraphApiProtoSearchProfileEducation | Wraps information about a user’s eductational background. | SocialGraphApiProtoSearchProfileEntity | |
| startTime | SocialGraphApiProtoSearchProfileEducation | Wraps information about a user’s eductational background. | GoogleTypeDate | |
| countryCode | Corresponding country code. Refer to go/people-search-dashboard for code list. | SocialGraphApiProtoSearchProfileEntity | This proto represents either a KG-entity, as represented by it’s MID, or free-string text. | String |
| entity | Corresponding mid in KG. | SocialGraphApiProtoSearchProfileEntity | This proto represents either a KG-entity, as represented by it’s MID, or free-string text. | String |
| name | Custom name of entity if there is no corresponding place/entity in KG (mid) | SocialGraphApiProtoSearchProfileEntity | This proto represents either a KG-entity, as represented by it’s MID, or free-string text. | list(String) |
| endTime | SocialGraphApiProtoSearchProfileLocation | Wraps information about a user’s location, if they have chosen to share it on their SearchCard. | GoogleTypeDate | |
| lengthOfStay | SocialGraphApiProtoSearchProfileLocation | Wraps information about a user’s location, if they have chosen to share it on their SearchCard. | String | |
| place | SocialGraphApiProtoSearchProfileLocation | Wraps information about a user’s location, if they have chosen to share it on their SearchCard. | SocialGraphApiProtoSearchProfileEntity | |
| point | SocialGraphApiProtoSearchProfileLocation | Wraps information about a user’s location, if they have chosen to share it on their SearchCard. | SocialGraphApiProtoSearchProfileLocationInfo | |
| startTime | SocialGraphApiProtoSearchProfileLocation | Wraps information about a user’s location, if they have chosen to share it on their SearchCard. | GoogleTypeDate | |
| type | SocialGraphApiProtoSearchProfileLocation | Wraps information about a user’s location, if they have chosen to share it on their SearchCard. | String | |
| lat | Degrees [-90 .. 90] | SocialGraphApiProtoSearchProfileLocationInfo | float | |
| lon | Degrees [-180 .. 180] | SocialGraphApiProtoSearchProfileLocationInfo | float | |
| radius | Meters | SocialGraphApiProtoSearchProfileLocationInfo | float | |
| accountId | Unique contributor account id allocated by presence/janata infrastructure. This will be used in the frontend for various actions like reporting errors, photo uploads etc., go/boba-janata, go/cleanup-contributor-creation | SocialGraphApiProtoSearchProfileMetadata | This proto represents metadata of the users SearchProfile like profile state, GOG account id etc., | String |
| accountMid | Account KG entity mid assigned to this user required by old janata serving stack. This is not required anymore for serving. But might need it for historical purposes. See https://hume.google.com/edit/g/11gg6cyvch for more details. | SocialGraphApiProtoSearchProfileMetadata | This proto represents metadata of the users SearchProfile like profile state, GOG account id etc., | String |
| aresId | Ares id used for tracking the auto moderation. | SocialGraphApiProtoSearchProfileMetadata | This proto represents metadata of the users SearchProfile like profile state, GOG account id etc., | String |
| state | Current state of the Search Profile. | SocialGraphApiProtoSearchProfileMetadata | This proto represents metadata of the users SearchProfile like profile state, GOG account id etc., | list(SocialGraphApiProtoSearchProfileState) |
| link | SocialGraphApiProtoSearchProfileSocialLink | Wraps social profile information about the user. | String | |
| type | SocialGraphApiProtoSearchProfileSocialLink | Wraps social profile information about the user. | String | |
| changeTimestamp | Timestamp of when the state was changed. | SocialGraphApiProtoSearchProfileState | DateTime | |
| displayTimestamp | This will be used to display status to the user at a set time. If set to a value after `change_timestamp`, the change will not be ‘reflected’ until this time. | SocialGraphApiProtoSearchProfileState | DateTime | |
| type | State that the UserProfile was changed to. | SocialGraphApiProtoSearchProfileState | String | |
| company | SocialGraphApiProtoSearchProfileWorkplace | Wraps information about a user working at a specific place. | SocialGraphApiProtoSearchProfileEntity | |
| endTime | SocialGraphApiProtoSearchProfileWorkplace | Wraps information about a user working at a specific place. | GoogleTypeDate | |
| startTime | SocialGraphApiProtoSearchProfileWorkplace | Wraps information about a user working at a specific place. | GoogleTypeDate | |
| date | SocialGraphApiProtoSingleRecurrence | This prompt will occur one time only. Could be a single event such as a graduation or a single connection reminder e.g. remind me to call X on 2022/03/19. Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) | GoogleTypeDate | |
| sourceId | CP2 sourceid column. | SocialGraphApiProtoSyncInfo | LINT.IfChange | String |
| sync1 | CP2 sync1 column. | SocialGraphApiProtoSyncInfo | LINT.IfChange | String |
| sync2 | CP2 sync2 column. | SocialGraphApiProtoSyncInfo | LINT.IfChange | String |
| sync3 | CP2 sync3 column. | SocialGraphApiProtoSyncInfo | LINT.IfChange | String |
| sync4 | CP2 sync4 column. | SocialGraphApiProtoSyncInfo | LINT.IfChange | String |
| clientName | Not to be used. We have since moved to a lookup string at read time approach as opposed to storing data at write time. b/146072927 | SocialGraphApiProtoThirdPartyInfo | String | |
| projectNumber | Project number of the third party application performing the delete to be looked up via ClientAuthConfig during display time for users to know the current name of an application which has deleted contact data. | SocialGraphApiProtoThirdPartyInfo | String | |
| lastTimeContacted | Last time a contact was contacted. | SocialGraphApiProtoUsageInfo | Usage information. This is currently used for device contacts. Next ID: 3 | DateTime |
| timesContacted | Number of times a contact was contacted. | SocialGraphApiProtoUsageInfo | Usage information. This is currently used for device contacts. Next ID: 3 | String |
| weekDay | Set of weekdays the recurrence applies to. | SocialGraphApiProtoWeeklyRecurrence | Pattern for a WEEKLY recurrence. You must specify at least one week_day. Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) | list(String) |
| monthlyPattern | The monthly pattern to recur. | SocialGraphApiProtoYearlyRecurrence | Pattern for a YEARLY recurrence. A YEARLY recurrence is specified using a monthly pattern and a set of months the pattern applies to. Some examples: “Every January 16” : monthly_pattern { monthly_day_recurrence { month_day: 16 } } months: JANUARY “Fourth Thursday of November and December” : monthly_pattern { monthly_weekday_recurrence { week_day: THURSDAY week_day_number: 4 } } months: NOVEMBER months: DECEMBER Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) | SocialGraphApiProtoMonthlyRecurrence |
| months | The months of the year to apply the pattern. | SocialGraphApiProtoYearlyRecurrence | Pattern for a YEARLY recurrence. A YEARLY recurrence is specified using a monthly pattern and a set of months the pattern applies to. Some examples: “Every January 16” : monthly_pattern { monthly_day_recurrence { month_day: 16 } } months: JANUARY “Fourth Thursday of November and December” : monthly_pattern { monthly_weekday_recurrence { week_day: THURSDAY week_day_number: 4 } } months: NOVEMBER months: DECEMBER Used in PeopleAPI layers + FBS/ContactsService (not in ProfileService) | list(String) |
| clientInteractionInfo | Information regarding client interactions. | SocialGraphWireProtoPeopleapiAffinityMetadata | Extra ranking info returned with affinity data. This info is returned by DAS and passed to PAPI clients (Yenta), where it is used for ranking and filtering device and server suggestions together. | SocialGraphWireProtoPeopleapiAffinityMetadataClientInteractionInfo |
| cloudDeviceDataInfo | Device information about the candidate available in the cloud. | SocialGraphWireProtoPeopleapiAffinityMetadata | Extra ranking info returned with affinity data. This info is returned by DAS and passed to PAPI clients (Yenta), where it is used for ranking and filtering device and server suggestions together. | SocialGraphWireProtoPeopleapiAffinityMetadataCloudDeviceDataInfo |
| cloudScore | Affinity score for the cloud contact. | SocialGraphWireProtoPeopleapiAffinityMetadata | Extra ranking info returned with affinity data. This info is returned by DAS and passed to PAPI clients (Yenta), where it is used for ranking and filtering device and server suggestions together. | float |
| suggestionConfidence | Indicator of the confidence in suggestion relevance. | SocialGraphWireProtoPeopleapiAffinityMetadata | Extra ranking info returned with affinity data. This info is returned by DAS and passed to PAPI clients (Yenta), where it is used for ranking and filtering device and server suggestions together. | String |
| isDirectClientInteraction | Whether this suggestion is an edge directly from the client. E.g., a suggestion with which the user shared a photo on photos app. | SocialGraphWireProtoPeopleapiAffinityMetadataClientInteractionInfo | boolean | |
| deviceScore | The partial affinity score only counting device features. | SocialGraphWireProtoPeopleapiAffinityMetadataCloudDeviceDataInfo | float | |
| isDeviceDataKnown | Whether device data about this candidate were available in the cloud. | SocialGraphWireProtoPeopleapiAffinityMetadataCloudDeviceDataInfo | boolean | |
| availabilities | SocialGraphWireProtoPeopleapiExtensionAppsWaldoExtendedData | Waldo-related extension data. | GoogleInternalAppsWaldoV1alphaUserAvailabilities | |
| avatarUrl | Avatar image URL for a Google Group, based on the member count. | SocialGraphWireProtoPeopleapiExtensionDynamiteExtendedData | Dynamite-related extension data. | String |
| description | Short description of this bot. Only set if EntityType == BOT. | SocialGraphWireProtoPeopleapiExtensionDynamiteExtendedData | Dynamite-related extension data. | String |
| developerName | Display name of bot developer. Only set if EntityType == BOT. | SocialGraphWireProtoPeopleapiExtensionDynamiteExtendedData | Dynamite-related extension data. | String |
| dndState | SocialGraphWireProtoPeopleapiExtensionDynamiteExtendedData | Dynamite-related extension data. | String | |
| entityType | SocialGraphWireProtoPeopleapiExtensionDynamiteExtendedData | Dynamite-related extension data. | String | |
| isMembershipVisibleToCaller | Whether caller has visibility into the direct members of the roster. NEXT TAG: 11 | SocialGraphWireProtoPeopleapiExtensionDynamiteExtendedData | Dynamite-related extension data. | boolean |
| memberCount | DEPRECATED: use segmented_membership_counts instead. Number of members (direct or indirect) in a Google Group. Only an estimate for large groups (currently > 1K direct / indirect members). | SocialGraphWireProtoPeopleapiExtensionDynamiteExtendedData | Dynamite-related extension data. | String |
| organizationInfo | SocialGraphWireProtoPeopleapiExtensionDynamiteExtendedData | Dynamite-related extension data. | AppsDynamiteSharedOrganizationInfo | |
| presence | SocialGraphWireProtoPeopleapiExtensionDynamiteExtendedData | Dynamite-related extension data. | String | |
| segmentedMembershipCounts | Represents the direct membership counts of a Google Group. May contain counts based on member type and membership state. | SocialGraphWireProtoPeopleapiExtensionDynamiteExtendedData | Dynamite-related extension data. | AppsDynamiteSharedSegmentedMembershipCounts |
| actorId | Actor ID of the person, if available (if the person has used the Paisa app). | SocialGraphWireProtoPeopleapiExtensionPaisaExtendedData | Next tag number: 3 | String |
| subtitle | Display subtitle, which may be used in suggestion/autocompletion results. Generally, this will be the Actor’s registered Paisa phone number, in unmasked or masked form (e.g. +1 ***-***-1234) depending on visibility rules. | SocialGraphWireProtoPeopleapiExtensionPaisaExtendedData | Next tag number: 3 | String |
| familyStatus | Whether the person is in the same family as the requesting user. Family here refers to https://families.google.com/families. This information is read from SuperGlue, and can be consumed by clients, e.g. Assistant and Photos. If this field is not set, the person is not in the user’s family. | SocialGraphWireProtoPeopleapiExtensionPeopleStackExtendedData | String | |
| hiddenKeys | The full list of hidden keys associated with this person. These are the external equivalent to the keys stored by the ConnectionLabelService, and they can be passed to the MutateConnectionLabel endpoint to unhide this person. This field will only be set if hide_type is HIDDEN. | SocialGraphWireProtoPeopleapiExtensionPeopleStackExtendedData | list(SocialDiscoveryExternalEntityKey) | |
| hideType | If this field is not set, the person is visible (implicit). | SocialGraphWireProtoPeopleapiExtensionPeopleStackExtendedData | String | |
| birthdayStatus | Whether the person has birthday field populated. | SocialGraphWireProtoPeopleapiExtensionPeopleStackPersonExtendedData | NEXT_ID: 6 | String |
| familyStatus | Whether the person is in the same family as the requesting user. Family here refers to https://families.google.com/families. This information is read from SuperGlue, and can be consumed by clients, e.g. Assistant and Photos. If this field is not set, the person is not in the user’s family. | SocialGraphWireProtoPeopleapiExtensionPeopleStackPersonExtendedData | NEXT_ID: 6 | String |
| hiddenKeys | The full list of hidden keys associated with this person. These are the external equivalent to the keys stored by the ConnectionLabelService, and they can be passed to the MutateConnectionLabel endpoint to unhide this person. This field will only be set if hide_type is HIDDEN. | SocialGraphWireProtoPeopleapiExtensionPeopleStackPersonExtendedData | NEXT_ID: 6 | list(SocialDiscoveryExternalEntityKey) |
| hideType | If this field is not set, the person is visible (implicit). | SocialGraphWireProtoPeopleapiExtensionPeopleStackPersonExtendedData | NEXT_ID: 6 | String |
| suggestionConfidence | SocialGraphWireProtoPeopleapiExtensionPeopleStackPersonExtendedData | NEXT_ID: 6 | String | |
| item | SocialPersonalizationKnexAnnotation | list(SocialPersonalizationKnexAnnotationItem) | ||
| confidence | SocialPersonalizationKnexAnnotationItem | Next Tag: 8 | number | |
| description | Description of the item for debugging. Note that this field is populated only in a few select places. | SocialPersonalizationKnexAnnotationItem | Next Tag: 8 | String |
| equivalentMid | If this field exists, then there exists a commonly used MID (typically a public MID, i.e., one in /m/) that approximates the meaning for this particular k’nex topic. For example, the value of this field for k’nex topic Tennis (/t/236) is /m/07bs0. The difference between k’nex /m/07bs0 and webref /m/07bs0 is as follows. If a content is annotated with webref /m/07bs0, then the content has to explicitly mention “Tennis” in some way, whereas if a content is annotated with k’nex /m/07bs0, then the content simply needs to talk about stuff related to tennis. Note that this field is not populated for all queries. For example, the compound concept “Tennis in California” does not have an associated mid. This field is intended to help external clients transit to k’nex. | SocialPersonalizationKnexAnnotationItem | Next Tag: 8 | String |
| generality | A score that measures how broad / narrow a topic is, independent of the document and/or user profile. This is an experimental score and is not populated by default. Currently, it is in the range of [0, 1], where the higher the score is, the more general a topic is. Please talk to sherlock-dev@ before using this score. Populated when debug_level > 0. | SocialPersonalizationKnexAnnotationItem | Next Tag: 8 | number |
| mid | This is an MID in the /t/ namespace. We will migrate them to /g/ in Q3’15. | SocialPersonalizationKnexAnnotationItem | Next Tag: 8 | String |
| relatedEntity | SocialPersonalizationKnexAnnotationItem | Next Tag: 8 | list(SocialPersonalizationKnexAnnotationItemTopic) | |
| topicality | SocialPersonalizationKnexAnnotationItem | Next Tag: 8 | number | |
| mid | SocialPersonalizationKnexAnnotationItemTopic | String | ||
| score | SocialPersonalizationKnexAnnotationItemTopic | number | ||
| doNotPublish | SocialStanzaDeliveryRestriction | Restrictions that affect the delivery of the stanza. By default, Stanzas are publishable, which means that they are eligible for indexing, aggregation, and other delivery options (Goops, Moonshine, notifications). A stanza can be created in a “do not publish” state; the stanza will not be published anywhere. The restriction can subsequently be removed with an UpdateStanza call, at which point the post will be treated as if it were newly created. A few notes/limitations about this option: 1. Client should keep a stanza unpublishable for a small period of time (if possible to) so that our ranking system does not consider this as a stale post (thus downranking the post). 2. Client should keep the number of unpublishable stanzas to a minimum, to reduce under-serving. 3. Updating a stanza from publishable to unpublishable after creation is not supported 4. At this time, publishing options are only supported on root stanzas; let us know if you require this for child stanzas. 5. Similarly, this is only supported as a global restriction. It may not be set as a per-destination-stream restriction. | boolean | |
| moderationReason | The reason why this stanza was moderated provided by client. | SocialStanzaModerationInfo | ModerationInfo stores the information of moderation for a stanza in a specific destination stream. Including who moderated and why. | String |
| moderator | SocialStanzaModerationInfo | ModerationInfo stores the information of moderation for a stanza in a specific destination stream. Including who moderated and why. | SecurityCredentialsPrincipalProto | |
| moderatorType | Type of moderation. Semantically REQUIRED, http://go/required At write time, only ModeratorType.AUTO_MODERATOR is allowed. For all other cases, this information is inferred from the request at write time. | SocialStanzaModerationInfo | ModerationInfo stores the information of moderation for a stanza in a specific destination stream. Including who moderated and why. | String |
| abuseTypes | The abuses. | SocialStanzaStanzaRestriction | Contains various restriction information about a stanza, derived from properties of the stanza, the viewer and the creator. Restrictions stored in this message are not related to direct/indirect relationship between the viewer and the creator of stanza. Some examples are: – Abusive – Legal – Racy – Content not suitable for age – Porn – Blocked by country/geo of viewer. – Restricted by stanza creator (not the user specific block). – etc… Please see go/stanza-abuse-flow for more details. | list(AbuseiamAbuseType) |
| appealState | The appeal state. | SocialStanzaStanzaRestriction | Contains various restriction information about a stanza, derived from properties of the stanza, the viewer and the creator. Restrictions stored in this message are not related to direct/indirect relationship between the viewer and the creator of stanza. Some examples are: – Abusive – Legal – Racy – Content not suitable for age – Porn – Blocked by country/geo of viewer. – Restricted by stanza creator (not the user specific block). – etc… Please see go/stanza-abuse-flow for more details. | String |
| contentRestriction | Field to explain various restrictions of the Stanza. Some examples of restrictions are: – Not permitted because of legal restrictions of geography/country of viewer or creator. – Content not suitable for current viewer i.e. porn, abusive, racy. – Creator restricted the content to an age group. – etc… | SocialStanzaStanzaRestriction | Contains various restriction information about a stanza, derived from properties of the stanza, the viewer and the creator. Restrictions stored in this message are not related to direct/indirect relationship between the viewer and the creator of stanza. Some examples are: – Abusive – Legal – Racy – Content not suitable for age – Porn – Blocked by country/geo of viewer. – Restricted by stanza creator (not the user specific block). – etc… Please see go/stanza-abuse-flow for more details. | AbuseiamContentRestriction |
| deleteReason | Delete reasons. This is a repeated field because an stanza can be deleted multiple times due to different reasons such as user_delete, admin_delete. | SocialStanzaStanzaRestriction | Contains various restriction information about a stanza, derived from properties of the stanza, the viewer and the creator. Restrictions stored in this message are not related to direct/indirect relationship between the viewer and the creator of stanza. Some examples are: – Abusive – Legal – Racy – Content not suitable for age – Porn – Blocked by country/geo of viewer. – Restricted by stanza creator (not the user specific block). – etc… Please see go/stanza-abuse-flow for more details. | list(String) |
| deliveryRestriction | Delivery restrictions, if present. | SocialStanzaStanzaRestriction | Contains various restriction information about a stanza, derived from properties of the stanza, the viewer and the creator. Restrictions stored in this message are not related to direct/indirect relationship between the viewer and the creator of stanza. Some examples are: – Abusive – Legal – Racy – Content not suitable for age – Porn – Blocked by country/geo of viewer. – Restricted by stanza creator (not the user specific block). – etc… Please see go/stanza-abuse-flow for more details. | SocialStanzaDeliveryRestriction |
| destinationStream | SocialStanzaStanzaRestriction | Contains various restriction information about a stanza, derived from properties of the stanza, the viewer and the creator. Restrictions stored in this message are not related to direct/indirect relationship between the viewer and the creator of stanza. Some examples are: – Abusive – Legal – Racy – Content not suitable for age – Porn – Blocked by country/geo of viewer. – Restricted by stanza creator (not the user specific block). – etc… Please see go/stanza-abuse-flow for more details. | AppsPeopleActivityBackendDestinationStream | |
| moderationInfo | The moderation info. At write time, this field is only allowed to be set when moderator_type is AUTO_MODERATOR. For other moderator types, moderation_reason is the only field that can be set by clients. | SocialStanzaStanzaRestriction | Contains various restriction information about a stanza, derived from properties of the stanza, the viewer and the creator. Restrictions stored in this message are not related to direct/indirect relationship between the viewer and the creator of stanza. Some examples are: – Abusive – Legal – Racy – Content not suitable for age – Porn – Blocked by country/geo of viewer. – Restricted by stanza creator (not the user specific block). – etc… Please see go/stanza-abuse-flow for more details. | SocialStanzaModerationInfo |
| moderationState | The moderation state. | SocialStanzaStanzaRestriction | Contains various restriction information about a stanza, derived from properties of the stanza, the viewer and the creator. Restrictions stored in this message are not related to direct/indirect relationship between the viewer and the creator of stanza. Some examples are: – Abusive – Legal – Racy – Content not suitable for age – Porn – Blocked by country/geo of viewer. – Restricted by stanza creator (not the user specific block). – etc… Please see go/stanza-abuse-flow for more details. | String |
| site | Sitechunker site granularity for this result | SpamBrainData | This holds SpamBrain values which are populated in docjoins. The data is populated at sitechunked host level and sitechunked domain level in the doc_attachments, and saved in Perdocdata in respective fields. | String |
| versionedData | Versioned scores of SB classifiers | SpamBrainData | This holds SpamBrain values which are populated in docjoins. The data is populated at sitechunked host level and sitechunked domain level in the doc_attachments, and saved in Perdocdata in respective fields. | list(SpamBrainScore) |
| modelName | SpamBrainScore | String | ||
| sbScore | The value corresponding to this version. | SpamBrainScore | number | |
| versionId | The version id (derived from the epoch – larger number means newer score) | SpamBrainScore | integer | |
| dropInServing | SpamCookbookAction | This protocol buffer indicates actions that we take based on Cookbook recipes (see http://cookbook/) matching a particular document. | boolean | |
| hackedDateNautilus | SpamMuppetjoinsMuppetSignals | integer | ||
| hackedDateRaiden | SpamMuppetjoinsMuppetSignals | integer | ||
| raidenScore | SpamMuppetjoinsMuppetSignals | float | ||
| site | SpamMuppetjoinsMuppetSignals | String | ||
| endTimeUsec | The end time of the input audio that this result refers to. This value should increase across LanguageIdentificationResult emitted by the Greco server running LangId, and reflects the server having processed more of the input audio. | SpeechS3LanguageIdentificationResult | Response proto for the LangId service running on a Greco server in prod. Next Tag: 6 | String |
| rankedTopSupportedLanguages | Ranked list of top-N language codes. Ranking is based on ConfidenceIntervals of supported languages, and N is defined in the LanguageIdentificationConfig. | SpeechS3LanguageIdentificationResult | Response proto for the LangId service running on a Greco server in prod. Next Tag: 6 | list(SpeechS3Locale) |
| startTimeUsec | Global start time. This value should be fixed across all LanguageIdentificationResults for a given utterance. | SpeechS3LanguageIdentificationResult | Response proto for the LangId service running on a Greco server in prod. Next Tag: 6 | String |
| topLanguageConfidence | Confidence interval of the top recognized language. | SpeechS3LanguageIdentificationResult | Response proto for the LangId service running on a Greco server in prod. Next Tag: 6 | String |
| voicedUtterance | Identifies when the provided audio sample does or doesn’t contain voiced samples. E.g. an unvoice utterance happens when the EOS signal is received before any frame because all frames were filtered by the endpointer. For events where voiced_utterance is false, ranked_top_supported_languages is defined but scores are not to be trusted. All LanguageIdentificationResults contains a valid value of voiced_utterance. | SpeechS3LanguageIdentificationResult | Response proto for the LangId service running on a Greco server in prod. Next Tag: 6 | boolean |
| format | The format of the string in “locale”. Should be one of LocaleFormat. | SpeechS3Locale | integer | |
| locale | SpeechS3Locale | String | ||
| atomicSize | Size of atomic type, in bytes. | SpeechWaveHeader | A general-purpose buffer to contain sequences of samples. When representing a waveform, the samples are the scalar values of an acoustic signal. When representing a sequence of feature frames, the samples are vector-valued frames. | integer |
| atomicType | Numeric type of data elements (if generic) | SpeechWaveHeader | A general-purpose buffer to contain sequences of samples. When representing a waveform, the samples are the scalar values of an acoustic signal. When representing a sequence of feature frames, the samples are vector-valued frames. | String |
| bitRate | For compressed signals with fixed bitrate, this is the number of bits per second. | SpeechWaveHeader | A general-purpose buffer to contain sequences of samples. When representing a waveform, the samples are the scalar values of an acoustic signal. When representing a sequence of feature frames, the samples are vector-valued frames. | number |
| byteOrder | Byte-order of the atomic_type When atomic_type == “char”, byte_order should be always “1”. When atomic_type == “int16”, byte_order can be either “01” (Intel) or “10” (Motorola). Byte order should default to Intel when in question. | SpeechWaveHeader | A general-purpose buffer to contain sequences of samples. When representing a waveform, the samples are the scalar values of an acoustic signal. When representing a sequence of feature frames, the samples are vector-valued frames. | String |
| details | Typically contains the parameter settings of the program that created the file. | SpeechWaveHeader | A general-purpose buffer to contain sequences of samples. When representing a waveform, the samples are the scalar values of an acoustic signal. When representing a sequence of feature frames, the samples are vector-valued frames. | String |
| dimension | Array dimensions for a single sample. * For audio samples: * mono: rank==0, dimension==[1] * stereo: rank==0, dimension==[2] (samples are interleaved) * For typical ASR features representing energy, 12 MFCC coefficients, and first and second derivatives: * rank==1 and dimension==[39]. | SpeechWaveHeader | A general-purpose buffer to contain sequences of samples. When representing a waveform, the samples are the scalar values of an acoustic signal. When representing a sequence of feature frames, the samples are vector-valued frames. | list(integer) |
| elementsPerSample | The number of atomic elements stored per sample. This is the product of all the entries in the dimension array. Written “out of order” in this file to be close to the dimension field, from which it can always be computed. | SpeechWaveHeader | A general-purpose buffer to contain sequences of samples. When representing a waveform, the samples are the scalar values of an acoustic signal. When representing a sequence of feature frames, the samples are vector-valued frames. | integer |
| rank | The rank of each sample. For a waveform (signals that are sequences of scalar values), this is 0. For vector-valued signals (used as signals containing sequences of features, for example), this is 1. scalar=0, vector=1, matrix=2, … | SpeechWaveHeader | A general-purpose buffer to contain sequences of samples. When representing a waveform, the samples are the scalar values of an acoustic signal. When representing a sequence of feature frames, the samples are vector-valued frames. | integer |
| sampleCoding | Sample encoding. Can be “ulaw”. | SpeechWaveHeader | A general-purpose buffer to contain sequences of samples. When representing a waveform, the samples are the scalar values of an acoustic signal. When representing a sequence of feature frames, the samples are vector-valued frames. | String |
| sampleRate | For periodic signals, this is the number samples per second, else 0.0 | SpeechWaveHeader | A general-purpose buffer to contain sequences of samples. When representing a waveform, the samples are the scalar values of an acoustic signal. When representing a sequence of feature frames, the samples are vector-valued frames. | number |
| sampleSize | Size of a single sample, in bytes. | SpeechWaveHeader | A general-purpose buffer to contain sequences of samples. When representing a waveform, the samples are the scalar values of an acoustic signal. When representing a sequence of feature frames, the samples are vector-valued frames. | integer |
| sampleType | Structure of each sample. “generic” means that the samples are multi-dimensional arrays of atomic_type with the specified rank. | SpeechWaveHeader | A general-purpose buffer to contain sequences of samples. When representing a waveform, the samples are the scalar values of an acoustic signal. When representing a sequence of feature frames, the samples are vector-valued frames. | String |
| startTime | Time origin for the signal, in seconds. Warning: Using float can result in rounding errors: float’s smallest distance between two representable values (1 ULP; see https://en.wikipedia.org/wiki/Unit_in_the_last_place) between 1024 and 2048 (representing ~17-34 min) is 0.0001220703125, what is approximately double of what we need to represent 1 sample in a 16 kHz sample rate audio. The error is double in the 2048s-4096s, 4x in the 4096s-8192s range etc. Higher sample rate encounters rounding errors earlier: with 96 kHz, rounding errors start at ~2 min (128s). | SpeechWaveHeader | A general-purpose buffer to contain sequences of samples. When representing a waveform, the samples are the scalar values of an acoustic signal. When representing a sequence of feature frames, the samples are vector-valued frames. | number |
| totalSamples | The number of samples in file. Can be inferred for generics from file size. | SpeechWaveHeader | A general-purpose buffer to contain sequences of samples. When representing a waveform, the samples are the scalar values of an acoustic signal. When representing a sequence of feature frames, the samples are vector-valued frames. | String |
| bugId | The buganizer ID associated with this legal request. This is required. | StorageGraphBfgLegalRequestMetadata | String | |
| directWriteRecordIds | If one triple is directly-written after recon by LG without going through Composer, we add the record id it’s from. Otherwise, it’s empty. Note: 1) LG will dedup record ids before updating it. So this field shouldn’t see duplicated record ids. 2) This is used internally by LG only. So if set by clients, they will be dropped by LG. | StorageGraphBfgLivegraphProvenanceMetadata | Metadata on source assertions that isn’t part of the user-visible Triple payload, and that doesn’t really represent data provenance, but that’s used to affect the way Livegraph and possibly other horizontal KG infra systems *process* the triple. Read: fields below really shouldn’t be part of the cross-system Triple proto at all. But because Triple is used both as an internal and an external KG API, we at least want to “hide” those fields that ought to be purely part of the internal source <-> LG contract. Next id: 6 | list(String) |
| lgInternalWriterId | Identifies the LG internal writers that asserted the triple. This is the same as ‘origin_id’ in LG. This will only be populated by the LG writers to FactStore | StorageGraphBfgLivegraphProvenanceMetadata | Metadata on source assertions that isn’t part of the user-visible Triple payload, and that doesn’t really represent data provenance, but that’s used to affect the way Livegraph and possibly other horizontal KG infra systems *process* the triple. Read: fields below really shouldn’t be part of the cross-system Triple proto at all. But because Triple is used both as an internal and an external KG API, we at least want to “hide” those fields that ought to be purely part of the internal source <-> LG contract. Next id: 6 | String |
| provenanceOnlyAddition | Whether this provenance is a provenance only addition or not. A provenance is considered an “addition” if it belongs to a triple that we expect FactStore to contain on its own (i.e through some inference), and thus we will *not* attempt to write it explicitly. This is a composer only populated field. Clients are not expected to populate this field. | StorageGraphBfgLivegraphProvenanceMetadata | Metadata on source assertions that isn’t part of the user-visible Triple payload, and that doesn’t really represent data provenance, but that’s used to affect the way Livegraph and possibly other horizontal KG infra systems *process* the triple. Read: fields below really shouldn’t be part of the cross-system Triple proto at all. But because Triple is used both as an internal and an external KG API, we at least want to “hide” those fields that ought to be purely part of the internal source <-> LG contract. Next id: 6 | boolean |
| triangulationKey | Triples typically have a single triangulation key. This field supports > 1 keys to allow staged transition to a different key scheme. To successfully triangulate in the Livegraph Composer, the triple must have >=3 instances and each triple instance having a pairwise disjoint set of triangulation keys. The triangulation keys supplied for a single input triple are treated part of the same set, so a single triple cannot self-triangulate, regardless of how many triangulation keys it has. Note2: If a triple has multiple provenances, each one is expected to set the same triangulation_keys. | StorageGraphBfgLivegraphProvenanceMetadata | Metadata on source assertions that isn’t part of the user-visible Triple payload, and that doesn’t really represent data provenance, but that’s used to affect the way Livegraph and possibly other horizontal KG infra systems *process* the triple. Read: fields below really shouldn’t be part of the cross-system Triple proto at all. But because Triple is used both as an internal and an external KG API, we at least want to “hide” those fields that ought to be purely part of the internal source <-> LG contract. Next id: 6 | list(String) |
| weakData | WARNING! The feature is still under active development and the exact semantics may be subject to change pending KE Design Review. Data marked as weak will be less preferred to regular data which does not have the marker. This allows ingesting data with a lower chance of negatively affecting existing features and products, at the cost of potentially not showing the data when competing data is available. Specifically, weak data is less preferred by conflict resolution inside of Livegraph composition. Additionally, RefX triggering will prefer to trigger based on signals computed from regular data. Aside from data providers choosing to mark their data as weak, Livegraph and RefX are the only horizontal systems expected to use this information. Please contact livegraph-team@ if you see a need for this to change. See go/weak-data for more information. | StorageGraphBfgLivegraphProvenanceMetadata | Metadata on source assertions that isn’t part of the user-visible Triple payload, and that doesn’t really represent data provenance, but that’s used to affect the way Livegraph and possibly other horizontal KG infra systems *process* the triple. Read: fields below really shouldn’t be part of the cross-system Triple proto at all. But because Triple is used both as an internal and an external KG API, we at least want to “hide” those fields that ought to be purely part of the internal source <-> LG contract. Next id: 6 | boolean |
| dataAccessRestrictions | Bitmap of LlmDataAccessRestriction. | StorageGraphBfgLlmPolicyMetadata | Metadata fields for LLM related data usage restrictions. See go/bard-kg-data-acl for more details. | integer |
| clientIdsAllowed | StorageGraphBfgLmsPolicyMetadata | Metadata fields for LMS. See go/lms-online-restrictions for details. | list(String) | |
| isEditorial | StorageGraphBfgLmsPolicyMetadata | Metadata fields for LMS. See go/lms-online-restrictions for details. | boolean | |
| modificationsAllowed | Int values corresponds to the values of image_repository.licensed.api.restrictions.Modification enum. | StorageGraphBfgLmsPolicyMetadata | Metadata fields for LMS. See go/lms-online-restrictions for details. | list(String) |
| regionsAllowed | StorageGraphBfgLmsPolicyMetadata | Metadata fields for LMS. See go/lms-online-restrictions for details. | KeGovernanceTypedRegions | |
| regionsDisallowed | StorageGraphBfgLmsPolicyMetadata | Metadata fields for LMS. See go/lms-online-restrictions for details. | KeGovernanceTypedRegions | |
| requiresAttribution | StorageGraphBfgLmsPolicyMetadata | Metadata fields for LMS. See go/lms-online-restrictions for details. | boolean | |
| requiresFirstPartyOnly | StorageGraphBfgLmsPolicyMetadata | Metadata fields for LMS. See go/lms-online-restrictions for details. | boolean | |
| requiresLinkback | StorageGraphBfgLmsPolicyMetadata | Metadata fields for LMS. See go/lms-online-restrictions for details. | boolean | |
| requiresShareAlike | StorageGraphBfgLmsPolicyMetadata | Metadata fields for LMS. See go/lms-online-restrictions for details. | boolean | |
| availabilityEndTimestamp | Timestamp after which data with this policy cannot be used. This value must be strictly larger/later than availability_start_time, if both are set. | StorageGraphBfgPolicyMetadata | Metadata about data governance policies. For more context, see go/ke-triple-dg-policy-and-metadata. If any attribute is not set, then there’s no specific restrictions associated with the missing attribute. For example, if `availability_start_timestamp` is not set, the data won’t be embargoed automatically; if `availability_end_timestamp` is not set, they won’t expire automatically. LINT.IfChange | DateTime |
| availabilityStartTimestamp | Timestamp before which data with this policy cannot be used. This value must be strictly smaller/earlier than availability_end_time, if both are set. | StorageGraphBfgPolicyMetadata | Metadata about data governance policies. For more context, see go/ke-triple-dg-policy-and-metadata. If any attribute is not set, then there’s no specific restrictions associated with the missing attribute. For example, if `availability_start_timestamp` is not set, the data won’t be embargoed automatically; if `availability_end_timestamp` is not set, they won’t expire automatically. LINT.IfChange | DateTime |
| legalAllowedRegions | List of regions in which the data with this policy is allowed to be used, while the data need to be removed in all regions outside this list according to legal request. This field should be used when the data is only allowed in a few regions and it is inconvenient to enumerate all of the regions in `legal_removal_regions` field. `legal_allowed_regions` and `legal_removal_region` together should include all possible regions, setting one field implies the other. Please set only one of them so the other field’s values are implied. See details: http://go/ke-allowed-countries-policy-1p WARNING: This field is for legal purposes only. Please do not populate it without consulting ke-data-governance@. | StorageGraphBfgPolicyMetadata | Metadata about data governance policies. For more context, see go/ke-triple-dg-policy-and-metadata. If any attribute is not set, then there’s no specific restrictions associated with the missing attribute. For example, if `availability_start_timestamp` is not set, the data won’t be embargoed automatically; if `availability_end_timestamp` is not set, they won’t expire automatically. LINT.IfChange | list(KeGovernanceTypedRegions) |
| legalRemovalRegions | List of regions in which the data with this policy need to be removed according to legal request. WARNING: This field is for legal purposes only. Please do not populate it without consulting ke-data-governance@. | StorageGraphBfgPolicyMetadata | Metadata about data governance policies. For more context, see go/ke-triple-dg-policy-and-metadata. If any attribute is not set, then there’s no specific restrictions associated with the missing attribute. For example, if `availability_start_timestamp` is not set, the data won’t be embargoed automatically; if `availability_end_timestamp` is not set, they won’t expire automatically. LINT.IfChange | list(KeGovernanceTypedRegions) |
| llmPolicyMetadata | Policy metadata fields for LLM related data usage restrictions. Only expected to be used by SCP internally — please consult ke-data-governance@ before populating this field. | StorageGraphBfgPolicyMetadata | Metadata about data governance policies. For more context, see go/ke-triple-dg-policy-and-metadata. If any attribute is not set, then there’s no specific restrictions associated with the missing attribute. For example, if `availability_start_timestamp` is not set, the data won’t be embargoed automatically; if `availability_end_timestamp` is not set, they won’t expire automatically. LINT.IfChange | StorageGraphBfgLlmPolicyMetadata |
| lmsPolicyMetadata | Policy metadata fields for LMS data. Only expected to be used by LMS providers — please consult ke-data-governance@ before populating this field. | StorageGraphBfgPolicyMetadata | Metadata about data governance policies. For more context, see go/ke-triple-dg-policy-and-metadata. If any attribute is not set, then there’s no specific restrictions associated with the missing attribute. For example, if `availability_start_timestamp` is not set, the data won’t be embargoed automatically; if `availability_end_timestamp` is not set, they won’t expire automatically. LINT.IfChange | StorageGraphBfgLmsPolicyMetadata |
| policyDataScopeKeys | This triple is protected by the policies with PolicyDataScope identified by these global unique ids. | StorageGraphBfgPolicyMetadata | Metadata about data governance policies. For more context, see go/ke-triple-dg-policy-and-metadata. If any attribute is not set, then there’s no specific restrictions associated with the missing attribute. For example, if `availability_start_timestamp` is not set, the data won’t be embargoed automatically; if `availability_end_timestamp` is not set, they won’t expire automatically. LINT.IfChange | list(integer) |
| policySourceType | Policy metadata are VERTICAL by default. Vertical policy makers / providers does not need to set this field explicitly. | StorageGraphBfgPolicyMetadata | Metadata about data governance policies. For more context, see go/ke-triple-dg-policy-and-metadata. If any attribute is not set, then there’s no specific restrictions associated with the missing attribute. For example, if `availability_start_timestamp` is not set, the data won’t be embargoed automatically; if `availability_end_timestamp` is not set, they won’t expire automatically. LINT.IfChange | String |
| rwjPolicyMetadata | Policy metadata fields for Real World Journey (RWJ) data. Only expected to be used by RWJ providers — please consult ke-data-governance@ before populating this field. | StorageGraphBfgPolicyMetadata | Metadata about data governance policies. For more context, see go/ke-triple-dg-policy-and-metadata. If any attribute is not set, then there’s no specific restrictions associated with the missing attribute. For example, if `availability_start_timestamp` is not set, the data won’t be embargoed automatically; if `availability_end_timestamp` is not set, they won’t expire automatically. LINT.IfChange | StorageGraphBfgRwjPolicyMetadata |
| umpPolicyMetadata | Policy metadata fields for UMP data. Only expected to be used by UMP providers — please consult ke-data-governance@ before populating this field. | StorageGraphBfgPolicyMetadata | Metadata about data governance policies. For more context, see go/ke-triple-dg-policy-and-metadata. If any attribute is not set, then there’s no specific restrictions associated with the missing attribute. For example, if `availability_start_timestamp` is not set, the data won’t be embargoed automatically; if `availability_end_timestamp` is not set, they won’t expire automatically. LINT.IfChange | StorageGraphBfgUmpPolicyMetadata |
| attributionUrl | Publicly-visible URLs claiming this fact. Can not be empty — at least one URL must be provided. | StorageGraphBfgPublicInformationMetadata | list(String) | |
| lastVerifiedDate | Most recent date at which ‘attribution_url’s were verified, as UNIX epoch time in milliseconds. This is required. | StorageGraphBfgPublicInformationMetadata | String | |
| eligibleSurfaces | Int values correspond to the usecases used in CDS. See: google3/googlebase/verticals/model/usecase_id.proto. | StorageGraphBfgRwjPolicyMetadata | Metadata fields for Real World Journey. See go/rwj-kg-dg for details. | list(String) |
| authorityFeedback | This fact was provided via KGO / Entity Authority. | StorageGraphBfgSpiiCertification | A fact about potentially sensitive personal info (http://what/SPII) can be “certified” iff it meets specific requirements. See go/kg-spii-certification for details. | StorageGraphBfgAuthorityFeedbackMetadata |
| legalRequest | This fact was provided via a legal request. | StorageGraphBfgSpiiCertification | A fact about potentially sensitive personal info (http://what/SPII) can be “certified” iff it meets specific requirements. See go/kg-spii-certification for details. | StorageGraphBfgLegalRequestMetadata |
| publicInformation | This fact is public information. (See go/kg-spii-certification for a description of what qualifies as public information — simply finding a fact online is not sufficient to certify a fact as public.) | StorageGraphBfgSpiiCertification | A fact about potentially sensitive personal info (http://what/SPII) can be “certified” iff it meets specific requirements. See go/kg-spii-certification for details. | StorageGraphBfgPublicInformationMetadata |
| accessRequired | Data providers shall use this to specify access requirement. | StorageGraphBfgTripleProvenance | a message containing information about the source of this triple. Note for freebase data: that this is an unpacking of the creator/attribution chain. The creator below is the actual creator of the attribution node, and the rest of the attribution data sits along side. Next id: 22 | String |
| accessRequiredInt | For KE internal use only. Data providers shall *not* set this. At ingress, LG Record service will read access_required and properly translate it to access_required_int. KE horizontal systems shall use this field instead of access_required; so that binaries would not depend on the release of a newly introduced AccessRequirement enum. (go/easy-ar-onboarding) | StorageGraphBfgTripleProvenance | a message containing information about the source of this triple. Note for freebase data: that this is an unpacking of the creator/attribution chain. The creator below is the actual creator of the attribution node, and the rest of the attribution data sits along side. Next id: 22 | integer |
| authoringTimestamp | StorageGraphBfgTripleProvenance | a message containing information about the source of this triple. Note for freebase data: that this is an unpacking of the creator/attribution chain. The creator below is the actual creator of the attribution node, and the rest of the attribution data sits along side. Next id: 22 | String | |
| creator | Freebase: the freebase user id in the form ‘/user/userid’ KG: the Google LDAP of the developer or MDB group that set up the triplification and import pipeline for this data source. | StorageGraphBfgTripleProvenance | a message containing information about the source of this triple. Note for freebase data: that this is an unpacking of the creator/attribution chain. The creator below is the actual creator of the attribution node, and the rest of the attribution data sits along side. Next id: 22 | String |
| dataset | Freebase & KG: the dataset the assertion was loaded from | StorageGraphBfgTripleProvenance | a message containing information about the source of this triple. Note for freebase data: that this is an unpacking of the creator/attribution chain. The creator below is the actual creator of the attribution node, and the rest of the attribution data sits along side. Next id: 22 | String |
| extractionPattern | StorageGraphBfgTripleProvenance | a message containing information about the source of this triple. Note for freebase data: that this is an unpacking of the creator/attribution chain. The creator below is the actual creator of the attribution node, and the rest of the attribution data sits along side. Next id: 22 | String | |
| extractionTimestamp | StorageGraphBfgTripleProvenance | a message containing information about the source of this triple. Note for freebase data: that this is an unpacking of the creator/attribution chain. The creator below is the actual creator of the attribution node, and the rest of the attribution data sits along side. Next id: 22 | String | |
| freebaseAttribution | Below are deprecated Provenance fields. They are not indexed or served in KE infrastructure (they are stripped at ingress in Livegraph). | StorageGraphBfgTripleProvenance | a message containing information about the source of this triple. Note for freebase data: that this is an unpacking of the creator/attribution chain. The creator below is the actual creator of the attribution node, and the rest of the attribution data sits along side. Next id: 22 | String |
| isSupportingData | Indicates that the corresponding data is supporting evidence for reconciliation only, and is *not* an assertion that should be visible to other systems or to external users. Note that this also means that no provenances indicating supporting data will be visible in the composed graph. Please see go/supporting-kg-triples-design-doc for additional details and background. If a triple is sent to Livegraph with multiple provenances each of them must have is_supporting_data bit set for it to be considered valid supporting evidence triple. | StorageGraphBfgTripleProvenance | a message containing information about the source of this triple. Note for freebase data: that this is an unpacking of the creator/attribution chain. The creator below is the actual creator of the attribution node, and the rest of the attribution data sits along side. Next id: 22 | boolean |
| lgMetadata | Internal metadata used by Livegraph and possibly other horizontal KG infra systems. This is not part of the logical triple or its provenance, and contents may not be visible downstream of LG. | StorageGraphBfgTripleProvenance | a message containing information about the source of this triple. Note for freebase data: that this is an unpacking of the creator/attribution chain. The creator below is the actual creator of the attribution node, and the rest of the attribution data sits along side. Next id: 22 | StorageGraphBfgLivegraphProvenanceMetadata |
| policyMetadata | Metadata specifying data governance policies. This information will be processed and enforced in KE systems. For more context, see go/ke-triple-dg-policy-and-metadata. WARNING: This field is WIP and please do not populate it without consulting ke-data-governance@. | StorageGraphBfgTripleProvenance | a message containing information about the source of this triple. Note for freebase data: that this is an unpacking of the creator/attribution chain. The creator below is the actual creator of the attribution node, and the rest of the attribution data sits along side. Next id: 22 | StorageGraphBfgPolicyMetadata |
| process | Used to uniquely identify data sources. Freebase: the OAuth application KG: the name of the source directory the triple was loaded from (eg, “amg”, “tms “, “collections”). KV: identifier of an extraction system, e.g., SAFT or Tractzor. | StorageGraphBfgTripleProvenance | a message containing information about the source of this triple. Note for freebase data: that this is an unpacking of the creator/attribution chain. The creator below is the actual creator of the attribution node, and the rest of the attribution data sits along side. Next id: 22 | String |
| provenanceExtension | StorageGraphBfgTripleProvenance | a message containing information about the source of this triple. Note for freebase data: that this is an unpacking of the creator/attribution chain. The creator below is the actual creator of the attribution node, and the rest of the attribution data sits along side. Next id: 22 | Proto2BridgeMessageSet | |
| rankingToken | ‘ranking_token’ (which must be accompanied by the ‘process’ field above or will be ignored) is used to distinguish subsets of data within a single process, solely for the purposes of composition in Livegraph. This field is useful when partitioning of data is needed, but using a separate process is intractable due to organizational or infrastructure limitations. For example, if a process such as “geo” wishes to distinguish some of their /type/object/name triples as higher priority in Composer’s conflict resolution rules, then they can add a config entry with a dedicated ranking_token and tag the relevant triples with that ranking_token. This field should only be used in conjunction with a Composer-side configuration to use it for value selection. It is not appropriate to use this field as free-form metadata. This value must match [[:alnum:]][[:alnum:]_-]{0,127} (i.e., [a-zA-Z0-9]+[a-zA-Z0-9_-]* and must be less than 128 characters in length) , or else its containing triple will be considered malformed and will be rejected by Livegraph at ingress. As of 2018-02-14, this field is used within Livegraph’s Composer and is exposed in Livegraph’s Lookup APIs to aid debugging, but it is not indexed or served by TopicServer. | StorageGraphBfgTripleProvenance | a message containing information about the source of this triple. Note for freebase data: that this is an unpacking of the creator/attribution chain. The creator below is the actual creator of the attribution node, and the rest of the attribution data sits along side. Next id: 22 | String |
| requiresTriangulation | When specified as part of triples input to Livegraph (go/livegraph), this indicates that the triple needs to be triangulated by 3 different sources before it can be served in production. A triple’s source is identified by its URL(provenance.source).host(). Please see go/baike-triangulation for more background on this. WARNING: If you’re a new client trying to enable triangulation for your feed, please contact lg-composition@/kashk@ before using this feature. | StorageGraphBfgTripleProvenance | a message containing information about the source of this triple. Note for freebase data: that this is an unpacking of the creator/attribution chain. The creator below is the actual creator of the attribution node, and the rest of the attribution data sits along side. Next id: 22 | boolean |
| restrictions | StorageGraphBfgTripleProvenance | a message containing information about the source of this triple. Note for freebase data: that this is an unpacking of the creator/attribution chain. The creator below is the actual creator of the attribution node, and the rest of the attribution data sits along side. Next id: 22 | list(String) | |
| source | Freebase & KG: if the triples were extracted from the web, the source URL where the assertion was found. (generally empty in freebase-sourced triples) TopicServer will serve/populate/retain if REQUIRES_CITATION is also set, or if the process is explicitly allowed. http://g/topic-server/vn9PBWtVKqI/arQEDqKTAgAJ | StorageGraphBfgTripleProvenance | a message containing information about the source of this triple. Note for freebase data: that this is an unpacking of the creator/attribution chain. The creator below is the actual creator of the attribution node, and the rest of the attribution data sits along side. Next id: 22 | String |
| sourceCategory | StorageGraphBfgTripleProvenance | a message containing information about the source of this triple. Note for freebase data: that this is an unpacking of the creator/attribution chain. The creator below is the actual creator of the attribution node, and the rest of the attribution data sits along side. Next id: 22 | list(String) | |
| sourceDocId | StorageGraphBfgTripleProvenance | a message containing information about the source of this triple. Note for freebase data: that this is an unpacking of the creator/attribution chain. The creator below is the actual creator of the attribution node, and the rest of the attribution data sits along side. Next id: 22 | list(String) | |
| spiiCertification | StorageGraphBfgTripleProvenance | a message containing information about the source of this triple. Note for freebase data: that this is an unpacking of the creator/attribution chain. The creator below is the actual creator of the attribution node, and the rest of the attribution data sits along side. Next id: 22 | StorageGraphBfgSpiiCertification | |
| availabilityEnds | Timestamp after which data with this policy cannot be used. | StorageGraphBfgUmpPolicyMetadata | Metadata fields for UMP. A piece of data satisfies UMP policy if: (data access region is in the `regions_allowed` list) AND (data access time >= availability_start_timestamp) AND (data access time < availability_end_timestamp) | DateTime |
| availabilityStarts | Timestamp before which data with this policy cannot be used. | StorageGraphBfgUmpPolicyMetadata | Metadata fields for UMP. A piece of data satisfies UMP policy if: (data access region is in the `regions_allowed` list) AND (data access time >= availability_start_timestamp) AND (data access time < availability_end_timestamp) | DateTime |
| regionsAllowed | StorageGraphBfgUmpPolicyMetadata | Metadata fields for UMP. A piece of data satisfies UMP policy if: (data access region is in the `regions_allowed` list) AND (data access time >= availability_start_timestamp) AND (data access time < availability_end_timestamp) | KeGovernanceTypedRegions | |
| averageFractionShow | Average fraction of podcast listened per show. Ignores duration < 10s. Computed offline | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| inClusterProb | Probability of a random user from this cluster listening to this podcast randomly (K-means specific feature) | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| surface | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String | |
| userLanguage | Language of shows in user history and how much they listened to each. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | list(SuperrootPodcastsRecommendationsPodcastRecsFeaturesUserLanguage) |
| durationTotalSecondsEpisode | Total duration listened for this episode by all users. Ignores duration < 10s. Computed offline | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| nicheLift | Per cluster lift where the lift_squashing_factor is set to +2 | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| negativeReactionBoostScore | boost score from the similarity between the candidate and the shows with user negative feedback, currently the score will be applied directly to the final ranking score: go/podcast-reaction-reranking-v1, but can be used as reranker model feature in the future. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | number |
| trendingScorePercent | Show level trending score percent from Wernicke corpus. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| feedPagerank | Scaled pagerank score for the feed url in [0..1]. Not to be confused with pagerank above, which measures the pagerank for the feed’s homepage. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| episodesPublishedPerMonth | How frequently are podcasts published by this show. To see publishing frequency calculation go here: http://shortn/_6zzfyEpBRq | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| fractionTotalShow | Some of all fraction of this show listened by users. Ignores duration < 10s. Computed offline | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| linkOwnershipVerified | Ownership verification status for the episode page URL. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | boolean |
| colistenedShowColistenAffinity | This captures the probability that this show could have been listened by the user in lieu of what they have subscribed or listened to. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | number |
| listenedShowListeningAffinity | This captures the fraction of total listening time accounted for by this show. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | number |
| csaiScore | Score of csai safe search score go/safesearch | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| categoryMatch | category_match is a 0 to 1 score depicting how much of the user’s listening history matches the categories of this podcast recommendation. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| peFractionScoreEpisode | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | number | |
| popularLift | Per cluster lift where the lift_squashing_factor is set to -3 | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| mediumUserListeningWebrefSimilarity | Match score between user listening mids and episode webref entities, where the listening is limited to last two mohths activity. Values are in a 0.0 to 1.0 range. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| convAiToxicitySevereScore | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | number | |
| subscribedShowListeningAffinity | This captures the fraction of total listening time accounted for by this subscribed show. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | number |
| dnnShowLevelRank | Ordinal rank features like this have been found to be useful in Hermione Recipes, where the top ranked items from a candidate generator is always retained. Ranks are integral values starting with 1 for the highest affinity show. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| finalReactionBoostScore | final reaction boost score computed from positive_reaction_boost_score and negative_reaction_boost_score. The score will be applied as a multiplier on the ranking score to adjust the ranking. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | number |
| numUniqueListenersShow | From: indexing/speech/proto/colisten-matrix.proto Absolute number of unique listeners during the past month. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| vulgarScore | Score of vulgar safe search score go/safesearch | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| globalProb | Probability of a random user listening to this podcast randomly | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| userClusterDistance | The distance between user’s Anima embedding and the centroid of the cluster in k-means. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | number |
| showOnlyImpressions | Show only impressions. Doesn’t include shows of episode impressions. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| peListenScoreShow | Anima User Embedding based features. Dot product of Anima User Embedding and podcast embeddings from UserEmbeddingBasedSignals (podcasts/quality/proto/ranking_signals.proto) | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | number |
| kmeansShowLevelRank | Ranks are integral values starting with 1 for the highest affinity show. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| listenTimeMin | Number of minutes of podcasts listened by the user | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | integer |
| showImpressionsPastWeek | Number of show impressions during the past week. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| episodeImpressions | Number of all episode impressions. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| showBaseQuality | Base quality of the document, used as a multiplier for the query-specific score. Should be in [0, 1] range. See: http://g3doc/indexing/moonshine/generic/g3doc/doc/scoring | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| pornScore | Score of porn safe search score go/safesearch | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| isCanonical | A binary value based on whether this is a canonical source for a cluster. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | boolean |
| averageDurationSecondsEpisode | Average duration listened per episode. Ignores duration < 10s. Computed offline | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| peListenTotalScoreShow | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | number | |
| fractionTotalEpisode | Some of all fraction of this listened by users. Ignores duration < 10s. Computed offline | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| showPopularRank | Expresses the absolute popularity rank within all documents. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| durationTotalSecondsShow | Total duration listened for this show by all users. Ignores duration < 10s. Computed offline | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| subscriptionShowLevelRank | The rank of the show in the subscription candidate generator. Ranks are integral values starting with 1 for the highest subscribed affinity show. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| peDurationScoreEpisode | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | number | |
| longUserListeningWebrefSimilarity | Match score between user listening mids and episode webref entities, where the listening can have happened at any time in the past. Values are in a 0.0 to 1.0 range. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| spoofScore | Score of spoof safe search score go/safesearch | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| fringeScore | Score of fringe safe search score go/safesearch | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| clusterFeedMinutes | The total minutes listened to this podcast show by users in this cluster | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| peListenScoreEpisode | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | number | |
| locationFeatureId | Feature ID of a location. For more info, see go/feature-id. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| dnnV2aScore | Dot product of user embedding and podcast show embedding from the two tower model v2a | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | number |
| numListens | Number of podcasts listened by the user | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | integer |
| balancedLift | Per cluster lift where the lift_squashing_factor is set to 0.4 | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| peDurationScoreShow | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | number | |
| rankPercentContrib | rank_percent_contrib = 100 / ( 1 + rank_percent ) Here rank_percent was derived from show level data in Wernicke corpus So if rank_percent of a feed was 3, then the feature value would be: 100 / (1 + 3) = 25. This indicator falls off quickly from 100 to almost 1 as we go from rank_percent 0 to 100. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| showImpressions | Number of show episode impressions. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| secondsSincePublication | A reranking feature showing the age of the episode that is being recommended. This is computed as (current time – publication_time) publication_time of the episode is defined: (http://shortn/_S46Ouk5ZWW) publication_time is specified as seconds since Unix Epoch. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| showLanguage | Language of the show from show data. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| userInterestsSalientSimilarity | Match score between user interest mids and episode salient entities. in a 0.0 to 1.0 range. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| positiveReactionBoostScore | boost score from the similarity between the candidate and the shows with user positive feedback, currently the score will be applied directly to the final ranking score: go/podcast-reaction-reranking-v1, but can be used as reranker model feature in the future. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | number |
| peFractionScoreShow | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | number | |
| recentUserListeningWebrefSimilarity | Match score between user listening mids and episode webref entities, where the listening is limited to recent activity. Values are in a 0.0 to 1.0 range. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| numListenersInKmeansCluster | The number of users in this k-means cluster. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| ulpLanguage | Inferred language preferences of the user with their probabilities. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | list(SuperrootPodcastsRecommendationsPodcastRecsFeaturesUserLanguage) |
| episodeDurationSec | The duration of a single episode, in seconds. – For show documents, this is a duration of a typical recent episode, or an approximation thereof. – For episode documents, this is the duration of the episode itself. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| medicalScore | Score of medical safe search score go/safesearch | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| peFractionTotalScoreEpisode | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | number | |
| explicitShow | Whether the show is marked as explicit by the authors | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| averageFractionEpisode | Average fraction of podcast listened per episode. Ignores duration < 10s. Computed offline | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| showOnlyImpressionsPastWeek | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String | |
| queryLanguage | This is the language extracted from the query_language. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| peDurationTotalScoreEpisode | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | number | |
| peDurationTotalScoreShow | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | number | |
| listenedShowLevelRank | The rank of the show in the top listened shows candidate generator. Ranks are integral values starting with 1 for the highest affinity show. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| peListenTotalScoreEpisode | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | number | |
| numListenersToShowInKmeansCluster | The number of users in the k-means cluster who have listened to this feed. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| episodeImpressionsPastWeek | Number of episode impressions during the past week. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| languageMatch | How much of user listening history match the language of this episode | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| rank | The index in the list of most popular podcasts. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| ulpLanguageMatch | How much of ulp match the language of this episode | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | number |
| numSubscribersShow | From: indexing/speech/proto/colisten-matrix.proto The number of subscribers for this podcast series. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| peFractionTotalScoreShow | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | number | |
| userInterestsWebrefSimilarity | Match score between user interest mids and episode webref entities. in a 0.0 to 1.0 range. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| colistenedShowLevelRank | This captures the rank of the podcast show in the colisten candidate generator. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| averageDurationSecondsShow | Average duration listened per show. Ignores duration < 10s. Computed offline | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | String |
| violenceScore | Score of violence safe search score go/safesearch | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| dnnV2aScoreSigmoid | Sigmoid of the score obtained by dot product of user embedding and show embedding. See https://b.corp.google.com/issues/158602034#comment2 for intuition. | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | number |
| offensiveScore | Score of offensive safe search score go/safesearch | SuperrootPodcastsRecommendationsPodcastRecsFeatures | LINT.IfChange Next ID: 101 | float |
| lang | SuperrootPodcastsRecommendationsPodcastRecsFeaturesUserLanguage | String | ||
| score | SuperrootPodcastsRecommendationsPodcastRecsFeaturesUserLanguage | number | ||
| areaCode | The local “area code”, if there is such a concept. | TelephoneNumber | String | |
| countryCode | The international direct dialing code for the country, as per ITU E.164: http://www.itu.int/itudoc/itu-t/ob-lists/icc/e164_763.html | TelephoneNumber | integer | |
| extension | Extension (to be dialed after connection). | TelephoneNumber | String | |
| nationalPrefix | To call this number from within the same country, the national call prefix may be necessary. This is 1 in the US, 0 in the UK, etc. In the US, it’s reasonable to omit the leading 1 when writing the number, but in other countries it is less optional. | TelephoneNumber | String | |
| number | The actual number, broken down into sections as per local convention. Note that the actual formatting of these sections (hyphen vs space, usage of parentheses) will vary according to local custom. | TelephoneNumber | list(String) | |
| attachment | TeragoogleDocumentInfo | The docshards are a FlatSSTable from (64-bit) urlfp to data containing the information found in this protocol buffer. (It’s not actually one of these PBs for various performance reasons; instead, the DocumentFormat class handles serialization and deserialization in our own way) Next available ID: 37 | list(TeragoogleDocumentInfoAttachment) | |
| averageTermWeight | The average weight of terms in the document. If not available, there will be no term weight averaging: font sizes will be taken literally from the document HTML. | TeragoogleDocumentInfo | The docshards are a FlatSSTable from (64-bit) urlfp to data containing the information found in this protocol buffer. (It’s not actually one of these PBs for various performance reasons; instead, the DocumentFormat class handles serialization and deserialization in our own way) Next available ID: 37 | integer |
| doc | The document itself. If present, the docservers parse the contents to create a mustang repository. | TeragoogleDocumentInfo | The docshards are a FlatSSTable from (64-bit) urlfp to data containing the information found in this protocol buffer. (It’s not actually one of these PBs for various performance reasons; instead, the DocumentFormat class handles serialization and deserialization in our own way) Next available ID: 37 | GDocumentBase |
| extendedDocid | The serialized ExtendedDocId, needed to construct a proper docinfo response if the docinfo request is missing it and it’s present. | TeragoogleDocumentInfo | The docshards are a FlatSSTable from (64-bit) urlfp to data containing the information found in this protocol buffer. (It’s not actually one of these PBs for various performance reasons; instead, the DocumentFormat class handles serialization and deserialization in our own way) Next available ID: 37 | String |
| globalDocid | the global docid, we need it in the docservers (Continuum mode) to construct proper docinfo response when the docinfo request does not contain a valid global docid | TeragoogleDocumentInfo | The docshards are a FlatSSTable from (64-bit) urlfp to data containing the information found in this protocol buffer. (It’s not actually one of these PBs for various performance reasons; instead, the DocumentFormat class handles serialization and deserialization in our own way) Next available ID: 37 | String |
| originalEncoding | If the original encoding isn’t UTF8 | TeragoogleDocumentInfo | The docshards are a FlatSSTable from (64-bit) urlfp to data containing the information found in this protocol buffer. (It’s not actually one of these PBs for various performance reasons; instead, the DocumentFormat class handles serialization and deserialization in our own way) Next available ID: 37 | integer |
| section | TeragoogleDocumentInfo | The docshards are a FlatSSTable from (64-bit) urlfp to data containing the information found in this protocol buffer. (It’s not actually one of these PBs for various performance reasons; instead, the DocumentFormat class handles serialization and deserialization in our own way) Next available ID: 37 | list(TeragoogleDocumentInfoSection) | |
| sectionType | Indicates format of ‘tokens’ field in all Section entries. | TeragoogleDocumentInfo | The docshards are a FlatSSTable from (64-bit) urlfp to data containing the information found in this protocol buffer. (It’s not actually one of these PBs for various performance reasons; instead, the DocumentFormat class handles serialization and deserialization in our own way) Next available ID: 37 | String |
| name | TeragoogleDocumentInfoAttachment | Misc. attachments to be added to the dynamic repository the docservers build. These override any attachments created by parsing the GDocumentBase. | String | |
| options | TeragoogleDocumentInfoAttachment | Misc. attachments to be added to the dynamic repository the docservers build. These override any attachments created by parsing the GDocumentBase. | TeragoogleRepositoryAttachmentOptions | |
| value | TeragoogleDocumentInfoAttachment | Misc. attachments to be added to the dynamic repository the docservers build. These override any attachments created by parsing the GDocumentBase. | String | |
| fieldName | List of field repository (subsection) names within the section. | TeragoogleDocumentInfoSection | Sections to be added to the dynamic repository the docservers build. ‘tokens’ is either a sequence of tokens encoded using the TokenSequenceEncoder (MDU), or a TokenspaceRepository (depends on what’s set in section_type. If ‘doc’ is present, then the contents of these sections override what was created by parsing ‘doc’. | list(String) |
| name | TeragoogleDocumentInfoSection | Sections to be added to the dynamic repository the docservers build. ‘tokens’ is either a sequence of tokens encoded using the TokenSequenceEncoder (MDU), or a TokenspaceRepository (depends on what’s set in section_type. If ‘doc’ is present, then the contents of these sections override what was created by parsing ‘doc’. | String | |
| tokens | TeragoogleDocumentInfoSection | Sections to be added to the dynamic repository the docservers build. ‘tokens’ is either a sequence of tokens encoded using the TokenSequenceEncoder (MDU), or a TokenspaceRepository (depends on what’s set in section_type. If ‘doc’ is present, then the contents of these sections override what was created by parsing ‘doc’. | String | |
| compression | TeragoogleRepositoryAttachmentOptions | Compression type to be applied to section/attachment. | String | |
| muppetTitleLengthInDeciems | Total max length of title in deciems | TitleSizeParams | Data related to title sizing calculations in Muppet. | integer |
| muppetTitleNumLines | Number of lines for title | TitleSizeParams | Data related to title sizing calculations in Muppet. | integer |
| VisitorsPastDay | Indicates how many distinct toolbar visitors this page had in the past day. Will only be present if the number is reasonably large. | ToolBarPerDocData | DO NOT USE THIS FOR ANYTHING LIVE WITHOUT PERMISSION! If you want to use this for anything user-facing file a logs-access ticket describing what you want to do. This data is currently only available in the freshdocs pipeline, so it will only be present in instant mustang and certain librarian shards. Email freshdocs-indexing with questions. | integer |
| alliance | STAR_ALLIANCE | TravelFlightsAirlineConfig | Next ID: 29 | String |
| baggageCarryonLimitationsUrls | Default url for baggage fee information. | TravelFlightsAirlineConfig | Next ID: 29 | TravelFlightsNameCatalogProto |
| baggageFeeUrls | Default url for baggage fee information. | TravelFlightsAirlineConfig | Next ID: 29 | TravelFlightsNameCatalogProto |
| countryCode | ISO 3166-1 alpha-2 country code in which this airline is domestic. | TravelFlightsAirlineConfig | Next ID: 29 | String |
| countryContactInfo | LocalizedContactInfo allows localization by country and language. Once the data is ready, we will start filling both fields. After that the old field will be deprecated and deleted at some point. | TravelFlightsAirlineConfig | Next ID: 29 | list(TravelFlightsAirlineConfigCountryContactInfo) |
| dupFlag | true, if this carrier’s IATA code is a “controlled duplicate” (goto/controlled-duplicate). | TravelFlightsAirlineConfig | Next ID: 29 | boolean |
| fareFamilyUrls | TravelFlightsAirlineConfig | Next ID: 29 | TravelFlightsNameCatalogProto | |
| fqtvPartnerCode | IATA codes of airlines who this airline’s travel can be credited to for mileage accrual. | TravelFlightsAirlineConfig | Next ID: 29 | list(String) |
| greenFaresInfo | TravelFlightsAirlineConfig | Next ID: 29 | TravelFlightsAirlineConfigGreenFaresInfo | |
| iataCode | Note that some iata_codes are reused (`dup_flag` field). For details, including how to resolve collisions for airlines shown in Google Flights, see: go/controlled-duplicate go/flights-data/airlines#resolving-iata-code-collisions cs/go/controlled-duplicate U2 – some have no IATA code | TravelFlightsAirlineConfig | Next ID: 29 | String |
| icaoCode | EZY – some have no ICAO code | TravelFlightsAirlineConfig | Next ID: 29 | String |
| innovataCode | U2! – with optional dedup sign (‘!’) | TravelFlightsAirlineConfig | Next ID: 29 | String |
| localizedContactInfo | TravelFlightsAirlineConfig | Next ID: 29 | list(TravelFlightsAirlineConfigLocalizedContactInfo) | |
| mid | Note: fields #16 and #17 are ununused. The identifier of the airline, e.g. /m/07y2s for United Populated using airlines_mids.csv. | TravelFlightsAirlineConfig | Next ID: 29 | String |
| names | EasyJet/イージージェット | TravelFlightsAirlineConfig | Next ID: 29 | TravelFlightsNameCatalogProto |
| passengerAssistanceUrls | Default url for passenger assistance information. | TravelFlightsAirlineConfig | Next ID: 29 | TravelFlightsNameCatalogProto |
| popularity | Number of flights with this airline over the next 180 days. | TravelFlightsAirlineConfig | Next ID: 29 | integer |
| shortNames | KLM – instead of ‘KLM Royal Dutch Airlines’ | TravelFlightsAirlineConfig | Next ID: 29 | TravelFlightsNameCatalogProto |
| sustainabilityProgramUrls | URLs for airlines’ sustainability programs. | TravelFlightsAirlineConfig | Next ID: 29 | TravelFlightsNameCatalogProto |
| type | TravelFlightsAirlineConfig | Next ID: 29 | String | |
| urls | http://www.airfrance.us/ | TravelFlightsAirlineConfig | Next ID: 29 | TravelFlightsNameCatalogProto |
| waiverSummaryUrls | Default url for waiver information. | TravelFlightsAirlineConfig | Next ID: 29 | TravelFlightsNameCatalogProto |
| data | Typically, formatted phone number. | TravelFlightsAirlineConfigContactInfo | String | |
| type | TravelFlightsAirlineConfigContactInfo | String | ||
| contactInfo | TravelFlightsAirlineConfigCountryContactInfo | Airline contact info grouped by country. | list(TravelFlightsAirlineConfigContactInfo) | |
| countryCode | Two char country code, e.g. “US” | TravelFlightsAirlineConfigCountryContactInfo | Airline contact info grouped by country. | String |
| bonusMilesProgramName | TravelFlightsAirlineConfigGreenFaresInfo | String | ||
| bonusMilesQuantity | TravelFlightsAirlineConfigGreenFaresInfo | String | ||
| bonusMilesQuantityType | TravelFlightsAirlineConfigGreenFaresInfo | String | ||
| bonusMilesType | TravelFlightsAirlineConfigGreenFaresInfo | String | ||
| contributionFraming | TravelFlightsAirlineConfigGreenFaresInfo | String | ||
| contactInfo | TravelFlightsAirlineConfigLocalizedContactInfo | Airline contact info grouped by language. The language locale subcode will determine the country. | list(TravelFlightsAirlineConfigContactInfo) | |
| language | IETF BCP-47, e.g. “en” or “zh-HK-Hant” | TravelFlightsAirlineConfigLocalizedContactInfo | Airline contact info grouped by language. The language locale subcode will determine the country. | String |
| language | TravelFlightsNameCatalogEntry | String | ||
| text | TravelFlightsNameCatalogEntry | String | ||
| name | TravelFlightsNameCatalogProto | list(TravelFlightsNameCatalogEntry) | ||
| DelegatedProjectName | Project delegation name to support bandwidth enforcement. Harpoon will call SetDelegatedUser() with the specified DelegatedProjectName and a domain associated with the RequestorID provided in the client capatibility file. | TrawlerClientServiceInfo | ClientServiceInfo is meant for trawler/harpoon clients which are in turn services to store some data specific to their clients. E.g., Kodachrome may serve multiple other clients. In this case they can store their client name here. Webmirror may also store the feed name here even though a feed is technically not a service client. ClientServiceInfo is in nature similar to ClientInfo, except it’s stored in FetchReplyData (i.e., trawler logs), whereas ClientInfo is copied to FetchReply (outside FetchReplyData), thus it’s not stored in trawler logs. | String |
| ServiceClientID | TrawlerClientServiceInfo | ClientServiceInfo is meant for trawler/harpoon clients which are in turn services to store some data specific to their clients. E.g., Kodachrome may serve multiple other clients. In this case they can store their client name here. Webmirror may also store the feed name here even though a feed is technically not a service client. ClientServiceInfo is in nature similar to ClientInfo, except it’s stored in FetchReplyData (i.e., trawler logs), whereas ClientInfo is copied to FetchReply (outside FetchReplyData), thus it’s not stored in trawler logs. | String | |
| clientLabels | TrawlerClientServiceInfo | ClientServiceInfo is meant for trawler/harpoon clients which are in turn services to store some data specific to their clients. E.g., Kodachrome may serve multiple other clients. In this case they can store their client name here. Webmirror may also store the feed name here even though a feed is technically not a service client. ClientServiceInfo is in nature similar to ClientInfo, except it’s stored in FetchReplyData (i.e., trawler logs), whereas ClientInfo is copied to FetchReply (outside FetchReplyData), thus it’s not stored in trawler logs. | list(TrawlerClientServiceInfoClientLabels) | |
| name | TrawlerClientServiceInfoClientLabels | ClientLabels contains client-specified key/value pairs, used to annotate individual FetchRequests and FetchReplies. This is primarily useful when the Multiverse Nexus performs postprocessing of fetchreplies. ClientLabels essentially allow clients to use the Nexus UI to slice statistics computed on fetchreplies by the specified key/value pairs. Note: we don’t use “map” type here delibrately in order to avoid the non-deterministric serialization of the “map” field. See b/69064361 for more details. | String | |
| values | TrawlerClientServiceInfoClientLabels | ClientLabels contains client-specified key/value pairs, used to annotate individual FetchRequests and FetchReplies. This is primarily useful when the Multiverse Nexus performs postprocessing of fetchreplies. ClientLabels essentially allow clients to use the Nexus UI to slice statistics computed on fetchreplies by the specified key/value pairs. Note: we don’t use “map” type here delibrately in order to avoid the non-deterministric serialization of the “map” field. See b/69064361 for more details. | list(String) | |
| value | TrawlerClientServiceInfoClientLabelsClientLabelValues | !ERROR! D12386 -> Formula Error: An unexpected error occurred | list(String) | |
| EndPos | TrawlerContentRangeInfo | Parsed version of a Content-Range field, which in http might look like: Content-Range: bytes 500-999/3156 | String | |
| StartPos | In ContentRange, the first byte is 0 (rather than 1), and the positions are inclusive. Thus, length is EndPos+1-StartPos | TrawlerContentRangeInfo | Parsed version of a Content-Range field, which in http might look like: Content-Range: bytes 500-999/3156 | String |
| TotalLength | TrawlerContentRangeInfo | Parsed version of a Content-Range field, which in http might look like: Content-Range: bytes 500-999/3156 | String | |
| NotChangedTimeMs | fetched from the web. Time when the page was last | TrawlerCrawlTimes | This is similar to CrawlDates group in FetchReplyData, except that 1) it’s a message; 2) it’s filled in each Redirects hop; and 3) the timestamps are in ms rather than seconds since Unix Epoch. | String |
| OriginalCrawlTimeMs | Time when the page was | TrawlerCrawlTimes | This is similar to CrawlDates group in FetchReplyData, except that 1) it’s a message; 2) it’s filled in each Redirects hop; and 3) the timestamps are in ms rather than seconds since Unix Epoch. | String |
| ReuseTimeMs | checked but found to be the same as before. If set, timestamp to indicate | TrawlerCrawlTimes | This is similar to CrawlDates group in FetchReplyData, except that 1) it’s a message; 2) it’s filled in each Redirects hop; and 3) the timestamps are in ms rather than seconds since Unix Epoch. | String |
| ID | TrawlerEvent | Event is for logging interesting events that happen during a url fetch. Interesting events include “fetch start”, “url rejected”, etc. The events are written to binary logs together with the request and reply messages. If the same event occurs multiple times consecutively, We record the time of the first three instances in EarliestTimeStamp but omit the rest. We keep track the total number of occurrences in NumOccurrences and the timestamp of the last occurrence is kept in TimeStamp field. | String | |
| Msg | TrawlerEvent | Event is for logging interesting events that happen during a url fetch. Interesting events include “fetch start”, “url rejected”, etc. The events are written to binary logs together with the request and reply messages. If the same event occurs multiple times consecutively, We record the time of the first three instances in EarliestTimeStamp but omit the rest. We keep track the total number of occurrences in NumOccurrences and the timestamp of the last occurrence is kept in TimeStamp field. | String | |
| NumOccurrences | TrawlerEvent | Event is for logging interesting events that happen during a url fetch. Interesting events include “fetch start”, “url rejected”, etc. The events are written to binary logs together with the request and reply messages. If the same event occurs multiple times consecutively, We record the time of the first three instances in EarliestTimeStamp but omit the rest. We keep track the total number of occurrences in NumOccurrences and the timestamp of the last occurrence is kept in TimeStamp field. | integer | |
| OldestTimeStampInUS | Limited to 3. | TrawlerEvent | Event is for logging interesting events that happen during a url fetch. Interesting events include “fetch start”, “url rejected”, etc. The events are written to binary logs together with the request and reply messages. If the same event occurs multiple times consecutively, We record the time of the first three instances in EarliestTimeStamp but omit the rest. We keep track the total number of occurrences in NumOccurrences and the timestamp of the last occurrence is kept in TimeStamp field. | list(String) |
| TimeStampInUS | TrawlerEvent | Event is for logging interesting events that happen during a url fetch. Interesting events include “fetch start”, “url rejected”, etc. The events are written to binary logs together with the request and reply messages. If the same event occurs multiple times consecutively, We record the time of the first three instances in EarliestTimeStamp but omit the rest. We keep track the total number of occurrences in NumOccurrences and the timestamp of the last occurrence is kept in TimeStamp field. | String | |
| compression | TrawlerFetchBodyData | String | ||
| content | TrawlerFetchBodyData | String | ||
| uncompressedSize | Size hint. Set if compression != NO_COMPRESSION | TrawlerFetchBodyData | String | |
| CrawlTimes | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | TrawlerCrawlTimes | |
| ThrottleClient | If present, Client API will enforce the contained constraints | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | TrawlerThrottleClientData |
| DNSHost | Sometimes the hostid and destination IP in the FetchReplyData are not for the hostname in the url. If that’s the case DNSHost will be the host that we have used when resolving hostid and DNS. Right now there are two cases: (1) malware team provides a proxy IP:Port to us, so DNSHost will be the proxy IP; and (2) PSS team provides a reference DNS host; so DNSHost will be the reference DNS host. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| HostBucketData | Data about the host bucket this request is in (if desired) Please talk with Trawler team before considering using this, since what we fill in here is subject to change. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | TrawlerHostBucketData |
| DownloadTime | The download time for this fetch (ms). This is the RTT time between fetcher and HOPE, note it does not include time from redirects, just initial hop. If you want the sum of the DownloadTime values for all fetches in the redirect chain, then use the DownLoadTime value in the FetchStats. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | integer |
| partialresponse | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | TrawlerFetchReplyDataPartialResponse | |
| ID | Same as the ID of the matching request (used for matching internal fetchclient data in request/reply) | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| originalProtocolUrl | If the input url in FetchRequest is Amazon S3 protocol or Apple Itunes protocol, we will translate it into https url and log it as https url. In the meantime we will store the original s3/itunes url in this field. Before sending back to client, the Url will be translated back to s3 and this field will be cleard. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| FlooEgressRegion | If present, fetch was conducted using floonet and this is the location of floonet egress point we used. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| UseHtmlCompressDictionary | Use the special compression dictionary for uncompressing this. (trawler::kHtmlCompressionDict. Use trawler::FetchReplyUncompressor to uncompress; crawler/trawler/public/fetchreply-util.h) | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | boolean |
| Events | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | list(TrawlerEvent) | |
| HTTPTrailers | The received HTTP trailers if available. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | list(TrawlerFetchReplyDataHTTPHeader) |
| webioInfo | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | TrawlerFetchReplyDataWebIOInfo | |
| Endpoints | ——- If fetched, the IP from which we fetched, as well as source IP and ports. It is recommended to use trawler::DestinationIP()/HasDestinationIP() accessors, which return a proper IPAddress. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | TrawlerTCPIPInfo |
| GeoCrawlEgressRegion | If present, the last hop of the fetch was conducted using floonet and this is the location of floonet egress point. It is different from EgressRegion and FlooEgressREgion because it is a Trawler transparent routing configured in the geo crawl rules(go/da-geo-crawl). | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| HSTSInfo | Set to: o HSTS_STATUS_NONE if there was no HSTS policy match for the URL’s host. o HSTS_STATUS_AVAILABLE if there was an HSTS policy, but the URL was not rewritten from HTTP to HTTPS because enable_hsts was not set in client capability config. o HSTS_STATUS_REWRITTEN if the HSTS policy was followed and url was rewritten from HTTP to HTTPS. This field only pertains to the current URL fetch and does not explain a redirect’s HSTS status. However, FetchReplyData.Redirects have their own HSTSInfo. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| FetchPatternFp | With the introduction of fetch pattern based hostload exceptions, one hostid may have multiple hostload buckets, each with its own hostload. In this case, FetchPatternFp will be set to identify the hostload bucket within the hostid. Note this field is only meaningful for the HostBucketData which is recorded only when the client requests to have as part of reply. However, this field is useful for certain stats gathering, so we choose to always record it if its value is available during the fetch. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| UrlEncoding | Encoding info for the original url itself. Bitfield encoding; see UrlEncoding::{Set,Get}Value in webutil/urlencoding. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | integer |
| PostData | If the fetch uses HTTP POST, PUT, or PATCH protocol, and WantPostData is true, the POST data will be copied here. This is only for initial hop. If there are redirects, HTTP POST will be changed to GET on subsequent hops, and the PostData will be cleared. There is only one exception, if the HTTP response code to the POST request is 307 (a new code introduced in RFC7321, sec. 6.4.7), we will preserve the request method and the PostData for the next hop. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| TransparentRewrites | If the url got rewriten by transparent rewrites, here it is the series of rewrites it got through. The fetched one is the last | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | list(String) |
| HopCacheKeyForUpdate | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String | |
| GeoCrawlFallback | Whether we fallback from geo crawl to local crawl during fetch. The fallback could happen in any hops and there can be at most one fallback because once fallback happens, we will not try geo-crawl anymore. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | boolean |
| ReuseInfo | ——– Returns trawler::ReuseInfo with status of IMS/IMF/cache query. Consider using HopReuseInfo instead, which has per-redirect hop detail. If there’s URL redirection, this field stores the reuse info of the last hop. For example, if the and URL redirect chain is [URL A] –> [URL B] –> [URL C], this field stores the reuse info of [URL C]. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| TimestampInMS | When this reply came back from fetcher NOTE: TimestampInMS is used for internal debugging. To see when a document was crawled, check CrawlDates. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| CompressedBody | Is the associated body compressed ? | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | boolean |
| HttpResponseHeaders | HTTP headers from the response (initial hop). Trawler does not fill this in; this is intended as a placeholder for crawls like webmirror that fill in and want to track this across redirect hops. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| RedirectSourceFetchId | If this fetch was a result of a redirect, we populate the parent ID here. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| RobotsStatus | Status of the robots.txt fetch. Currently, this is present if: – Certain robots error cases, such as URL_TIMEOUT-TIMEOUT_ROBOTS or URL_UNREACHABLE-UNREACHABLE_ROBOTS_ERROR. – If WantRobotsBody is set in the FetchParams. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | TrawlerFetchStatus |
| trafficType | Traffic type of this fetch. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| HostId | If known, the trawler::HostId that identifies the host (initial hop). | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| HopRobotsInfo | Extra information in robots.txt for this page (integer: or’ed together of type trawler::RobotsInfo) on a per-hop basis (initial hop) | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | integer |
| TotalFetchedSize | How many raw bytes we read from the connection to the server when we fetched the page. Includes everything: HTTP headers, overhead for HTTP chunked encoding, whatever compressed/uncompressed form (i.e. gzip/deflate accept-encoding) the content was sent in, etc. This is NOT the same as the size of the uncompressed FetchReply::Body – if the webserver used gzip encoding, this value might be much smaller, since it only counts the compressed wire size. To illustrate, think of 3 sizes: 1) TotalFetchedSize – amount Trawler read over the wire from the server. If they used gzip/deflate, this might be 4-5x smaller than the body. 2) UnTruncatedSize/CutoffSize – how big is the full document, after uncompressing any gzip/deflate encoding? If truncated, this is reflected in CutoffSize. 3) FetchReply::Body size – most crawls enable Trawler compression to save storage space (gzip + a google html dictionary). The body size that the end Trawler client sees is post-compression. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| GeoCrawlLocationAttempted | Set only when GeoCrawlFallback is true. Logs the geo crawl location we attempted but failed for this request. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| HttpVersion | Stores the HTTP version we used in the final hop. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| HopCacheKeyForLookup | Returns the cache key used when doing cache lookup/update, on a per-hop basis (initial hop) Note this field will not be set if cache lookup/update is disabled/skipped. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| EgressRegion | If present, the edge region that we have used. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| RobotsInfo | Extra information in robots.txt for this page (ORed together bits from trawler::RobotsInfo). e.g. nosnippet vs. noarchive vs nofollow vs noindex vs disallow Consider using HopRobotsInfo instead, which has per-redirect hop detail. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | integer |
| HopReuseInfo | Returns trawler::ReuseInfo with status of IMS/IMF/cache query, on a per-hop basis (initial hop) For example, if the URL redirect chain is [URL A] –> [URL B] –> [URL C], this field stores the reuse info of [URL A]. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| RequestorIPAddressPacked | Machine that sent Trawler this request, for logging. An IPAddress object, packed as a string. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| redirects | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | list(TrawlerFetchReplyDataRedirects) | |
| ProtocolVersionFallback | Whether we fallback from HTTP/2 to HTTP/1.1 during fetch. The fallback could happen in any hops and there can be at most one fallback because once fallback happens, we will not try HTTP/2 anymore. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | boolean |
| BadSSLCertificate | This field, if non-empty, contains the SSL certificate chain from the server. The filed should be serialized SSLCertificateInfo protobuf, although it used to be text format. Hence, one should ideally use trawler::CertificateUtil to check this field and understand in more detail. This field is populated in two cases: (1) something is wrong with the server certificate and we cannot verify the server’s identity. In this case the URL most likely won’t display in a browser; (2) if you turned on WantSSLCertificateChain in the FetchRequest. In this case the server certificate may be perfectly fine (despite the field name). This is for the initial hop; additional hops are in Redirects group. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| ClientServiceInfo | Some client specific data that’s set by client in the FetchRequest, and we just copy it here verbatim. This is similar to ClientInfo that we copy from FetchRequest to FetchReply, but this is copied to FetchReplyData, thus stored in trawler logs so can be useful for debugging cases. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | TrawlerClientServiceInfo |
| deliveryReport | Transfer operation detailed report. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | TrawlerFetchReplyDataDeliveryReport |
| Url | The original url in the request we are answering. Even though “optional,” url must be filled in on all well-formed replies. Trawler guarantees that it is filled in, and basically every client expects it (CHECKs in some cases). -> Not filling this field in is a bug, if you share this data with other crawls/pipelines. You should expect everybody else to require a url. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| ThrownAwayBytes | Sometimes we throw away content because we cannot store it in the internal buffers. These is how many bytes we have thrown away for this factor. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| HttpRequestHeaders | The HTTP headers we sent to fetch this URL (initial hop). Not normally filled in, unless FetchParams.WantSentHeaders is set. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| LastUrlStatus | Crawl status of the last url on chain | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | TrawlerFetchStatus |
| protocolresponse | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | TrawlerFetchReplyDataProtocolResponse | |
| EligibleGeoCrawlEgressRegion | If present, it means this host might be eligible for geo crawl. However, this does not mean we enable geo-crawl for this request. Check “GeoCrawlEgressRegion” instead to see if this fetch is conducted via geo crawl. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| Status | Status of the fetch – refers to the final status at the end of the redirect chain. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | TrawlerFetchStatus |
| RequestorID | RequestorId is the same on as in the request that triggers this reply — mainly for diagnostics purpose | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| TrawlerPrivate | For logging only; not present in the actual fetcher response | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | TrawlerTrawlerPrivateFetchReplyData |
| crawldates | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | TrawlerFetchReplyDataCrawlDates | |
| PolicyData | Trawler can optionally add a policy label to a FetchReply. Some uses: – “spam” label via trawler_site_info – “roboted:googlebot” label as a signal to crawls supporting multiple useragents that it’s not safe to share the fetch replies with googlebot crawls. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | list(TrawlerPolicyData) |
| HttpProtocol | The http protocol we send to fetch this URL. This will only be set if the request is using http | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| PredictedDownloadTimeMs | This is available only if a fetch results in TIMEOUT_WEB, and we were able to predict, based on content length and bandwidth we were using, how much time (in ms) would be needed to download the entire content. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | integer |
| fetchstats | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | TrawlerFetchReplyDataFetchStats | |
| RobotsTxt | The robots.txt we used for this URL (initial hop). Not normally filled in unless WantRobotsBody is set. This is mostly for debugging purposes and should not be used for large volumes of traffic. | TrawlerFetchReplyData | Fetcher -> FetchClient FetchReplyData is the metadata for a reply from a FetchRequest. For metadata + document body, FetchReply is further below. NOTE: FetchReplyData (and FetchReply) is the output interface from Multiverse. Teams outside Multiverse/Trawler should not create fake FetchReplies. Trawler: When adding new fields here, it is recommended that at least the following be rebuilt and pushed: – cron_fetcher_index mapreduces: so that UrlReplyIndex, etc. retain the new fields – tlookup, tlookup_server: want to be able to return the new fields – logviewer, fetchutil: annoying to get back ‘tag88:’ in results ————————– Next Tag: 125 ———————– | String |
| NotChangedDate | fetched from the web. Timestamp indicates when | TrawlerFetchReplyDataCrawlDates | Reuse information returned if UrlState == CRAWLED, specifying when we may have reused from cache. See also ReuseInfo below. NOTE: Please use the CrawlTimes below. CrawlDates is deprecated. use CrawlTimes instead! | integer |
| OriginalCrawlDate | Timestamp when the page was | TrawlerFetchReplyDataCrawlDates | Reuse information returned if UrlState == CRAWLED, specifying when we may have reused from cache. See also ReuseInfo below. NOTE: Please use the CrawlTimes below. CrawlDates is deprecated. use CrawlTimes instead! | integer |
| ReuseDate | the page was last checked but found to be the same as before. If set, timestamp to indicate | TrawlerFetchReplyDataCrawlDates | Reuse information returned if UrlState == CRAWLED, specifying when we may have reused from cache. See also ReuseInfo below. NOTE: Please use the CrawlTimes below. CrawlDates is deprecated. use CrawlTimes instead! | integer |
| events | The events store the detail of messages (usually error). | TrawlerFetchReplyDataDeliveryReport | Depending on which Data Acquisition API the client uses, the fetched content can be delivered to the client in the RPC, via Goops, or copied to the client’s storage system (possibly after transformation). In the latter case, DeliveryReport will contain info about the delivery status, such as whether we have permission error, whether the destination storage is out of quota, etc). | list(TrawlerEvent) |
| filePath | The complete path (include the file name) of the file downloaded. For requests that require delivery, this path will be the user specified location. For requests that use Multiverse default storage, this path will be the managed by Multiverse. | TrawlerFetchReplyDataDeliveryReport | Depending on which Data Acquisition API the client uses, the fetched content can be delivered to the client in the RPC, via Goops, or copied to the client’s storage system (possibly after transformation). In the latter case, DeliveryReport will contain info about the delivery status, such as whether we have permission error, whether the destination storage is out of quota, etc). | String |
| status | Status of the transfer action. | TrawlerFetchReplyDataDeliveryReport | Depending on which Data Acquisition API the client uses, the fetched content can be delivered to the client in the RPC, via Goops, or copied to the client’s storage system (possibly after transformation). In the latter case, DeliveryReport will contain info about the delivery status, such as whether we have permission error, whether the destination storage is out of quota, etc). | String |
| BotOverheadMS | Overhead spent RPCing with the Bot/proxy. | TrawlerFetchReplyDataFetchStats | The fetcher keeps track of various time intervals spent in the states of the fetcher url control flow. Sometimes flows branch out into more than one flow (next flow), and we aggregate all the time intervals spent in a specific state for all the flows to get the time interval for the state. The time interval for a state is therefore not the time interval of an individual flow, if the WaitNextFlow time is non zero. The WaitNextFlow interval included here is the time spent by one flow waiting for another flow. Although the WaitNextFlow time is the time spent by a flow in the WaitNextFlow state, its also equivalent to the entire timeline of another flow. It is the time spent in the various states of another flow. In computing the total time spent in the primary flow, one must omit the WaitNextFlow time, since it is already included in the form of slices of individual state time intervals in the aggregated time intervals for other states, and will result in double counting. | integer |
| ClientControlflowStats | TrawlerFetchReplyDataFetchStats | The fetcher keeps track of various time intervals spent in the states of the fetcher url control flow. Sometimes flows branch out into more than one flow (next flow), and we aggregate all the time intervals spent in a specific state for all the flows to get the time interval for the state. The time interval for a state is therefore not the time interval of an individual flow, if the WaitNextFlow time is non zero. The WaitNextFlow interval included here is the time spent by one flow waiting for another flow. Although the WaitNextFlow time is the time spent by a flow in the WaitNextFlow state, its also equivalent to the entire timeline of another flow. It is the time spent in the various states of another flow. In computing the total time spent in the primary flow, one must omit the WaitNextFlow time, since it is already included in the form of slices of individual state time intervals in the aggregated time intervals for other states, and will result in double counting. | TrawlerFetchReplyDataFetchStatsClientStateStats | |
| ConnectTimeMs | Report only with first request on connection, so that we keep track of the connect time with a host. Sometimes a connection is initiated by a prior request that times out before the connection is established. Another request can get scheduled on a connection that is already in the process of being established but has no request scheduled onto it. We want to keep track of the entire connect time even if a request didn’t need to wait for the entire connection establishment time. Sometimes a connection may get established before the first request uses it. We tag along the connect time with the first request using the connection. ConnectTimeMs also includes SSL negotiation time. | TrawlerFetchReplyDataFetchStats | The fetcher keeps track of various time intervals spent in the states of the fetcher url control flow. Sometimes flows branch out into more than one flow (next flow), and we aggregate all the time intervals spent in a specific state for all the flows to get the time interval for the state. The time interval for a state is therefore not the time interval of an individual flow, if the WaitNextFlow time is non zero. The WaitNextFlow interval included here is the time spent by one flow waiting for another flow. Although the WaitNextFlow time is the time spent by a flow in the WaitNextFlow state, its also equivalent to the entire timeline of another flow. It is the time spent in the various states of another flow. In computing the total time spent in the primary flow, one must omit the WaitNextFlow time, since it is already included in the form of slices of individual state time intervals in the aggregated time intervals for other states, and will result in double counting. | integer |
| ControlflowStats | TrawlerFetchReplyDataFetchStats | The fetcher keeps track of various time intervals spent in the states of the fetcher url control flow. Sometimes flows branch out into more than one flow (next flow), and we aggregate all the time intervals spent in a specific state for all the flows to get the time interval for the state. The time interval for a state is therefore not the time interval of an individual flow, if the WaitNextFlow time is non zero. The WaitNextFlow interval included here is the time spent by one flow waiting for another flow. Although the WaitNextFlow time is the time spent by a flow in the WaitNextFlow state, its also equivalent to the entire timeline of another flow. It is the time spent in the various states of another flow. In computing the total time spent in the primary flow, one must omit the WaitNextFlow time, since it is already included in the form of slices of individual state time intervals in the aggregated time intervals for other states, and will result in double counting. | TrawlerFetchReplyDataFetchStatsStateStats | |
| DownLoadTime | DownLoadTime = Share of connect time + ServerResponseTimeMs + TransferTimeMs (see below) in ms | TrawlerFetchReplyDataFetchStats | The fetcher keeps track of various time intervals spent in the states of the fetcher url control flow. Sometimes flows branch out into more than one flow (next flow), and we aggregate all the time intervals spent in a specific state for all the flows to get the time interval for the state. The time interval for a state is therefore not the time interval of an individual flow, if the WaitNextFlow time is non zero. The WaitNextFlow interval included here is the time spent by one flow waiting for another flow. Although the WaitNextFlow time is the time spent by a flow in the WaitNextFlow state, its also equivalent to the entire timeline of another flow. It is the time spent in the various states of another flow. In computing the total time spent in the primary flow, one must omit the WaitNextFlow time, since it is already included in the form of slices of individual state time intervals in the aggregated time intervals for other states, and will result in double counting. | integer |
| EdgeEgressOverheadMs | Overhead spent routing the request from HOPE to edge egress nodes, which open connection to webservers. This is only set for edge fetches (e.g., through Floonet egress nodes). | TrawlerFetchReplyDataFetchStats | The fetcher keeps track of various time intervals spent in the states of the fetcher url control flow. Sometimes flows branch out into more than one flow (next flow), and we aggregate all the time intervals spent in a specific state for all the flows to get the time interval for the state. The time interval for a state is therefore not the time interval of an individual flow, if the WaitNextFlow time is non zero. The WaitNextFlow interval included here is the time spent by one flow waiting for another flow. Although the WaitNextFlow time is the time spent by a flow in the WaitNextFlow state, its also equivalent to the entire timeline of another flow. It is the time spent in the various states of another flow. In computing the total time spent in the primary flow, one must omit the WaitNextFlow time, since it is already included in the form of slices of individual state time intervals in the aggregated time intervals for other states, and will result in double counting. | integer |
| SSLConnectTimeMs | ConnectTimeMs includes TCP connect time + SSL time, whereas SSLConnectTimeMs includes only the latter. | TrawlerFetchReplyDataFetchStats | The fetcher keeps track of various time intervals spent in the states of the fetcher url control flow. Sometimes flows branch out into more than one flow (next flow), and we aggregate all the time intervals spent in a specific state for all the flows to get the time interval for the state. The time interval for a state is therefore not the time interval of an individual flow, if the WaitNextFlow time is non zero. The WaitNextFlow interval included here is the time spent by one flow waiting for another flow. Although the WaitNextFlow time is the time spent by a flow in the WaitNextFlow state, its also equivalent to the entire timeline of another flow. It is the time spent in the various states of another flow. In computing the total time spent in the primary flow, one must omit the WaitNextFlow time, since it is already included in the form of slices of individual state time intervals in the aggregated time intervals for other states, and will result in double counting. | integer |
| ServerResponseTimeMs | Time between the request send and the receipt of the first fragment of the response. For HTTP responses the first fragment is the first fragment of the response payload (the headers are ignored). | TrawlerFetchReplyDataFetchStats | The fetcher keeps track of various time intervals spent in the states of the fetcher url control flow. Sometimes flows branch out into more than one flow (next flow), and we aggregate all the time intervals spent in a specific state for all the flows to get the time interval for the state. The time interval for a state is therefore not the time interval of an individual flow, if the WaitNextFlow time is non zero. The WaitNextFlow interval included here is the time spent by one flow waiting for another flow. Although the WaitNextFlow time is the time spent by a flow in the WaitNextFlow state, its also equivalent to the entire timeline of another flow. It is the time spent in the various states of another flow. In computing the total time spent in the primary flow, one must omit the WaitNextFlow time, since it is already included in the form of slices of individual state time intervals in the aggregated time intervals for other states, and will result in double counting. | integer |
| TransferTimeMs | Time to receive the entire response payload starting the clock on receiving the first fragment. | TrawlerFetchReplyDataFetchStats | The fetcher keeps track of various time intervals spent in the states of the fetcher url control flow. Sometimes flows branch out into more than one flow (next flow), and we aggregate all the time intervals spent in a specific state for all the flows to get the time interval for the state. The time interval for a state is therefore not the time interval of an individual flow, if the WaitNextFlow time is non zero. The WaitNextFlow interval included here is the time spent by one flow waiting for another flow. Although the WaitNextFlow time is the time spent by a flow in the WaitNextFlow state, its also equivalent to the entire timeline of another flow. It is the time spent in the various states of another flow. In computing the total time spent in the primary flow, one must omit the WaitNextFlow time, since it is already included in the form of slices of individual state time intervals in the aggregated time intervals for other states, and will result in double counting. | integer |
| WaitContentCacheUsec | TrawlerFetchReplyDataFetchStatsClientStateStats | Records stats about state changes on the client side if there’re any. For example, there’s a state of cache lookup when using private-cache client library. | integer | |
| EndTrackingTimeUsec | TrawlerFetchReplyDataFetchStatsStateStats | The following are only populated if Params.WantStateStats is true. | String | |
| StartTrackingTimeUsec | Start and end timestamp tracking the delays for this request. | TrawlerFetchReplyDataFetchStatsStateStats | The following are only populated if Params.WantStateStats is true. | String |
| WaitCompressTimeUsec | TrawlerFetchReplyDataFetchStatsStateStats | The following are only populated if Params.WantStateStats is true. | integer | |
| WaitContentCacheUsec | TrawlerFetchReplyDataFetchStatsStateStats | The following are only populated if Params.WantStateStats is true. | integer | |
| WaitCredentialTimeUsec | TrawlerFetchReplyDataFetchStatsStateStats | The following are only populated if Params.WantStateStats is true. | integer | |
| WaitDNSTimeUsec | TrawlerFetchReplyDataFetchStatsStateStats | The following are only populated if Params.WantStateStats is true. | integer | |
| WaitFetchClientUsec | TrawlerFetchReplyDataFetchStatsStateStats | The following are only populated if Params.WantStateStats is true. | integer | |
| WaitForCachedContentStreamingUsec | TrawlerFetchReplyDataFetchStatsStateStats | The following are only populated if Params.WantStateStats is true. | integer | |
| WaitForFetchUsec | TrawlerFetchReplyDataFetchStatsStateStats | The following are only populated if Params.WantStateStats is true. | integer | |
| WaitHostIdTimeUsec | TrawlerFetchReplyDataFetchStatsStateStats | The following are only populated if Params.WantStateStats is true. | integer | |
| WaitNextFlowUsec | TrawlerFetchReplyDataFetchStatsStateStats | The following are only populated if Params.WantStateStats is true. | integer | |
| WaitRobotsCacheTimeUsec | obsolete. Not set. | TrawlerFetchReplyDataFetchStatsStateStats | The following are only populated if Params.WantStateStats is true. | integer |
| WaitRobotsFetchTimeUsec | obsolete. Not set. | TrawlerFetchReplyDataFetchStatsStateStats | The following are only populated if Params.WantStateStats is true. | integer |
| WaitRobotsTimeUsec | TrawlerFetchReplyDataFetchStatsStateStats | The following are only populated if Params.WantStateStats is true. | integer | |
| WaitScheduleTimeUsec | TrawlerFetchReplyDataFetchStatsStateStats | The following are only populated if Params.WantStateStats is true. | integer | |
| key | TrawlerFetchReplyDataHTTPHeader | header : value | String | |
| value | TrawlerFetchReplyDataHTTPHeader | header : value | String | |
| BodyLocation | If set, indicates where the fetched body is, e.g. a CNS file path. FetchReply.Body should be empty in this case. In the case where client does not support streaming but the content is too large to be accumulated in memory, we keep writing the streaming chunks to some storage unit and notify client when it is done. | TrawlerFetchReplyDataPartialResponse | #NAME? | String |
| ChunkNumber | Fetch number in this series of fetches | TrawlerFetchReplyDataPartialResponse | #NAME? | integer |
| ContentRange | If there is a Content-Range header, the ranges in it | TrawlerFetchReplyDataPartialResponse | #NAME? | TrawlerContentRangeInfo |
| ETag | Any ETag seen in the headers | TrawlerFetchReplyDataPartialResponse | #NAME? | String |
| FetchID | ID which links all partial fetches for this url | TrawlerFetchReplyDataPartialResponse | #NAME? | String |
| IsFinalResponse | Is this the final response for this fetch? | TrawlerFetchReplyDataPartialResponse | #NAME? | boolean |
| Code | Response code. We emulate the HTTP response codes for all protocols that we know. — HTTP: response code for the downloaded page. — FTP: similar with HTTP: 200 – OK, 40X – errors (not found, etc), 500 – server unavailable | TrawlerFetchReplyDataProtocolResponse | Group with protocol specific response (determined by the protocol of the url that generated the content we return). | integer |
| ContentType | Content type as inferred by the fetcher (webutil/http/content-type.proto) | TrawlerFetchReplyDataProtocolResponse | Group with protocol specific response (determined by the protocol of the url that generated the content we return). | String |
| CutoffSize | Where did we cut off? Includes headers plus truncated but uncompressed content. Present if and only if we truncated the document. | TrawlerFetchReplyDataProtocolResponse | Group with protocol specific response (determined by the protocol of the url that generated the content we return). | String |
| HttpVersion | DEPRECATED, see field 113. Stores the HTTP version we used in the final hop. | TrawlerFetchReplyDataProtocolResponse | Group with protocol specific response (determined by the protocol of the url that generated the content we return). | String |
| ProtocolVersionFallback | DEPRECATED, see field 114. Whether we fallback from HTTP/2 to HTTP/1.1 during fetch. The fallback could happen in any hops and there can be at most one fallback because once fallback happens, we will not try HTTP/2 anymore. | TrawlerFetchReplyDataProtocolResponse | Group with protocol specific response (determined by the protocol of the url that generated the content we return). | boolean |
| UnTruncatedSize | The amount of data we got from the webserver before any truncation, but after undoing any HTTP gzip/deflate encoding. For HTTP, this includes headers and uncompressed content. Content size is excluded if content was not successfully fetched. See description above TotalFetchedSize for comparison. | TrawlerFetchReplyDataProtocolResponse | Group with protocol specific response (determined by the protocol of the url that generated the content we return). | String |
| BadSSLCertificate | The server SSL certificate chain in SSLCertificateInfo protobuf format. See this field in FetchReplyData (i.e., the initial hop) for more description on when it will be populated. | TrawlerFetchReplyDataRedirects | The sequence of redirects fetched, if applicable. This includes url plus stats for each hop after the first hop. NOTE: This can be one redirect longer than the chain of redirects *followed*, in the case where there was a redirect at the end of the chain that the fetcher detected but did not follow. | String |
| CrawlTimes | Per redirect hop timestamps. This | TrawlerFetchReplyDataRedirects | The sequence of redirects fetched, if applicable. This includes url plus stats for each hop after the first hop. NOTE: This can be one redirect longer than the chain of redirects *followed*, in the case where there was a redirect at the end of the chain that the fetcher detected but did not follow. | TrawlerCrawlTimes |
| DownloadTime | Download time of this fetch (ms) | TrawlerFetchReplyDataRedirects | The sequence of redirects fetched, if applicable. This includes url plus stats for each hop after the first hop. NOTE: This can be one redirect longer than the chain of redirects *followed*, in the case where there was a redirect at the end of the chain that the fetcher detected but did not follow. | integer |
| Endpoints | ## stats If fetched, ip info. | TrawlerFetchReplyDataRedirects | The sequence of redirects fetched, if applicable. This includes url plus stats for each hop after the first hop. NOTE: This can be one redirect longer than the chain of redirects *followed*, in the case where there was a redirect at the end of the chain that the fetcher detected but did not follow. | TrawlerTCPIPInfo |
| HSTSInfo | This specifies if the url in a redirect was rewritten to HTTPS because of an HSTS policy for the domain. See comments on FetchReplyData.HSTSInfo for how this field’s values. A redirect that was rewritten with HSTS will have HSTS_STATUS_REWRITTEN ## here. | TrawlerFetchReplyDataRedirects | The sequence of redirects fetched, if applicable. This includes url plus stats for each hop after the first hop. NOTE: This can be one redirect longer than the chain of redirects *followed*, in the case where there was a redirect at the end of the chain that the fetcher detected but did not follow. | String |
| HTTPResponseCode | The HTTP response code for this hop. We need this since multiple response codes may have the same redirect type (e.g., 302 and 307 are both REDIRECT_TEMPORARILY), but clients may want to know which one was received. Note this is set only for the hops that are followed (i.e., TargetUrl is present). If the last redirect hop was not followed the fetch status will be URL_NOT_FOLLOWED, and the response code will be in the top level ProtocolResponse field. | TrawlerFetchReplyDataRedirects | The sequence of redirects fetched, if applicable. This includes url plus stats for each hop after the first hop. NOTE: This can be one redirect longer than the chain of redirects *followed*, in the case where there was a redirect at the end of the chain that the fetcher detected but did not follow. | integer |
| HopPageNoIndexInfo | Extra trawler::PageNoIndexInfo for this hop. Integer: ORed together bits from trawler::PageNoIndexInfo. The information specified by this field comes from the http header or content of the source url, not the “TargetUrl” in this Redirects group. | TrawlerFetchReplyDataRedirects | The sequence of redirects fetched, if applicable. This includes url plus stats for each hop after the first hop. NOTE: This can be one redirect longer than the chain of redirects *followed*, in the case where there was a redirect at the end of the chain that the fetcher detected but did not follow. | integer |
| HopReuseInfo | trawler::ReuseInfo with status of IMS/IMF/cache query, for this hop. | TrawlerFetchReplyDataRedirects | The sequence of redirects fetched, if applicable. This includes url plus stats for each hop after the first hop. NOTE: This can be one redirect longer than the chain of redirects *followed*, in the case where there was a redirect at the end of the chain that the fetcher detected but did not follow. | String |
| HopRobotsInfo | Extra trawler::RobotsInfo for this hop. Integer: ORed together bits from trawler::RobotsInfo | TrawlerFetchReplyDataRedirects | The sequence of redirects fetched, if applicable. This includes url plus stats for each hop after the first hop. NOTE: This can be one redirect longer than the chain of redirects *followed*, in the case where there was a redirect at the end of the chain that the fetcher detected but did not follow. | integer |
| HostId | If known, the hostid for this hop | TrawlerFetchReplyDataRedirects | The sequence of redirects fetched, if applicable. This includes url plus stats for each hop after the first hop. NOTE: This can be one redirect longer than the chain of redirects *followed*, in the case where there was a redirect at the end of the chain that the fetcher detected but did not follow. | String |
| HttpRequestHeaders | The http headers we sent for fetching this redirect hop. Not normally filled in, unless FetchParams.WantSentHeaders is set. | TrawlerFetchReplyDataRedirects | The sequence of redirects fetched, if applicable. This includes url plus stats for each hop after the first hop. NOTE: This can be one redirect longer than the chain of redirects *followed*, in the case where there was a redirect at the end of the chain that the fetcher detected but did not follow. | String |
| HttpResponseHeaders | The http headers we received from this redirect hop. Trawler does not fill this in; this is intended as a placeholder for crawls like webmirror that fill in and want to track this across redirect hops. | TrawlerFetchReplyDataRedirects | The sequence of redirects fetched, if applicable. This includes url plus stats for each hop after the first hop. NOTE: This can be one redirect longer than the chain of redirects *followed*, in the case where there was a redirect at the end of the chain that the fetcher detected but did not follow. | String |
| RawTargetUrl | bytes: can contain bad encoding. | TrawlerFetchReplyDataRedirects | The sequence of redirects fetched, if applicable. This includes url plus stats for each hop after the first hop. NOTE: This can be one redirect longer than the chain of redirects *followed*, in the case where there was a redirect at the end of the chain that the fetcher detected but did not follow. | String |
| RefreshTime | Refresh time in meta redirect tag | TrawlerFetchReplyDataRedirects | The sequence of redirects fetched, if applicable. This includes url plus stats for each hop after the first hop. NOTE: This can be one redirect longer than the chain of redirects *followed*, in the case where there was a redirect at the end of the chain that the fetcher detected but did not follow. | integer |
| RobotsTxt | The robots.txt we used for this fetch. Not normally filled in unless WantRobotsBody is set. | TrawlerFetchReplyDataRedirects | The sequence of redirects fetched, if applicable. This includes url plus stats for each hop after the first hop. NOTE: This can be one redirect longer than the chain of redirects *followed*, in the case where there was a redirect at the end of the chain that the fetcher detected but did not follow. | String |
| SourceBody | For meta-redirects, this field may contain the body of the source document. Currently only filled client side and not implemented (yet) for server-side redirects. | TrawlerFetchReplyDataRedirects | The sequence of redirects fetched, if applicable. This includes url plus stats for each hop after the first hop. NOTE: This can be one redirect longer than the chain of redirects *followed*, in the case where there was a redirect at the end of the chain that the fetcher detected but did not follow. | TrawlerFetchBodyData |
| TargetUrl | Difference between the following two fields: TargetUrl is set when we have followed the redirect target, and the url is canonicalized. RawTargetUrl is set in either of the following two cases: (1) The url has not be been followed. For example, the redirect is intended to be handled by the client. In the fetch reply response, you will see the url’s status as URL_NOT_FOLLOWED-NOT_FOLLOWED*. (2) The extracted redirect url is different from its *canonicalized* form. For example, if the target url contains fragments, then this RawTargetUrl will have the fragments. Redirect target | TrawlerFetchReplyDataRedirects | The sequence of redirects fetched, if applicable. This includes url plus stats for each hop after the first hop. NOTE: This can be one redirect longer than the chain of redirects *followed*, in the case where there was a redirect at the end of the chain that the fetcher detected but did not follow. | String |
| Type | URL and redirect type | TrawlerFetchReplyDataRedirects | The sequence of redirects fetched, if applicable. This includes url plus stats for each hop after the first hop. NOTE: This can be one redirect longer than the chain of redirects *followed*, in the case where there was a redirect at the end of the chain that the fetcher detected but did not follow. | String |
| webio | TrawlerFetchReplyDataWebIOInfo | WebIO is the new hostload model introduced in 2023. It measures the occupancy of 1 outgoing fetch connection for 1 minute. | number | |
| webioPercentageTier | TrawlerFetchReplyDataWebIOInfo | WebIO is the new hostload model introduced in 2023. It measures the occupancy of 1 outgoing fetch connection for 1 minute. | String | |
| Reason | The Reason field gives further clarifying details about why or how the fetch had the given outcome. For instance, if State is URL_ERROR – was it a 404/NotFound or a DNS error? The Reason field is present iff State != URL_CRAWLED. For a given crawl status of URL_FOO, the Reason value will be one of the various FetchFooReason enum values from crawler/trawler/trawler_enums.proto | TrawlerFetchStatus | integer | |
| State | The State field describes the basic outcome of a fetch (URL_CRAWLED, URL_ROBOTED, URL_ERROR, etc). The value is one of the UrlStatusType enum values from crawler/trawler/trawler_enums.proto Note, there are several combinations of this Status/Reason tuple that could mean that your content is crawled or can be bucketed in a particular type of error. So instead of comparing the enumeration values manually, we suggest to use the predicate functions such as IsContentCrawled() provided in crawler/trawler/public/basictypes.h (see details there). | TrawlerFetchStatus | String | |
| ClientTrafficFraction | How much existing traffic | TrawlerHostBucketData | !ERROR! D12527 -> Formula Error: An unexpected error occurred | number |
| ClientWeightFraction | belong to the client How much weight the client | TrawlerHostBucketData | !ERROR! D12528 -> Formula Error: An unexpected error occurred | number |
| CurrentActiveConnections | How many connections are actively used for downloading ? | TrawlerHostBucketData | !ERROR! D12529 -> Formula Error: An unexpected error occurred | integer |
| IsFull | Is this bucket currently full ? | TrawlerHostBucketData | !ERROR! D12530 -> Formula Error: An unexpected error occurred | boolean |
| LastScheduleIntervalMs | How many ms ago we last scheduled a url | TrawlerHostBucketData | !ERROR! D12531 -> Formula Error: An unexpected error occurred | String |
| MaxActiveConnections | The current hostload value (# of connections) – if negative does not apply | TrawlerHostBucketData | !ERROR! D12532 -> Formula Error: An unexpected error occurred | number |
| MediumTermLoad | The load the recent times (the actual hostload that we apply is MaxActiveConnections / MediumTermLoad) – a hostload of 1.00 is normal, while over 1.0 is higher than normal load | TrawlerHostBucketData | !ERROR! D12533 -> Formula Error: An unexpected error occurred | number |
| MinInterRequestSecs | The min delay between requests (in secs) – if negative does not apply | TrawlerHostBucketData | !ERROR! D12534 -> Formula Error: An unexpected error occurred | number |
| NonFullIntervalMs | If is full, when is becoming non-full (in ms) | TrawlerHostBucketData | !ERROR! D12535 -> Formula Error: An unexpected error occurred | String |
| TotalCapacityQps | The following four fields attempt to make things simpler for clients to estimate available capacity. They are not populated yet as of 2013/08/21. Even after they are populated, they may change. So talk to trawler-dev@ before you use the fields. Total qps for this hostid | TrawlerHostBucketData | !ERROR! D12536 -> Formula Error: An unexpected error occurred | number |
| TotalUsedQps | Currently used qps | TrawlerHostBucketData | !ERROR! D12537 -> Formula Error: An unexpected error occurred | number |
| urllist | TrawlerHostBucketData | !ERROR! D12538 -> Formula Error: An unexpected error occurred | list(TrawlerHostBucketDataUrlList) | |
| ClientCanCrawl | Is this client/requestorid allowed to crawl now? (based on resource use) | TrawlerHostBucketDataUrlList | Per each list that wishes to schedule url we return one of these: | boolean |
| IsDefaultNode | Is this the ‘default’ user’s list | TrawlerHostBucketDataUrlList | Per each list that wishes to schedule url we return one of these: | boolean |
| IsListForUrl | Was this the list that a given request landed in? | TrawlerHostBucketDataUrlList | Per each list that wishes to schedule url we return one of these: | boolean |
| NumCurrentFetches | # of current active fetches | TrawlerHostBucketDataUrlList | Per each list that wishes to schedule url we return one of these: | integer |
| NumUrls | # of urls currently in the queue | TrawlerHostBucketDataUrlList | Per each list that wishes to schedule url we return one of these: | integer |
| PartnerTotalCapacityQps | Total qps for this partner dedicated hostload, for non partner it will be -1.0. | TrawlerHostBucketDataUrlList | Per each list that wishes to schedule url we return one of these: | number |
| PartnerTotalUsedQps | Currently used qps for this partner dedicated hostlaod, for non partner it will be -1.0. | TrawlerHostBucketDataUrlList | Per each list that wishes to schedule url we return one of these: | number |
| RequestType | The type of the request (low latency vs. high throughput) | TrawlerHostBucketDataUrlList | Per each list that wishes to schedule url we return one of these: | String |
| RequestorFp | The fp64 of the requestor string | TrawlerHostBucketDataUrlList | Per each list that wishes to schedule url we return one of these: | String |
| cloudRegion | TrawlerLoggedVPCDestination | Information about VPC fetches tracked for logging purposes. | String | |
| vnid | TrawlerLoggedVPCDestination | Information about VPC fetches tracked for logging purposes. | NetFabricRpcVirtualNetworkId | |
| crawlPolicyId | TrawlerMultiverseClientIdentifier | Contain Multiverse client information, such as topic name. Can include other information such as crawl policy id in the future. | integer | |
| crawlPolicyName | TrawlerMultiverseClientIdentifier | Contain Multiverse client information, such as topic name. Can include other information such as crawl policy id in the future. | String | |
| hyperdriveAppName | Hyperdrive Analytics. | TrawlerMultiverseClientIdentifier | Contain Multiverse client information, such as topic name. Can include other information such as crawl policy id in the future. | String |
| hyperdriveTableName | TrawlerMultiverseClientIdentifier | Contain Multiverse client information, such as topic name. Can include other information such as crawl policy id in the future. | String | |
| topicId | Propagate the id instead of the string name to save storage resource. TODO (b/317133951) consider deprecate the two fields in string above. | TrawlerMultiverseClientIdentifier | Contain Multiverse client information, such as topic name. Can include other information such as crawl policy id in the future. | integer |
| topicName | TrawlerMultiverseClientIdentifier | Contain Multiverse client information, such as topic name. Can include other information such as crawl policy id in the future. | String | |
| trafficType | TrawlerMultiverseClientIdentifier | Contain Multiverse client information, such as topic name. Can include other information such as crawl policy id in the future. | String | |
| clientCell | TrawlerOriginalClientParams | The information about the original client who starts the request. | String | |
| clientIp | TrawlerOriginalClientParams | The information about the original client who starts the request. | String | |
| clientRpcType | through which RPC request | TrawlerOriginalClientParams | The information about the original client who starts the request. | String |
| clientUsername | TrawlerOriginalClientParams | The information about the original client who starts the request. | String | |
| ExtraData | in roboted case, the RobotsInfo | TrawlerPolicyData | Trawler can add a policy label to a FetchReply. The two main cases are: – “spam” label added for specific spammer IPs listed in trawler_site_info, which most crawls auto-reject. – “roboted:useragent” (e.g. “roboted:googlebot”) if InfoOnlyUserAgents field is set in FetchParams | integer |
| Label | “spam” or “roboted:googlebot” | TrawlerPolicyData | Trawler can add a policy label to a FetchReply. The two main cases are: – “spam” label added for specific spammer IPs listed in trawler_site_info, which most crawls auto-reject. – “roboted:useragent” (e.g. “roboted:googlebot”) if InfoOnlyUserAgents field is set in FetchParams | String |
| ALPNNegotiatedProtocol | ALPN negotiated protocol, see https://tools.ietf.org/html/rfc7301 The value will either be empty, or one of the protocol names sent by the client that the server accepted. Examples include “h2” and “acme-tls/1”. | TrawlerSSLCertificateInfo | This protobuf specifies the results of https certificate validation, typically used for the BadSSLCertificate field in FetchReplyData. ————————– Next Tag: 13 ——————————- | String |
| CertificateChain | If present, this consists of the remote webserver’s X.509 certificate chain in DER format. The chain stored here is the *reversed* result of SSL_get_peer_cert_chain(). That is to say, it is the chain presented by the peer (which may differ from the chain that was built and verified), but in leaf-last order. Typically the root cert will not be included. But do not assume anything, because servers do all manner of weird things. (For example on the beginning of the chain, there might be also some irrelevant certificates besides the root certificate.) Certificates may be the empty string, indicating an encoding failure. See also |IsTruncated|. Certs can be loaded with util/sig/cert.h Cert::LoadBinaryCert(), converted to ASCII PEM format (CertificateUtil::CertificateToPEM()) or shown as text at the commandline by piping them into ‘openssl x509 -text -inform DER’. | TrawlerSSLCertificateInfo | This protobuf specifies the results of https certificate validation, typically used for the BadSSLCertificate field in FetchReplyData. ————————– Next Tag: 13 ——————————- | list(String) |
| ErrorMessages | ErrorMessages contains errors from HTTPS validation. Examples of such errors include invalid certificates, failure to build a certificate chain, certificates that do not match the expected hostname, and internal errors. If ErrorMessages is empty, HTTPS validation succeeded. Otherwise, it failed. This is the only guarantee about the contents of this field, though legacy code exists that embeds invalid assumptions, b/70904498. New code should not do anything with this field other than test whether it is empty and display its value to humans. If you need to know more about the details of a particular HTTPS validation, you can revalidate |CertificateChain| independently. | TrawlerSSLCertificateInfo | This protobuf specifies the results of https certificate validation, typically used for the BadSSLCertificate field in FetchReplyData. ————————– Next Tag: 13 ——————————- | list(String) |
| IsTruncated | This SSLCertificateInfo had its fields truncated because it was too large. It is no longer set (cl/205356251) but may be true in old records. | TrawlerSSLCertificateInfo | This protobuf specifies the results of https certificate validation, typically used for the BadSSLCertificate field in FetchReplyData. ————————– Next Tag: 13 ——————————- | boolean |
| OCSPResponse | Stapled OCSP response obtained during the TLS handshake, if any. An OCSP (Online Certificate Status Protocol) response is an indication, signed by the issuing CA, that the certificate has not been revoked. A TLS handshake extension allows servers to “staple” a response to the certificate served in the handshake, saving the need for the client to fetch it itself from the CA. This field contain the stapled OCSP response if the server served one. See RFC6066, Section 8 for the data format: https://tools.ietf.org/html/rfc6066#section-8 | TrawlerSSLCertificateInfo | This protobuf specifies the results of https certificate validation, typically used for the BadSSLCertificate field in FetchReplyData. ————————– Next Tag: 13 ——————————- | String |
| SCTList | SCTList obtained during the TLS handshake, if any. See RFC6962, Section 3.3 for the data format: https://tools.ietf.org/html/rfc6962#section-3.3 | TrawlerSSLCertificateInfo | This protobuf specifies the results of https certificate validation, typically used for the BadSSLCertificate field in FetchReplyData. ————————– Next Tag: 13 ——————————- | String |
| SSLCipherSuite | TrawlerSSLCertificateInfo | This protobuf specifies the results of https certificate validation, typically used for the BadSSLCertificate field in FetchReplyData. ————————– Next Tag: 13 ——————————- | integer | |
| SSLCipherSuiteName | TrawlerSSLCertificateInfo | This protobuf specifies the results of https certificate validation, typically used for the BadSSLCertificate field in FetchReplyData. ————————– Next Tag: 13 ——————————- | String | |
| SSLProtocolVersion | Details about the SSL/TLS protocol and cipher. See RFC5246 and google3/crawler/trawler/hope/proto/ssl.proto for more details. | TrawlerSSLCertificateInfo | This protobuf specifies the results of https certificate validation, typically used for the BadSSLCertificate field in FetchReplyData. ————————– Next Tag: 13 ——————————- | integer |
| SSLProtocolVersionName | The names of the SSL protocol version and cipher suite. These strings are implementation defined and may be subject to change. | TrawlerSSLCertificateInfo | This protobuf specifies the results of https certificate validation, typically used for the BadSSLCertificate field in FetchReplyData. ————————– Next Tag: 13 ——————————- | String |
| DestinationIPAddressPacked | Address of the destination host. Extract with trawler::DestinationIP() or decode with PackedStringToIPAddress(). | TrawlerTCPIPInfo | To keep track of fetch connection endpoints. Note: You can use trawler::SourceIP(info) or trawler::DestinationIP(info) (as well as HasSourceIP/HasDestinationIP) in basictypes.h instead of accessing the packed strings directly. This will return a proper IPAddress. Never use the fixed32 based Source/Destination-IP in new code as they will go away (only IPv4). | String |
| DestinationPort | TrawlerTCPIPInfo | To keep track of fetch connection endpoints. Note: You can use trawler::SourceIP(info) or trawler::DestinationIP(info) (as well as HasSourceIP/HasDestinationIP) in basictypes.h instead of accessing the packed strings directly. This will return a proper IPAddress. Never use the fixed32 based Source/Destination-IP in new code as they will go away (only IPv4). | integer | |
| SourceIPAddressPacked | Source address of the crawl machine we originated the fetch from. Extract with trawler::SourceIP() or decode with PackedStringToIPAddress(). | TrawlerTCPIPInfo | To keep track of fetch connection endpoints. Note: You can use trawler::SourceIP(info) or trawler::DestinationIP(info) (as well as HasSourceIP/HasDestinationIP) in basictypes.h instead of accessing the packed strings directly. This will return a proper IPAddress. Never use the fixed32 based Source/Destination-IP in new code as they will go away (only IPv4). | String |
| SourcePort | TrawlerTCPIPInfo | To keep track of fetch connection endpoints. Note: You can use trawler::SourceIP(info) or trawler::DestinationIP(info) (as well as HasSourceIP/HasDestinationIP) in basictypes.h instead of accessing the packed strings directly. This will return a proper IPAddress. Never use the fixed32 based Source/Destination-IP in new code as they will go away (only IPv4). | integer | |
| IsBandwidthThrottle | TrawlerThrottleClientData | boolean | ||
| MaxAllowedRate | Max doc_requestor urls/second allowed from this client to this fetcher. | TrawlerThrottleClientData | number | |
| PostDataSize | What’s the post data size (in bytes) if it’s a post request. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| numDroppedReplies | Number of times we drop the content of a stream reply or the final reply, which can only be caused by REJECTED_NO_RPC_BUFFERS now. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| HintIPAddress | If we do not have Endpoints in FetchReplyData (e.g., url rejected due to hostload limit), do we have a guess of the server IPAddress (e.g., from robots fetch)? This helps us classify URLs based on country code, etc. The field is filled with IPAddress::ToPackedString(). | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| RpcStartDeadlineLeftMs | RPC deadline left at the start of url control flow. Can be useful for debugging rpc deadline exceeded error received by clients, this field is only recorded if RpcEndDeadlineLeftMs is small enough. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | integer |
| largeStoreHitLocation | Set to the hit location (CNS filename) if cache comes from large store. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| isDedicatedHostload | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | boolean | |
| dependentFetchType | Dependent fetch type | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| isVpcTraffic | Set if the fetch goes through the virtual private cloud path so we can track the VPC traffic. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | boolean |
| httpVersion | Stores the HTTP version we used in the last hop. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| BotGroupName | If we fetched using BotFetchAgent, what is the BotGroupName? | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| isBidiStreamingFetch | Whether this is a bidirectional streaming fetch. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | boolean |
| authenticationInfo | Stores the OAuth authentication method. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| RequestUserName | Log the loas username in trawler private to help with debugging. Store the username in trawler private so clients won’t see it from FetchReply. To reduce disk usage, we only log the loas username if the requestorid being used does not have ClientUsernameRestrictions. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| cacheHitType | Only set if the fetch uses cache content (is_cache_fetch is true). | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| originalClientParams | Store the original client information. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | TrawlerOriginalClientParams |
| IsRobotsFetch | Was this an internally-initiated robots.txt fetch? | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | boolean |
| resourceBucket | If the requestor shares resource bucket with other requestorids, we will store the resource bucket name in these fields. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| cacheAcceptableAge | Corresponds to AcceptableAge field in FetchParams. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | integer |
| Producer | Note TrawlerPrivateFetchReplyData is never sent back to clients. The following field is just for Trawler and Multiverse internal tracking, and clients should not look at this field at all. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| ProxyInstance | If set, this fetch was done through a proxy (e.g., fetchproxy). | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| cdnProvider | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String | |
| concurrentStreamNum | How many concurrent streams are on the connection when the request finishes (including this request). Export this value to monitor the stream multiplexing for HTTP/2. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| cacheAcceptableAfterDate | Corresponds to AcceptableAfterDate field in FetchParams. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | integer |
| credentialId | Log the credential id | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| ResponseBytes | The number of bytes we sent back to the client. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| downloadFileName | If the response header contains Content-Disposition header “attachment; filename=”google.zip”: the download_file_name would be “google.zip” | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| isFloonetFetch | Whether or not this is a Floonet fetch request. Floonet requests have inherent lower availability (due to HOPE rejections when HOPE is in degraded mode, and other Floonet specific reasons). Therefore, it is important for debugging and for our availability SLO to know whether of not it is a floonet fetch. IMPORTANT NOTE: This field is only currently set for traffic that explicitly requires Floonet and can not failover to use Googlebot (i.e. “transparent” or “implicit” Floonet fetches). | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | boolean |
| multiverseClientIdentifier | Multiverse client information | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | TrawlerMultiverseClientIdentifier |
| TrawlerInstance | Which Trawler cell was this response fetched in? (e.g. “HR” or “YQ”) | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| HSTSHeaderValue | HTTP Strict-Transport-Security (RFC6797) header value. We log this so we can generate a list of hosts that prefer HTTPS over HTTP. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| tier | Service tier info will be used in traffic grapher for ploting per tier graph. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| Is5xxHostId | Represents if the HostId belongs to HostId set in 5xx url patterns, it can work as a tag when emitting requestor minute summary, this helps us to aggregate traffic affected by 5xx patterns, and test if there are any fetching changes. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | boolean |
| UserAgentSent | The useragent string sent to the remote webserver. It corresponds to UserAgentToSend field in FetchParams. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| googleExtendedObeyWildcardRobotsStatus | We check if Google-Extended is allowed to crawl this URL, wildcard rules are obeyed, this is for internal analysis. Check RobotsTxtClient::RobotsStatus for the meaning of number. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | integer |
| RobotsBody | If this was a robots.txt fetch (IsRobotsFetch above), this may contain the robots.txt body. (It may not, for instance, 404s are omitted; current policy is URL_CRAWLED + partially crawled) This includes http headers + body. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| UserAgentSentFp | The fp2011 of useragent sent to the remote webserver, note it corresponds to UserAgentToSend field in FetchParams | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| prodRegion | Log the prod region (only for regional harpoon requestor ids) | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| RpcEndDeadlineLeftMs | RPC deadline left at the end of url control flow. Can be useful for debugging rpc deadline exceeded error received by clients, this field is only recorded if it’s small enough. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | integer |
| isFromGrpcProxy | Whether or not this response is sent from gRPC proxy service. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | boolean |
| ServerSignature | An arbitrary string signature identifying the remote server type/version. In the case of HTTP, this would be the contents of the “Server:” header. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| googleExtendedRobotsStatus | We check if Google-Extended is allowed to crawl this URL and store the result here, wildcard rules are not obeyed, this is for internal analysis. Check RobotsTxtClient::RobotsStatus for the meaning of number. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | integer |
| BotHostname | This is the HOPE server that we sent the url to. We log the HOPE backend cell and hope server shard number (e.g., ‘qf:6’). This allows us to understand how we are balancing our load to the HOPE servers. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| subResourceBucket | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String | |
| vpcDestination | The following are vpc information that’s only set if is_vpc_traffic is true. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | TrawlerLoggedVPCDestination |
| bypassedHostOverfull | Cache hit for this url, bypassed host_overfull error. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | boolean |
| CacheRequestorID | Present if the reply is from the trawler cache. This is the requestorid of the trawler client that populated the cache with the data we are reusing. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | String |
| HadInMemCacheHit | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | boolean | |
| FetcherTaskNumber | Which Trawler fetcher task fetched this URL. | TrawlerTrawlerPrivateFetchReplyData | This is an optional container of arbitrary data that can be added to a FetchReplyData. This data is meant to be logged, but not sent back in a fetch reply (it should be added *after* the reply is prepared). Use FetchResponsePreparatorImpl::AddTrawlerPrivateDataToFetchReplyData to add. See also the comment in fetch_response_preparator_impl.cc. Next Tag: 49 | integer |
| debug | A debug message that summarizes how the score was computed. Populated if result was matched and in debug mode. | UniversalsearchNewPackerKnowledgeResultSupport | Information about the result support for a given interpretation. | String |
| docid | The docid of the result, if available. | UniversalsearchNewPackerKnowledgeResultSupport | Information about the result support for a given interpretation. | String |
| estimatedNaviness | The naviness for this result. Each matcher can determine the naviness to use for the result. This can be copied directly from the result, or estimated based on clicks or some other heuristic. The value should be between 0 and 1 and should indicate the probability that the user will click on that result. The estimated_naviness is used to break ties when between results with the same rank. | UniversalsearchNewPackerKnowledgeResultSupport | Information about the result support for a given interpretation. | number |
| provenance | All provenances of this result support. | UniversalsearchNewPackerKnowledgeResultSupport | Information about the result support for a given interpretation. | list(UniversalsearchNewPackerKnowledgeResultSupportProvenance) |
| rank | The 0 based rank for this result. When the source is MAIN_GSR this corresponds to the index of the result in the generic search response specific in AddKnowledgePackerPreprocessors. Otherwise, the rank should be estimated so the result is closest in importance to the web result at the same rank. | UniversalsearchNewPackerKnowledgeResultSupport | Information about the result support for a given interpretation. | integer |
| score | A score from 0 to 1 inclusive that represents the strength of the result support. A score of one indicates this result is entirely about this interpretation. | UniversalsearchNewPackerKnowledgeResultSupport | Information about the result support for a given interpretation. | number |
| source | The source of the result support. | UniversalsearchNewPackerKnowledgeResultSupport | Information about the result support for a given interpretation. | String |
| url | The result url when available. | UniversalsearchNewPackerKnowledgeResultSupport | Information about the result support for a given interpretation. | String |
| entityGroupType | Entity group type of the supported entity. This field should only be set for support on entities. | UniversalsearchNewPackerKnowledgeResultSupportProvenance | Information about provenance of a result support. | String |
| fromAnswer | !ERROR! B12636 -> Formula Error: An unexpected error occurred | UniversalsearchNewPackerKnowledgeResultSupportProvenance | Information about provenance of a result support. | boolean |
| name | The provenance provider name. | UniversalsearchNewPackerKnowledgeResultSupportProvenance | Information about provenance of a result support. | String |
| NotChangedTimeMs | fetched from the web. Time when the page was last | UrlPoisoningData | Url poisoning information. This information is sparse: if num_spam_siblings is not populated, none of the following fields will be populated. Next tag: 6 | String |
| OriginalCrawlTimeMs | Time when the page was | UrlPoisoningData | Url poisoning information. This information is sparse: if num_spam_siblings is not populated, none of the following fields will be populated. Next tag: 6 | String |
| ReuseTimeMs | checked but found to be the same as before. If set, timestamp to indicate | UrlPoisoningData | Url poisoning information. This information is sparse: if num_spam_siblings is not populated, none of the following fields will be populated. Next tag: 6 | String |
| numSpamSiblings | UrlPoisoningData | Url poisoning information. This information is sparse: if num_spam_siblings is not populated, none of the following fields will be populated. Next tag: 6 | integer | |
| url | when it is fetched from the repository. URL of the document for debugging | UrlPoisoningData | Url poisoning information. This information is sparse: if num_spam_siblings is not populated, none of the following fields will be populated. Next tag: 6 | String |
| canonicalCode | The canonical error code (see codes.proto) that most closely corresponds to this status. This may be missing, and in the common case of the generic space, it definitely will be. | UtilStatusProto | Wire-format for a Status object | integer |
| code | Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto | UtilStatusProto | Wire-format for a Status object | integer |
| message | Detail message | UtilStatusProto | Wire-format for a Status object | String |
| messageSet | message_set associates an arbitrary proto message with the status. | UtilStatusProto | Wire-format for a Status object | Proto2BridgeMessageSet |
| space | The following are usually only present when code != 0 Space to which this status belongs | UtilStatusProto | Wire-format for a Status object | String |
| policy | The list of trusted genome policy. | VendingConsumerProtoTrustedGenomeAnnotation | —————————————————————————— Proto message containing the trusted genome entities that belong to an app. Document type: ANDROID_APP See go/gd-server-design for more info. ## Next tag: 4 | VendingConsumerProtoTrustedGenomePolicy |
| testCode | The list of test code, used to log when serving. The test code is set in both control and experiment annotations when they are different. | VendingConsumerProtoTrustedGenomeAnnotation | —————————————————————————— Proto message containing the trusted genome entities that belong to an app. Document type: ANDROID_APP See go/gd-server-design for more info. ## Next tag: 4 | list(String) |
| trustedGenomeHierarchy | The list of trusted genome hierarchy. One trusted_genome_hierarchy may contain one or multiple entities. This is required for TG 2.0 tags. | VendingConsumerProtoTrustedGenomeAnnotation | —————————————————————————— Proto message containing the trusted genome entities that belong to an app. Document type: ANDROID_APP See go/gd-server-design for more info. ## Next tag: 4 | list(VendingConsumerProtoTrustedGenomeHierarchy) |
| categoryId | The category id matching this trusted genome entity. e.g. Action tag with id /m/025zzc matches category of id GAME_ACTION | VendingConsumerProtoTrustedGenomeEntity | Proto message containing the id, localized title, score, and hierarchy level of a trusted genome entity. Next ID: 12 | String |
| id | The identifier of a play trusted genome entity. Required. | VendingConsumerProtoTrustedGenomeEntity | Proto message containing the id, localized title, score, and hierarchy level of a trusted genome entity. Next ID: 12 | String |
| isLocalized | Indicate whether the trusted genome entity has localized title. | VendingConsumerProtoTrustedGenomeEntity | Proto message containing the id, localized title, score, and hierarchy level of a trusted genome entity. Next ID: 12 | boolean |
| level | The level of the entity. E.g. in hierarchy like Action -> Platformer > Endless Runner. Action is level 1, Platformer is level 2 and Endless Runner is level 3. Currently, only APP_TAXONOMY and GAME_TAXONOMY type may have the levels. For entity that does not have hierarchy, its level is 1. Required. | VendingConsumerProtoTrustedGenomeEntity | Proto message containing the id, localized title, score, and hierarchy level of a trusted genome entity. Next ID: 12 | integer |
| predicateName | The name of the relation between the app and the entity. Required. | VendingConsumerProtoTrustedGenomeEntity | Proto message containing the id, localized title, score, and hierarchy level of a trusted genome entity. Next ID: 12 | String |
| queryText | The localized query string for this trusted genome entity. This query will be used when we want to bring users to SERP on click. | VendingConsumerProtoTrustedGenomeEntity | Proto message containing the id, localized title, score, and hierarchy level of a trusted genome entity. Next ID: 12 | String |
| recsTopicId | The corresponding recs topics created from the trusted genome entity if available. | VendingConsumerProtoTrustedGenomeEntity | Proto message containing the id, localized title, score, and hierarchy level of a trusted genome entity. Next ID: 12 | list(String) |
| score | The confidence score of the entity to the app. | VendingConsumerProtoTrustedGenomeEntity | Proto message containing the id, localized title, score, and hierarchy level of a trusted genome entity. Next ID: 12 | number |
| title | The localized title. Required. | VendingConsumerProtoTrustedGenomeEntity | Proto message containing the id, localized title, score, and hierarchy level of a trusted genome entity. Next ID: 12 | String |
| userVisible | This boolean is used to decide whether this entity will be shown on user-facing features in the Store or not. | VendingConsumerProtoTrustedGenomeEntity | Proto message containing the id, localized title, score, and hierarchy level of a trusted genome entity. Next ID: 12 | boolean |
| entity | List of entities (one or multiple) that belong in the same hierarchy. The entries will be ordered such that the first entry will be of level 1, and the second entry will be of level 2, and so on. Required | VendingConsumerProtoTrustedGenomeHierarchy | Proto message containing one or multiple trusted genome entity. This is used to capture entities that belong to the same type and have parent-children relationship in the taxonomy. e.g. One hierarchy may include 3 entities with Game_Taxonomy Type: (1) Action (Level 1) (2) Platformer (Level 2 under Action) (3) Endless Runner (Level 3 under Platformer) e.g. One hierarchy may also include only 1 entity with Game_Graphic_Style: (1) Anime (No level information) Next ID: 5 | list(VendingConsumerProtoTrustedGenomeEntity) |
| hierarchyType | The (hierarchy-level) type of this Trusted Genome hierarchy. Will only be populated when meeting certain criteria, e.g. ‘GD2_Game_Main’ means this hierarchy of entities can serve as the main game genre for Game Discovery 2.0. | VendingConsumerProtoTrustedGenomeHierarchy | Proto message containing one or multiple trusted genome entity. This is used to capture entities that belong to the same type and have parent-children relationship in the taxonomy. e.g. One hierarchy may include 3 entities with Game_Taxonomy Type: (1) Action (Level 1) (2) Platformer (Level 2 under Action) (3) Endless Runner (Level 3 under Platformer) e.g. One hierarchy may also include only 1 entity with Game_Graphic_Style: (1) Anime (No level information) Next ID: 5 | String |
| source | The source of this Trusted Genome hierarchy. | VendingConsumerProtoTrustedGenomeHierarchy | Proto message containing one or multiple trusted genome entity. This is used to capture entities that belong to the same type and have parent-children relationship in the taxonomy. e.g. One hierarchy may include 3 entities with Game_Taxonomy Type: (1) Action (Level 1) (2) Platformer (Level 2 under Action) (3) Endless Runner (Level 3 under Platformer) e.g. One hierarchy may also include only 1 entity with Game_Graphic_Style: (1) Anime (No level information) Next ID: 5 | String |
| trustedGenomeType | The (entity-level) type of trusted genome entities in this hierarchy. Required. | VendingConsumerProtoTrustedGenomeHierarchy | Proto message containing one or multiple trusted genome entity. This is used to capture entities that belong to the same type and have parent-children relationship in the taxonomy. e.g. One hierarchy may include 3 entities with Game_Taxonomy Type: (1) Action (Level 1) (2) Platformer (Level 2 under Action) (3) Endless Runner (Level 3 under Platformer) e.g. One hierarchy may also include only 1 entity with Game_Graphic_Style: (1) Anime (No level information) Next ID: 5 | String |
| localizedRegionOverride | Override text for region for special treatment. Override will be used in special cases for example regions are too long to show in UI, the override will be “CA/NV/…” to cut it short. By keeping a region override string we’ll have more flexibility to adjust what we show on UI. Optional. | VendingConsumerProtoTrustedGenomePolicy | Proto message containing policy related information. | String |
| policyType | Policy type. e.g. Government Endorsed, Apollo Required. | VendingConsumerProtoTrustedGenomePolicy | Proto message containing policy related information. | list(String) |
| targetRegion | Contains target region for the current policy. Optional | VendingConsumerProtoTrustedGenomePolicy | Proto message containing policy related information. | list(VendingConsumerProtoTrustedGenomePolicyTargetRegion) |
| localizedRegion | Localized name for targeted regions. e.g. San Francisco Bay Area Required. | VendingConsumerProtoTrustedGenomePolicyTargetRegion | String | |
| mid | Associated KG entity mid for region. e.g. /m/06pvr | VendingConsumerProtoTrustedGenomePolicyTargetRegion | String | |
| channelMap | Maps channel indexes of an audio stream to indexes corresponding to the specified ambisonics channel ordering scheme. For example: A 1st order pheriphonic ambisonics format is configured with 4 audio channels corresponding to ambisonic components W, X, Y, Z respectively. The channel_ordering scheme is specified as CHANNEL_ORDERING_ACN (which implies a W, Y, Z, X ordering). Therefore the channel_map is [0, 3, 1, 2]. | VideoAmbisonicsAmbisonicsMetadata | list(integer) | |
| channelOrdering | VideoAmbisonicsAmbisonicsMetadata | String | ||
| nonDiegeticStereo | VideoAmbisonicsAmbisonicsMetadata | boolean | ||
| normalization | VideoAmbisonicsAmbisonicsMetadata | String | ||
| numChannels | VideoAmbisonicsAmbisonicsMetadata | integer | ||
| order | VideoAmbisonicsAmbisonicsMetadata | integer | ||
| type | VideoAmbisonicsAmbisonicsMetadata | String | ||
| version | VideoAmbisonicsAmbisonicsMetadata | integer | ||
| owner | REQUIRED: the current owner of this video. Please note that owner does not get implicit reader/writer access. You must set them explicitly. | VideoAssetsVenomACL | Valid fields in ACL are “mdb/groupname”, or “user/username”, e.g., “mdb/youtube-prod”, or “user/alice”. | String |
| reader | Allowed readers of this video. | VideoAssetsVenomACL | Valid fields in ACL are “mdb/groupname”, or “user/username”, e.g., “mdb/youtube-prod”, or “user/alice”. | list(String) |
| writer | Allowed writers of this video. | VideoAssetsVenomACL | Valid fields in ACL are “mdb/groupname”, or “user/username”, e.g., “mdb/youtube-prod”, or “user/alice”. | list(String) |
| objective | The objective this transition is about. REQUIRED. | VideoAssetsVenomTransition | As video mutations are reconciled by Venom, we can tell if the ingredient did or did not reach certain objectives. When processing has completed, all objectives will have a corresponding transition. All transitions are reset for every mutation, but will take into account assets outside of that mutation. For example, if Asset X fails, and was part of “OBJECTIVE_PRIMARY_ASSETS_DONE”, a rerun of Asset Y is destined to result in OUTCOME_FAILED, regardless of the fate of Asset Y. Some phenonema have effects on most or all Objectives. For example, a bad input file will result on OUTCOME_INFEASIBLE across the board (eventually, for now it’s just GO_LIVE and DO_ALL, work in progress), and a failure to produce Format 18 will cause OUTCOME_FAILED across most Objectives. | String |
| outcome | Whether the objective is reached or not. REQUIRED. | VideoAssetsVenomTransition | As video mutations are reconciled by Venom, we can tell if the ingredient did or did not reach certain objectives. When processing has completed, all objectives will have a corresponding transition. All transitions are reset for every mutation, but will take into account assets outside of that mutation. For example, if Asset X fails, and was part of “OBJECTIVE_PRIMARY_ASSETS_DONE”, a rerun of Asset Y is destined to result in OUTCOME_FAILED, regardless of the fate of Asset Y. Some phenonema have effects on most or all Objectives. For example, a bad input file will result on OUTCOME_INFEASIBLE across the board (eventually, for now it’s just GO_LIVE and DO_ALL, work in progress), and a failure to produce Format 18 will cause OUTCOME_FAILED across most Objectives. | String |
| reason | An optional debug string indicating the reason for this transition. This is typically omitted for OUTCOME_SUCCESS. e.g. “The video’s content is invalid due to failed blobstore cloning.” | VideoAssetsVenomTransition | As video mutations are reconciled by Venom, we can tell if the ingredient did or did not reach certain objectives. When processing has completed, all objectives will have a corresponding transition. All transitions are reset for every mutation, but will take into account assets outside of that mutation. For example, if Asset X fails, and was part of “OBJECTIVE_PRIMARY_ASSETS_DONE”, a rerun of Asset Y is destined to result in OUTCOME_FAILED, regardless of the fate of Asset Y. Some phenonema have effects on most or all Objectives. For example, a bad input file will result on OUTCOME_INFEASIBLE across the board (eventually, for now it’s just GO_LIVE and DO_ALL, work in progress), and a failure to produce Format 18 will cause OUTCOME_FAILED across most Objectives. | String |
| id | REQUIRED. IDs have some constraints: – 32 bytes max: this is enforced by the server – for the time being, must be parseable as a youtube ID (basically a base64-encoded string which maps to a 64-bit integer). This restriction will eventually be lifted. | VideoAssetsVenomVideoId | A VideoId is the unique identifier of a video. Privacy: VideoIds are visible in logs, notifications, etc and must not contain PII. | String |
| ns | LINT.ThenChange( //depot/google3/googledata/production/playbooks/video-assets/clients.md, //depot/google3/video/assets/venom/proto/namespace.proto ) REQUIRED. | VideoAssetsVenomVideoId | A VideoId is the unique identifier of a video. Privacy: VideoIds are visible in logs, notifications, etc and must not contain PII. | String |
| bitrate | Audio bitrate in bits/s. | VideoAudioStream | Next tag: 10 | String |
| channels | Number of audio channels. | VideoAudioStream | Next tag: 10 | integer |
| codecId | Audio codec ID. Uses the numeric value corresponding to the CodecId enum object, in order to avoid the dependency on vsi/videostreaminfo.proto. http://cs/symbol:CodecId%20f:google3/video/vidproc/vsi/videostreaminfo.proto | VideoAudioStream | Next tag: 10 | integer |
| contentType | Content type of the stream. Only populated with valid “acont” xtag values at the moment. Supported acont xtag values can be found in google3/video/storage/common/xtag_validation.cc. Examples: “original”, “dubbed”, “descriptive”, “commentary”, etc. | VideoAudioStream | Next tag: 10 | String |
| language | Language, examples: “eng”, “en”, “enG”, etc. | VideoAudioStream | Next tag: 10 | String |
| lengthSec | Audio length, in seconds. This value is derived from metadata in the source video, and often differs from the actual duration of any given transcode. In videos without valid timestamps, this value is not calculable, and is reported as zero. | VideoAudioStream | Next tag: 10 | float |
| loudness1770Lkfs | VideoAudioStream | Next tag: 10 | number | |
| sampleRate | Audio sample rate. | VideoAudioStream | Next tag: 10 | String |
| streamIndex | Index of the stream in the file, 0-based. | VideoAudioStream | Next tag: 10 | String |
| key | VideoClipInfo | Generic clip information contains a key string and a value string. | String | |
| value | VideoClipInfo | Generic clip information contains a key string and a value string. | String | |
| videoHasClosedCaptions | VideoClosedCaptions | boolean | ||
| anchorQbstDistance | QBST distance between the anchor and the top navboost query of the video if exists, or the video title otherwise. | VideoContentSearchAnchorCommonFeatureSet | Contains anchor level features that apply to all anchor types. Next id: 22. | number |
| asrAverageBabelSimilarityScore | Average of babel similarity between the anchor and all asr sentences. | VideoContentSearchAnchorCommonFeatureSet | Contains anchor level features that apply to all anchor types. Next id: 22. | number |
| asrMaximumBabelSimilarityScore | Maximum babel similarity between the anchor and the asr sentences. | VideoContentSearchAnchorCommonFeatureSet | Contains anchor level features that apply to all anchor types. Next id: 22. | number |
| bleurtFeatures | Features needed for Bleurt inference. | VideoContentSearchAnchorCommonFeatureSet | Contains anchor level features that apply to all anchor types. Next id: 22. | VideoContentSearchBleurtFeatures |
| bleurtScore | The Bleurt inference score generated using the bleurt_features. | VideoContentSearchAnchorCommonFeatureSet | Contains anchor level features that apply to all anchor types. Next id: 22. | number |
| descartesScoreWithTitle | Descartes similarity score between video title and anchor label. | VideoContentSearchAnchorCommonFeatureSet | Contains anchor level features that apply to all anchor types. Next id: 22. | number |
| descriptionAverageBabelSimilarityScore | Average of babel similarity between the anchor and all description sentences. | VideoContentSearchAnchorCommonFeatureSet | Contains anchor level features that apply to all anchor types. Next id: 22. | number |
| descriptionMaximumBabelSimilarityScore | Maximum babel similarity between the anchor and the description sentences. | VideoContentSearchAnchorCommonFeatureSet | Contains anchor level features that apply to all anchor types. Next id: 22. | number |
| dolphinDescriptivenessScore | The predicted descriptiveness and usefulness rating scores generated by the Unified Dolphin model. Rating template: experimental/video/video_anchors_oneside_without_thumbnail/template.jhtml | VideoContentSearchAnchorCommonFeatureSet | Contains anchor level features that apply to all anchor types. Next id: 22. | number |
| dolphinEnsembleScore | If the dolphin model is an ensemble model, this contains the scores associated to each individual ensemble model. | VideoContentSearchAnchorCommonFeatureSet | Contains anchor level features that apply to all anchor types. Next id: 22. | list(VideoContentSearchDolphinEnsembleScore) |
| dolphinFeatures | The features used to generate the Dolphin score. | VideoContentSearchAnchorCommonFeatureSet | Contains anchor level features that apply to all anchor types. Next id: 22. | VideoContentSearchDolphinFeatures |
| dolphinScore | The score generated by the Dolphin callout model. | VideoContentSearchAnchorCommonFeatureSet | Contains anchor level features that apply to all anchor types. Next id: 22. | number |
| dolphinUsefulnessScore | VideoContentSearchAnchorCommonFeatureSet | Contains anchor level features that apply to all anchor types. Next id: 22. | number | |
| labelPhraseEmbedding | A phrase embedding for the anchor label. The model used to generate the embedding can be found in VideoAnchorSets: video_score_info.common_features.label_phrase_embedding_model | VideoContentSearchAnchorCommonFeatureSet | Contains anchor level features that apply to all anchor types. Next id: 22. | list(number) |
| mumDescriptivenessScore | The predicted descriptiveness of the anchor using the MUM unified scoring model. | VideoContentSearchAnchorCommonFeatureSet | Contains anchor level features that apply to all anchor types. Next id: 22. | number |
| mumUsefulnessScore | The predicted usefulness of the anchor using the MUM unified scoring model. | VideoContentSearchAnchorCommonFeatureSet | Contains anchor level features that apply to all anchor types. Next id: 22. | number |
| retentionScore | A score that is correlated with retention probability of the interval associated with this anchor (start time to end time). Retention probability of an interval is 1 – (probability the user does not watch the interval all the way through, given they started watching it). This score may be predicted by a model, or calculated from actual retention data. | VideoContentSearchAnchorCommonFeatureSet | Contains anchor level features that apply to all anchor types. Next id: 22. | number |
| saftDocument | A saft document generated from the anchor label. | VideoContentSearchAnchorCommonFeatureSet | Contains anchor level features that apply to all anchor types. Next id: 22. | NlpSaftDocument |
| timedLabelFeatures | For annotating labels and their timing and context info. For example, this is used for anchor labels within a passage. | VideoContentSearchAnchorCommonFeatureSet | Contains anchor level features that apply to all anchor types. Next id: 22. | list(VideoContentSearchCaptionLabelFeatures) |
| timestamp | VideoContentSearchAnchorCommonFeatureSet | Contains anchor level features that apply to all anchor types. Next id: 22. | list(VideoContentSearchAnchorCommonFeatureSetLabelSpanTimestamp) | |
| titleAnchorBabelMatchScore | Babel similarity between the anchor and the video title. | VideoContentSearchAnchorCommonFeatureSet | Contains anchor level features that apply to all anchor types. Next id: 22. | number |
| asrConfidence | The ASR confidence for the label span, if available. | VideoContentSearchAnchorCommonFeatureSetLabelSpanTimestamp | When an anchor label has a long duration (for example, labels that contain multiple sentences), this field stores the mapping between label segments and the start time. | number |
| isSentenceStart | Whether or not this token is the first token in a sentence. | VideoContentSearchAnchorCommonFeatureSetLabelSpanTimestamp | When an anchor label has a long duration (for example, labels that contain multiple sentences), this field stores the mapping between label segments and the start time. | boolean |
| labelBeginCharIndex | The character index range for the span. The end index is exclusive. | VideoContentSearchAnchorCommonFeatureSetLabelSpanTimestamp | When an anchor label has a long duration (for example, labels that contain multiple sentences), this field stores the mapping between label segments and the start time. | String |
| labelEndCharIndex | VideoContentSearchAnchorCommonFeatureSetLabelSpanTimestamp | When an anchor label has a long duration (for example, labels that contain multiple sentences), this field stores the mapping between label segments and the start time. | String | |
| timeMs | The time of the span. | VideoContentSearchAnchorCommonFeatureSetLabelSpanTimestamp | When an anchor label has a long duration (for example, labels that contain multiple sentences), this field stores the mapping between label segments and the start time. | String |
| dolphinDescriptivenessStats | A summary of the Dolphin descriptiveness scores of the anchors in the set. | VideoContentSearchAnchorsCommonFeatureSet | Contains anchor set level features that apply to all anchor types. | VideoContentSearchMetricStats |
| dolphinUsefulnessStats | A summary of the Dolphin usefulness scores of the anchors in the set. | VideoContentSearchAnchorsCommonFeatureSet | Contains anchor set level features that apply to all anchor types. | VideoContentSearchMetricStats |
| mumDescriptivenessStats | A summary of the MUM descriptiveness scores of the anchors in the set. | VideoContentSearchAnchorsCommonFeatureSet | Contains anchor set level features that apply to all anchor types. | VideoContentSearchMetricStats |
| mumUsefulnessStats | A summary of the MUM usefulness scores of the anchors in the set. | VideoContentSearchAnchorsCommonFeatureSet | Contains anchor set level features that apply to all anchor types. | VideoContentSearchMetricStats |
| hasMissingStarburst | Whether or not any of the anchor thumbnails have missing Starburst embeddings. | VideoContentSearchAnchorsThumbnailInfo | boolean | |
| hasMissingThumbnails | Whether or not any of the anchors have missing thumbnails. | VideoContentSearchAnchorsThumbnailInfo | boolean | |
| thumbnailDiversity | A score representing how diverse a set of thumbnails is. This is currently defined as one minus the median pairwise cosine similarity between thumbnail Starburst embeddings. | VideoContentSearchAnchorsThumbnailInfo | number | |
| imagesearchDocid | Serving docid for the thumbnail in the images-tbn tables. | VideoContentSearchAnchorThumbnail | Properties of the thumbnail image to show for an anchor. | String |
| isThumbnailMissing | Set to true when no thumbnail could be generated for this anchor. | VideoContentSearchAnchorThumbnail | Properties of the thumbnail image to show for an anchor. | boolean |
| servingMetadata | Metadata about the anchor thumbnail computed by Amarna, including dimensions and the size in bytes. | VideoContentSearchAnchorThumbnail | Properties of the thumbnail image to show for an anchor. | ImageBaseThumbnailMetadata |
| thumbnailInfo | Information about the thumbnail anchor. | VideoContentSearchAnchorThumbnail | Properties of the thumbnail image to show for an anchor. | VideoContentSearchAnchorThumbnailInfo |
| timestampMs | Millisecond timestamp of the frame used for the thumbnail. | VideoContentSearchAnchorThumbnail | Properties of the thumbnail image to show for an anchor. | integer |
| colorEntropy | Entropy of the clustered color distribution. | VideoContentSearchAnchorThumbnailInfo | number | |
| imageData | Thumbnail image data for SafeSearch classification. | VideoContentSearchAnchorThumbnailInfo | ImageData | |
| isUnsafe | Convenience field that consolidates signals for whether this thumbnail is safe. | VideoContentSearchAnchorThumbnailInfo | boolean | |
| starburstV4Embedding | 64d float vector of starburst v4 embedings. | VideoContentSearchAnchorThumbnailInfo | DrishtiDenseFeatureData | |
| thumbnailBytes | The raw data for a thumbnail. | VideoContentSearchAnchorThumbnailInfo | String | |
| fallbackAspect | Product aspect to be used if non of the other aspects exist. | VideoContentSearchAspect | Product aspect. | String |
| saftAspect | Product aspect produced by running SAFT annotation. | VideoContentSearchAspect | Product aspect. | String |
| confidence | The confidence score of the token: between 0 and 1. | VideoContentSearchAsrCaption | Contains token-level information about ASR captions. | number |
| durationMs | The duration that the token is spoken for. | VideoContentSearchAsrCaption | Contains token-level information about ASR captions. | number |
| startTimeMs | The time in the video at which the token starts being spoken. | VideoContentSearchAsrCaption | Contains token-level information about ASR captions. | integer |
| text | The speech token. | VideoContentSearchAsrCaption | Contains token-level information about ASR captions. | String |
| candidate | VideoContentSearchBleurtFeatures | Contains features needed for Bleurt inference. | String | |
| reference | VideoContentSearchBleurtFeatures | Contains features needed for Bleurt inference. | String | |
| asrMentionText | If the description anchor has been recognized as an entity and that entity has also been mention in the ASR, this is the mention text from the ASR. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | String |
| asrMentionTranscriptOffset | The start index of the ASR entity mention from the beginning of the ASR transcript. The index is included so that individual mentions that share the same mid and time can be distinguished which happens when an entity is mentioned multiple times in an ASR sentence. Each mid/asr_mention_transcript_offset will be unique. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | integer |
| asrSentence | The nearest ASR sentence. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | String |
| asrStartTime | The begin time in ms of the ASR sentence. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | integer |
| bertScores | The result of the BERT inference using the title, ASR sentence and entity mention text. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | list(number) |
| broadness | A score to help determine how specific this entity is. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | number |
| durationCoverage | The percentage of the video covered by the span of the first mention to the last mention. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | number |
| entityConnectedness | The webref connectedness score of the entity. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | number |
| entityDescription | A short text describing the entity. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | String |
| entityInfo | Information about how many documents the entity occurred in and how many total mentions the entity has across the entire video corpus. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | VideoContentSearchCaptionEntityDocInfo |
| entityMentionInDescription | Whether or not the entity mention text appears in the description of the video. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | boolean |
| estimatedMentionTime | The estimated begin time in ms of the entity mention using the text offset divided by the ASR duration. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | integer |
| groupCohesion | Average similarity between this anchor and other anchors in the set. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | number |
| hypernymConfidence | The confidence of the hypernym used as the set label. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | number |
| hypernymCount | Number of hypernyms used for calculating similarity. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | number |
| hyperpediaSalientTermsSimilarity | The cosine similarity between the document salient terms and the hyperpedia hypernyms for a given entity. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | number |
| inWebrefEntities | Whether or not this entity is in the webref entities. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | boolean |
| isOracleEntity | True if the given entity appears as an Oracle followup query. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | boolean |
| isProduct | Whether this entity counts as a ‘product’ for the purpose of dividing entities between the ‘related topics’ and ‘products in this video’ features. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | boolean |
| maxMentionConfidence | The maximum confidence of all of the entity mentions in the transcript. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | number |
| mentionConfidence | The confidence that the ASR mention matches the given mid. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | number |
| mentions | Number of times an entity is mentioned in the ASR transcript. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | integer |
| msFromLastAnchor | The duration in ms between this anchor and the previous anchor or the beginning of the video if this is the first anchor. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | integer |
| nextAsrSentence | The ASR sentence after asr_sentence or “” if it is the last sentence. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | String |
| otherAsrMentionText | The ASR text of each mention of the entity. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | list(String) |
| otherEstimatedMentionTimes | Each time the entity was mentioned. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | list(integer) |
| previousAsrSentence | The ASR sentence before asr_sentence or “” if it is the first sentence. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | String |
| trustedNameConfidence | The confidence that the ASR mention is a trusted name. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | number |
| webrefEntityTopicality | The webref entity topicality score if the entity is a webref entity and 0 if not. | VideoContentSearchCaptionEntityAnchorFeatures | Features and debug info for individual caption entity video anchors. | number |
| aggregateScore | The total score used for filtering and selecting entity sets. | VideoContentSearchCaptionEntityAnchorSetFeatures | Features and debug info for clusters of caption entity video anchors. | number |
| clusterSize | The prefiltered size of the entity set. | VideoContentSearchCaptionEntityAnchorSetFeatures | Features and debug info for clusters of caption entity video anchors. | integer |
| entitiesInWebrefEntities | The number of entities in the anchor set that are in the webref entities. | VideoContentSearchCaptionEntityAnchorSetFeatures | Features and debug info for clusters of caption entity video anchors. | integer |
| entityMentionInDescriptionCount | The number of anchors where the entity mention text appears in the description of the video. | VideoContentSearchCaptionEntityAnchorSetFeatures | Features and debug info for clusters of caption entity video anchors. | boolean |
| groupCohesion | The average cosine similarity between hypernyms of members of the set. | VideoContentSearchCaptionEntityAnchorSetFeatures | Features and debug info for clusters of caption entity video anchors. | number |
| hypernym | The most prominent hypernym across the entities in the set. | VideoContentSearchCaptionEntityAnchorSetFeatures | Features and debug info for clusters of caption entity video anchors. | String |
| hypernymSalience | The salience of the best hypernym for the set. | VideoContentSearchCaptionEntityAnchorSetFeatures | Features and debug info for clusters of caption entity video anchors. | number |
| medianMentions | Median number of times any member of the set was mentioned in the ASR transcript. | VideoContentSearchCaptionEntityAnchorSetFeatures | Features and debug info for clusters of caption entity video anchors. | integer |
| mentionSalience | Mentions divided by the total number of entity mentions in the video. | VideoContentSearchCaptionEntityAnchorSetFeatures | Features and debug info for clusters of caption entity video anchors. | number |
| salience | Salience of the set computed by aggregating the hypernyms from each member and calculating the cosine similarity with the salient terms. | VideoContentSearchCaptionEntityAnchorSetFeatures | Features and debug info for clusters of caption entity video anchors. | number |
| topHypernym | The top N hypernyms for the entities in the set. | VideoContentSearchCaptionEntityAnchorSetFeatures | Features and debug info for clusters of caption entity video anchors. | list(String) |
| totalMentions | Number of times any member of the group was mentioned in the ASR transcript. | VideoContentSearchCaptionEntityAnchorSetFeatures | Features and debug info for clusters of caption entity video anchors. | integer |
| entityDocCount | The number of documents where this entity was mentioned at least once. | VideoContentSearchCaptionEntityDocInfo | Contains information about document appearances of an entity. | String |
| entityMentionCount | The number of times the entity was mentioned across the entire corpus. | VideoContentSearchCaptionEntityDocInfo | Contains information about document appearances of an entity. | String |
| mid | The entity id. | VideoContentSearchCaptionEntityDocInfo | Contains information about document appearances of an entity. | String |
| totalDocCount | The number of documents in the corpus. | VideoContentSearchCaptionEntityDocInfo | Contains information about document appearances of an entity. | String |
| totalMentionCount | The number of mentions of any entity across the entire corpus. | VideoContentSearchCaptionEntityDocInfo | Contains information about document appearances of an entity. | String |
| asrCaption | VideoContentSearchCaptionInfo | Contains transcript-level data about a video whether it comes from ASR or closed captions. | list(VideoContentSearchAsrCaption) | |
| saftDocument | VideoContentSearchCaptionInfo | Contains transcript-level data about a video whether it comes from ASR or closed captions. | NlpSaftDocument | |
| alignedOcrTexts | OCR anchors with overlapping time-window with this anchor | VideoContentSearchCaptionLabelFeatures | Contains timing and text for a given label. | list(VideoContentSearchOCRText) |
| alignedTime | The time stamp in milliseconds for the reference text (e.g. description anchor time). | VideoContentSearchCaptionLabelFeatures | Contains timing and text for a given label. | String |
| contextText | Text around the aligned_time of a long duration, say [-15 minutes, +15 minutes] | VideoContentSearchCaptionLabelFeatures | Contains timing and text for a given label. | String |
| labelText | The main label text for the feature. | VideoContentSearchCaptionLabelFeatures | Contains timing and text for a given label. | String |
| textSimilarityFeatures | Identified matching text by similarity. | VideoContentSearchCaptionLabelFeatures | Contains timing and text for a given label. | VideoContentSearchTextSimilarityFeatures |
| textSpanAtAlignedTime | The text span in the passage starting from the aligned time. | VideoContentSearchCaptionLabelFeatures | Contains timing and text for a given label. | String |
| dolphinFeatures | The features used to construct the inference example. | VideoContentSearchCaptionSpanAnchorFeatures | VideoContentSearchSpanDolphinFeatures | |
| dolphinScores | The inference result from the Dolphin span model. | VideoContentSearchCaptionSpanAnchorFeatures | VideoContentSearchSpanDolphinScores | |
| embeddingDistance | Embedding distances (e.g. cosine distance) to the other anchors of the same video. | VideoContentSearchCaptionSpanAnchorFeatures | list(number) | |
| postGapInMs | Time gap in ms to the next anchor. Always positive number. | VideoContentSearchCaptionSpanAnchorFeatures | integer | |
| preGapInMs | Time gap in ms to the previous anchor. Always a positive number. | VideoContentSearchCaptionSpanAnchorFeatures | integer | |
| saftBeginTokenIndex | The range of tokens in video_info.saft_doc for the anchor label. | VideoContentSearchCaptionSpanAnchorFeatures | integer | |
| saftEndTokenIndex | VideoContentSearchCaptionSpanAnchorFeatures | integer | ||
| saftTranscriptEndCharOffset | VideoContentSearchCaptionSpanAnchorFeatures | integer | ||
| saftTranscriptStartCharOffset | The range of characters in video_info.saft_transcript for the anchor label. | VideoContentSearchCaptionSpanAnchorFeatures | integer | |
| spanAsrConfidenceStats | A summary of the ASR confidence for the selected candidate. | VideoContentSearchCaptionSpanAnchorFeatures | VideoContentSearchMetricStats | |
| spanDolphinScore | A summary of the Dolphin span token scores for the selected candidate. | VideoContentSearchCaptionSpanAnchorFeatures | VideoContentSearchMetricStats | |
| wordCount | Word count of the span text, tokenized with SAFT. | VideoContentSearchCaptionSpanAnchorFeatures | integer | |
| anchorSetDolphinScoreStats | A summary of the dolphin scores over the anchor set. | VideoContentSearchCaptionSpanAnchorSetFeatures | VideoContentSearchMetricStats | |
| replies | VideoContentSearchCommentAnchorSetFeatures | A message containing set-level comment anchor features. Next ID: 3 | list(VideoContentSearchCommentAnchorSetFeaturesComment) | |
| rootComment | VideoContentSearchCommentAnchorSetFeatures | A message containing set-level comment anchor features. Next ID: 3 | VideoContentSearchCommentAnchorSetFeaturesComment | |
| commentId | The ID that YouTube uses to uniquely identify the comment. | VideoContentSearchCommentAnchorSetFeaturesComment | A structure that represents a comment. Fields 1 through 6 are designed to store responses from the 3P YouTube Data API (see https://developers.google.com/youtube/v3/docs/comments). Field 7 is used to store the Google-internal representation of the comment; if it is populated, then all other fields may be empty. Next ID: 8 | String |
| likeCount | The total number of likes (positive ratings) the comment has received. | VideoContentSearchCommentAnchorSetFeaturesComment | A structure that represents a comment. Fields 1 through 6 are designed to store responses from the 3P YouTube Data API (see https://developers.google.com/youtube/v3/docs/comments). Field 7 is used to store the Google-internal representation of the comment; if it is populated, then all other fields may be empty. Next ID: 8 | integer |
| miniStanza | The MiniStanza object that represents the comment. If populated, all other fields in this message may be empty. | VideoContentSearchCommentAnchorSetFeaturesComment | A structure that represents a comment. Fields 1 through 6 are designed to store responses from the 3P YouTube Data API (see https://developers.google.com/youtube/v3/docs/comments). Field 7 is used to store the Google-internal representation of the comment; if it is populated, then all other fields may be empty. Next ID: 8 | YoutubeCommentsClusteringMiniStanza |
| publishedAt | The date and time when the comment was orignally published, specified in ISO 8601 format. | VideoContentSearchCommentAnchorSetFeaturesComment | A structure that represents a comment. Fields 1 through 6 are designed to store responses from the 3P YouTube Data API (see https://developers.google.com/youtube/v3/docs/comments). Field 7 is used to store the Google-internal representation of the comment; if it is populated, then all other fields may be empty. Next ID: 8 | String |
| textDisplay | The comment’s text, in HTML. | VideoContentSearchCommentAnchorSetFeaturesComment | A structure that represents a comment. Fields 1 through 6 are designed to store responses from the 3P YouTube Data API (see https://developers.google.com/youtube/v3/docs/comments). Field 7 is used to store the Google-internal representation of the comment; if it is populated, then all other fields may be empty. Next ID: 8 | String |
| textOriginal | The original, raw text of the comment. | VideoContentSearchCommentAnchorSetFeaturesComment | A structure that represents a comment. Fields 1 through 6 are designed to store responses from the 3P YouTube Data API (see https://developers.google.com/youtube/v3/docs/comments). Field 7 is used to store the Google-internal representation of the comment; if it is populated, then all other fields may be empty. Next ID: 8 | String |
| updatedAt | The date and time when the comment was last updated, specified in ISO 8601 format. | VideoContentSearchCommentAnchorSetFeaturesComment | A structure that represents a comment. Fields 1 through 6 are designed to store responses from the 3P YouTube Data API (see https://developers.google.com/youtube/v3/docs/comments). Field 7 is used to store the Google-internal representation of the comment; if it is populated, then all other fields may be empty. Next ID: 8 | String |
| entityTextCoverage | When the description anchor text has been recognized as an entity, how much of the description anchor text is covered by the entity mention. | VideoContentSearchDescriptionAnchorFeatures | number | |
| inAsr | Whether or not a mention of the description anchor exists in the ASR. | VideoContentSearchDescriptionAnchorFeatures | boolean | |
| isDescriptionAnchor | Whether or not the anchor was created from the description for use in training data. This will be set to true for positive examples and false for negative examples. | VideoContentSearchDescriptionAnchorFeatures | boolean | |
| spanToAsrTime | The distance from the ASR sentence to the description anchor time in ms. | VideoContentSearchDescriptionAnchorFeatures | integer | |
| asrAnchorCount | The number of description anchors that were matched to captions in the ASR. | VideoContentSearchDescriptionAnchorSetFeatures | integer | |
| asrAnchorFraction | The fraction of anchors that were matched to captions in the ASR. | VideoContentSearchDescriptionAnchorSetFeatures | number | |
| uniqueAsrMidCount | The number of unique mids which where matched to description anchors. | VideoContentSearchDescriptionAnchorSetFeatures | integer | |
| contextTokenCount | The number of tokens in the context (sentence) where the description span is extracted from. | VideoContentSearchDescriptionSpanInfo | Metadata about the span when the anchor source is description span. | integer |
| dolphinScores | The inference result from the Dolphin span model if the anchor’s source is description span. | VideoContentSearchDescriptionSpanInfo | Metadata about the span when the anchor source is description span. | VideoContentSearchSpanDolphinScores |
| spanDolphinScoreStats | A summary of the Dolphin span token scores for the selected candidate. Currently, dolphin_scores in DescriptionSpanInfo would only contain a single span candidate so this field is essentially the copy of the score_stats for that span candidate. | VideoContentSearchDescriptionSpanInfo | Metadata about the span when the anchor source is description span. | VideoContentSearchMetricStats |
| spanTokenCount | The number of tokens in the description span. The description span is formed from non-contiguous segment spans of a sentence (context), where each segment span’s score satifsies the min span thresholds. | VideoContentSearchDescriptionSpanInfo | Metadata about the span when the anchor source is description span. | integer |
| spanTokenCountRatio | The ratio of span_token_count / context_token_count. | VideoContentSearchDescriptionSpanInfo | Metadata about the span when the anchor source is description span. | number |
| dolphinScore | The score generated by the Dolphin callout model. | VideoContentSearchDolphinEnsembleScore | Contains information about the scores from each individual dolphin ensemble model. | number |
| modelName | VideoContentSearchDolphinEnsembleScore | Contains information about the scores from each individual dolphin ensemble model. | String | |
| altQuery | The alt query used for building the Dolphin example. | VideoContentSearchDolphinFeatures | String | |
| answer | The answer used for building the Dolphin example. | VideoContentSearchDolphinFeatures | String | |
| query | The query used for building the Dolphin example. | VideoContentSearchDolphinFeatures | String | |
| timeMs | The time stamp of the video anchor in milliseconds. | VideoContentSearchDolphinFeatures | String | |
| title | The title used for building the Dolphin example. | VideoContentSearchDolphinFeatures | String | |
| url | The url of the video. | VideoContentSearchDolphinFeatures | String | |
| descriptivenessOutputKey | The output put keys for Dolphin PredictResponse | VideoContentSearchDolphinScoringConfig | String | |
| ensembleModelNames | If the dolphin model is an ensemble model (e.g. Video QnA model which consists of 4 teacher models), stores each individual model name. | VideoContentSearchDolphinScoringConfig | list(String) | |
| inferenceBatchSize | The inference batch size to use for inference methods that handle batching. | VideoContentSearchDolphinScoringConfig | integer | |
| inferenceMethod | The method to use for inference. This must be set or inference will fail. | VideoContentSearchDolphinScoringConfig | String | |
| maxRpcRetries | Holds value of flag –max_rpc_retries. | VideoContentSearchDolphinScoringConfig | integer | |
| modelName | Model name used for ModelSpec in PredictRequest used in the PredictionService API. | VideoContentSearchDolphinScoringConfig | String | |
| modelPath | Only used when using the bulk_inference API. See go/dolphin-models to learn about the different dolphin models. | VideoContentSearchDolphinScoringConfig | String | |
| outputKey | TODO(alexiaxu) To deprecate this field in the future Output key for Dolphin PredictResponse. | VideoContentSearchDolphinScoringConfig | String | |
| rpcDeadlineSeconds | Holds value of flag –rpc_deadline (converted to seconds). | VideoContentSearchDolphinScoringConfig | float | |
| serviceBns | Tensorflow inference BNS address when using PredictionService API. | VideoContentSearchDolphinScoringConfig | String | |
| usefulnessOutputKey | VideoContentSearchDolphinScoringConfig | String | ||
| category | The Webref category that this entity belongs to e.g. “/moka/software”. | VideoContentSearchEntityAnnotations | Entity annotations for one of the mids representing an anchor label or a query text. | String |
| confidence | The overall confidence that this entity is annotated somewhere in the label. | VideoContentSearchEntityAnnotations | Entity annotations for one of the mids representing an anchor label or a query text. | number |
| isRestricted | Whether or not this entity belongs to a set of blocklisted categories. | VideoContentSearchEntityAnnotations | Entity annotations for one of the mids representing an anchor label or a query text. | boolean |
| mid | The Webref entity mid. | VideoContentSearchEntityAnnotations | Entity annotations for one of the mids representing an anchor label or a query text. | String |
| collectionId | Collection id. | VideoContentSearchEntityGroupInfo | String | |
| label | Label for this anchor group. | VideoContentSearchEntityGroupInfo | String | |
| frameSimilarity | The similarity between this topic and starburst features for frames in [frames[frame_level_starburst_start_index], frames[frame_level_starburst_start_index + len(frame_similarity)]. | VideoContentSearchFrameSimilarityInterval | Frame-level similarities info for each topic for an interval of frames. | list(number) |
| framesEndTimestampMs | Timestamp in milliseconds for the last frame in this frame interval. | VideoContentSearchFrameSimilarityInterval | Frame-level similarities info for each topic for an interval of frames. | String |
| framesStarburstStartIndex | The index of the first frame within this interval of similar frames. VideoMultimodalTopicFeatures.frame_starburst_data. | VideoContentSearchFrameSimilarityInterval | Frame-level similarities info for each topic for an interval of frames. | integer |
| framesStartTimestampMs | Timestamp in milliseconds for the first frame in this frame interval. | VideoContentSearchFrameSimilarityInterval | Frame-level similarities info for each topic for an interval of frames. | String |
| denseVector | Raw float feature vector of the starburst representation. | VideoContentSearchFrameStarburstData | Starburst frame-level dense data. | list(number) |
| sbVersion | Starburst version. Possible values are: STARBURST_TEXT_V4 STARBURST_TEXT_V4_5 STARBURST_TEXT_V4_PLC STARBURST_TEXT_V5 | VideoContentSearchFrameStarburstData | Starburst frame-level dense data. | String |
| timestampMs | Timestamp in milliseconds for this frame. | VideoContentSearchFrameStarburstData | Starburst frame-level dense data. | String |
| passage | Features for inferences from generative models. | VideoContentSearchGenerativePredictionFeatures | String | |
| predictions | Inference results. | VideoContentSearchGenerativePredictionFeatures | list(String) | |
| target | VideoContentSearchGenerativePredictionFeatures | String | ||
| groundTruthTopic | This field is present if we already have a ground truth topic from the training data. | VideoContentSearchGenerativeTopicPredictionFeatures | The inference result features coming from the prediction service that generates the topics. | String |
| modelName | The name of the model where the predictions come from. | VideoContentSearchGenerativeTopicPredictionFeatures | The inference result features coming from the prediction service that generates the topics. | String |
| predictions | Inference results from the prediction service. Since we generally use beam search with beam_size > 1, this field is repeated to capture all the generated topic beams. | VideoContentSearchGenerativeTopicPredictionFeatures | The inference result features coming from the prediction service that generates the topics. | list(String) |
| bestAsrAndDescriptionAnchorsMatchInfo | The match info about the description anchor matches with the ASR n-grams in the instruction passage. Each element represents the best match between a given description anchor and all qualified n-grams within the passage. | VideoContentSearchInstructionTrainingDataAnchorFeatures | Anchor-level metadata about the instruction anchors. Each instruction passage anchor can contain multiple instruction steps and multiple description anchors and thus the following fields are defined as repeated. | list(VideoContentSearchSimilarityMatchInfo) |
| bestDescriptionAndInstructionAnchorsMatchInfo | The match info about the description anchor matches with the instruction anchors in a instruction passage. Each element represents the best match between a given description anchor and all the instruction anchors in the passage. | VideoContentSearchInstructionTrainingDataAnchorFeatures | Anchor-level metadata about the instruction anchors. Each instruction passage anchor can contain multiple instruction steps and multiple description anchors and thus the following fields are defined as repeated. | list(VideoContentSearchSimilarityMatchInfo) |
| instructionAnchorsMatchInfo | The match info about the instruction steps matches with the ASR. Each instruction step corresponds to a step extracted from a web doc. Each instruction passage can contain multiple instruction step matches thus the repeated field. | VideoContentSearchInstructionTrainingDataAnchorFeatures | Anchor-level metadata about the instruction anchors. Each instruction passage anchor can contain multiple instruction steps and multiple description anchors and thus the following fields are defined as repeated. | list(VideoContentSearchSimilarityMatchInfo) |
| babelMatch | The babel match info of the list anchor with its matched ASR text. | VideoContentSearchListAnchorFeatures | Anchor-level Metadata about list description anchors. | VideoContentSearchTextMatchInfo |
| descriptionSpanInfo | The description span metadata about list anchor when the anchor source is DESCRIPTION_SPANS. | VideoContentSearchListAnchorFeatures | Anchor-level Metadata about list description anchors. | VideoContentSearchDescriptionSpanInfo |
| listItemIndex | The list item index of this anchor in the video description. | VideoContentSearchListAnchorFeatures | Anchor-level Metadata about list description anchors. | integer |
| matchScores | The metadata about this list item’s matches with different ASR snippets. This is currently used in the base model (DTW) to generate candidate anchors. | VideoContentSearchListAnchorFeatures | Anchor-level Metadata about list description anchors. | list(VideoContentSearchMatchScores) |
| pretriggerScore | The score from the pretrigger model. | VideoContentSearchListAnchorFeatures | Anchor-level Metadata about list description anchors. | number |
| titleAnchorBabelMatchScore | Babel similarity between the anchor and the video title. | VideoContentSearchListAnchorFeatures | Anchor-level Metadata about list description anchors. | number |
| aggregatedSpanText | The following fields are used for description span anchors, The aggregated span token texts over all the span candidates of the anchor set. | VideoContentSearchListAnchorSetFeatures | Cluster-level Metadata about list anchors. Next id: 15. | String |
| anchorSetSpanScoreStats | A summary of the span scores over the anchor set. This summary is calculated over the aggregation of the individual token spans belonging to the span candidates of anchors. | VideoContentSearchListAnchorSetFeatures | Cluster-level Metadata about list anchors. Next id: 15. | VideoContentSearchMetricStats |
| babelMatchScoreStats | Median, average and standard deviation of babel_match_score among anchors in the same VideoAnchors cluster. | VideoContentSearchListAnchorSetFeatures | Cluster-level Metadata about list anchors. Next id: 15. | VideoContentSearchMetricStats |
| contextTokenCountStats | A summary of the context token counts over the anchor set. | VideoContentSearchListAnchorSetFeatures | Cluster-level Metadata about list anchors. Next id: 15. | VideoContentSearchMetricStats |
| durationSpanRatio | The ratio of anchors timespan duration over the total duration of the video. Anchors timespan duration is defined as the time span from the first anchor to the last anchor in VideoAnchors. | VideoContentSearchListAnchorSetFeatures | Cluster-level Metadata about list anchors. Next id: 15. | number |
| durationToPredictedTimeMsStats | Median, average and standard deviation of duration_to_predicted_time_ms among anchors in the same VideoAnchors cluster. | VideoContentSearchListAnchorSetFeatures | Cluster-level Metadata about list anchors. Next id: 15. | VideoContentSearchMetricStats |
| listAnchorSource | The source of anchors extracted from the video descriptions. | VideoContentSearchListAnchorSetFeatures | Cluster-level Metadata about list anchors. Next id: 15. | String |
| listDescriptionItemsSize | The total number of list items mentioned in the video description. Not all these list items are necessarily found as list anchors. | VideoContentSearchListAnchorSetFeatures | Cluster-level Metadata about list anchors. Next id: 15. | integer |
| matchedListDescriptionAnchorsRatio | The number of matched anchors in the list anchors over the total number of post-filtering list items in the video description, i.e. matched_list_description_anchors_ratio = matched_list_description_anchors_size / post_filtering_list_description_items_size. | VideoContentSearchListAnchorSetFeatures | Cluster-level Metadata about list anchors. Next id: 15. | number |
| matchedListDescriptionAnchorsSize | The number of matched list anchors found in the ASR. The matched list anchors are a subset of the post-filtering list items in the video description, and as such matched_list_description_anchors_size <= post_filtering_list_description_items_size. | VideoContentSearchListAnchorSetFeatures | Cluster-level Metadata about list anchors. Next id: 15. | integer |
| postFilteringListDescriptionItemsSize | The total number of list items in the video description that are actually considered for matching. This is a subset of list items in the video description that passed filterings such as language filtering, i.e. post_filtering_list_description_items_size <= list_description_items_size | VideoContentSearchListAnchorSetFeatures | Cluster-level Metadata about list anchors. Next id: 15. | integer |
| pretriggerScoreStats | Median, average and standard deviation of pretrigger_score among anchors in the same cluster. | VideoContentSearchListAnchorSetFeatures | Cluster-level Metadata about list anchors. Next id: 15. | VideoContentSearchMetricStats |
| spanTokenCountRatioStats | A summary of the span token count ratios over the anchor set. | VideoContentSearchListAnchorSetFeatures | Cluster-level Metadata about list anchors. Next id: 15. | VideoContentSearchMetricStats |
| spanTokenCountStats | A summary of the span token counts over the anchor set. | VideoContentSearchListAnchorSetFeatures | Cluster-level Metadata about list anchors. Next id: 15. | VideoContentSearchMetricStats |
| descriptionAnchorTimeMs | The timestamp of when the description anchor is annotated to appear in the video in ms. | VideoContentSearchListTrainingDataAnchorFeatures | Anchor-level metadata about the description anchors used as list items to build training data for list anchors. | integer |
| descriptionAnchorTimeToMatchedTimeMs | The time gap of when the description anchor is annotated to appear in the video (description_anchor_time_ms) from when it’s matched in the ASR as the list anchor. | VideoContentSearchListTrainingDataAnchorFeatures | Anchor-level metadata about the description anchors used as list items to build training data for list anchors. | String |
| editDistance | Closest edit distance between the anchor generated by description span and the description anchor where the span anchor must be within small threshold time difference of the description anchor timestamp. | VideoContentSearchListTrainingDataAnchorFeatures | Anchor-level metadata about the description anchors used as list items to build training data for list anchors. | integer |
| editDistanceRatio | edit_distance over the description anchor’s label length. | VideoContentSearchListTrainingDataAnchorFeatures | Anchor-level metadata about the description anchors used as list items to build training data for list anchors. | number |
| matchedDescriptionText | The description anchor text used for matching to Span anchor text. | VideoContentSearchListTrainingDataAnchorFeatures | Anchor-level metadata about the description anchors used as list items to build training data for list anchors. | String |
| matchedSpanText | The description span anchor text that was the best match for the nearby description anchor. | VideoContentSearchListTrainingDataAnchorFeatures | Anchor-level metadata about the description anchors used as list items to build training data for list anchors. | String |
| editDistanceRatioStats | Summary of the edit_distance_ratios of the description spans from their best matched description anchor texts. | VideoContentSearchListTrainingDataSetFeatures | Cluster-level metadata about the description anchors used as list items to build training data for list anchors. | VideoContentSearchMetricStats |
| editDistanceStats | Summary of the edit_distances of the description spans from their best matched description anchor texts. | VideoContentSearchListTrainingDataSetFeatures | Cluster-level metadata about the description anchors used as list items to build training data for list anchors. | VideoContentSearchMetricStats |
| matchedDescriptionAnchorsTimegapStats | Median, average and standard deviation of time gaps of when the description anchors is annotated to appear in the video (description_anchor_time_ms) from when they are matched in the ASR as the list description anchors. | VideoContentSearchListTrainingDataSetFeatures | Cluster-level metadata about the description anchors used as list items to build training data for list anchors. | VideoContentSearchMetricStats |
| numDescriptionAnchors | Number of description anchors in the description of this video. | VideoContentSearchListTrainingDataSetFeatures | Cluster-level metadata about the description anchors used as list items to build training data for list anchors. | integer |
| matchInfo | VideoContentSearchMatchScores | list(VideoContentSearchTextMatchInfo) | ||
| method | The method used for matching, e.g. ‘babel’, ‘nlp’, ‘neon’, ßß’phonetic’. | VideoContentSearchMatchScores | String | |
| max | VideoContentSearchMetricStats | Median, mean and standard deviation of a feature value. | number | |
| mean | VideoContentSearchMetricStats | Median, mean and standard deviation of a feature value. | number | |
| median | VideoContentSearchMetricStats | Median, mean and standard deviation of a feature value. | number | |
| min | VideoContentSearchMetricStats | Median, mean and standard deviation of a feature value. | number | |
| stddev | VideoContentSearchMetricStats | Median, mean and standard deviation of a feature value. | number | |
| sum | VideoContentSearchMetricStats | Median, mean and standard deviation of a feature value. | number | |
| frameSimilarityInterval | The list of frame sequence similarities to this topic. The list of frames are picked to be around the topic timestamp. The set of frames selected are thresholded at a value to ensure the selected frame intervals are similar to the query. | VideoContentSearchMultimodalTopicFeatures | Multimodal features for a single generated topic. Next ID: 8 | list(VideoContentSearchFrameSimilarityInterval) |
| generativeTopicPredictionFeatures | The inference results from the prediction services that generate the topics. | VideoContentSearchMultimodalTopicFeatures | Multimodal features for a single generated topic. Next ID: 8 | list(VideoContentSearchGenerativeTopicPredictionFeatures) |
| navboostAnchorFeatures | Features related to queries generated using document navboost data with timed anchors. Only populated if the query was generated using this approach. | VideoContentSearchMultimodalTopicFeatures | Multimodal features for a single generated topic. Next ID: 8 | VideoContentSearchNavboostAnchorFeatures |
| topic | The text of the generated topic. | VideoContentSearchMultimodalTopicFeatures | Multimodal features for a single generated topic. Next ID: 8 | String |
| topicEndMs | End time of the topic. | VideoContentSearchMultimodalTopicFeatures | Multimodal features for a single generated topic. Next ID: 8 | String |
| topicStartMs | Start time of the topic. | VideoContentSearchMultimodalTopicFeatures | Multimodal features for a single generated topic. Next ID: 8 | String |
| videoQuerySource | How the query was generated. | VideoContentSearchMultimodalTopicFeatures | Multimodal features for a single generated topic. Next ID: 8 | String |
| maxFrameSimilarityInterval | The similarity info for the frame with maximum similarity to the topic in its visual interval. The repeated similarity field in this proto has a single value corresponding to the maximum similarity. This similarity score is used to filter and pick the training data examples. | VideoContentSearchMultimodalTopicTrainingFeatures | Multimodal features for a single generated topic used to build training data. | VideoContentSearchFrameSimilarityInterval |
| normalizedTopic | The topic/query normalized for Navboost and QBST lookups as well as fetching of the Rankembed nearest neighbors. | VideoContentSearchMultimodalTopicTrainingFeatures | Multimodal features for a single generated topic used to build training data. | String |
| qbstTermsOverlapFeatures | QBST terms overlap features for a candidate query. | VideoContentSearchMultimodalTopicTrainingFeatures | Multimodal features for a single generated topic used to build training data. | VideoContentSearchQbstTermsOverlapFeatures |
| rankembedNearestNeighborsFeatures | Rankembed similarity features for a candidate nearest neighbor rankembed query. | VideoContentSearchMultimodalTopicTrainingFeatures | Multimodal features for a single generated topic used to build training data. | VideoContentSearchRankEmbedNearestNeighborsFeatures |
| saftEntityInfo | The information about the saft entity annotation for this topic. | VideoContentSearchMultimodalTopicTrainingFeatures | Multimodal features for a single generated topic used to build training data. | VideoContentSearchSaftEntityInfo |
| topicDenseVector | Raw float feature vector of the topic’s co-text embedding representation in the Starburst space. | VideoContentSearchMultimodalTopicTrainingFeatures | Multimodal features for a single generated topic used to build training data. | list(number) |
| entityType | Type name: e.g. /saft/person for a person’s name. | VideoContentSearchNamedEntity | Message for SAFT named entities. | String |
| text | Text referring to an entity of type entity_type; | VideoContentSearchNamedEntity | Message for SAFT named entities. | String |
| anchorText | The anchor text used in the generated query. | VideoContentSearchNavboostAnchorFeatures | Features for queries generated using document navboost data with timed anchors. | String |
| navboostText | The navboost query used in the generated query. | VideoContentSearchNavboostAnchorFeatures | Features for queries generated using document navboost data with timed anchors. | String |
| source | How the navboost-anchor query was constructed. | VideoContentSearchNavboostAnchorFeatures | Features for queries generated using document navboost data with timed anchors. | String |
| minCharEditDistance | The minimum char edit distance between the normalized OCR text and candidate word strings taken from a time window around the OCR appearance. | VideoContentSearchOcrAsrFeature | integer | |
| minCharEditDistanceAsrText | The matched ASR candidate for minimum char edit distance. | VideoContentSearchOcrAsrFeature | String | |
| minCharEditDistancePercent | The min_char_edit_distance divided by the length of the OCR string. | VideoContentSearchOcrAsrFeature | number | |
| ocrTextNormalizedForCharMatch | The normalized OCR text which was used to match the candidate. | VideoContentSearchOcrAsrFeature | String | |
| ocrTextNormalizedForCharMatchLength | The length of the normalized OCR text. | VideoContentSearchOcrAsrFeature | integer | |
| pretriggerScore | The score from the pretrigger model. | VideoContentSearchOcrAsrFeature | number | |
| wordOverlapAsrText | The ASR text that was used for the word overlap calculation. | VideoContentSearchOcrAsrFeature | String | |
| wordOverlapCount | The number of words found both in the OCR text and the ASR in a time window around OCR appearance. | VideoContentSearchOcrAsrFeature | integer | |
| wordOverlapPercent | The word_overlap_count divided by the number of words in the OCR text. | VideoContentSearchOcrAsrFeature | number | |
| normalizedWordOverlapScore | The word_overlap_score divided by the greatest word_overlap_score for any cluster in the VideoAnchorSets. | VideoContentSearchOcrAsrSetFeature | number | |
| wordOverlapScore | A score based on the number of overlapped words between the OCR and ASR for anchors in the cluster. | VideoContentSearchOcrAsrSetFeature | number | |
| editDistance | The string edit distance from the anchor label to the nearest OCR text. | VideoContentSearchOcrDescriptionTrainingDataAnchorFeatures | Metadata about the join of description anchors and OCR data which is used to build training data. | integer |
| editDistanceRatio | edit_distance over the description anchor’s label length. | VideoContentSearchOcrDescriptionTrainingDataAnchorFeatures | Metadata about the join of description anchors and OCR data which is used to build training data. | number |
| matchedDescriptionText | The description anchor text used for matching to OCR text. | VideoContentSearchOcrDescriptionTrainingDataAnchorFeatures | Metadata about the join of description anchors and OCR data which is used to build training data. | String |
| matchedFrameTimeMs | The time of the selected OCR frame in ms. The best frame in a window around the target description anchor will be selected. | VideoContentSearchOcrDescriptionTrainingDataAnchorFeatures | Metadata about the join of description anchors and OCR data which is used to build training data. | integer |
| matchedOcrText | The OCR text that was the best match for the nearby description anchor. | VideoContentSearchOcrDescriptionTrainingDataAnchorFeatures | Metadata about the join of description anchors and OCR data which is used to build training data. | String |
| maxEditDistance | The max edit distance of any description anchor to its closest OCR text. | VideoContentSearchOcrDescriptionTrainingDataSetFeatures | Metadata about the join of description anchors and OCR data for a set of description anchors. | integer |
| maxEditDistanceRatio | The maximum of (edit distance of any description anchor to its closest OCR text over description anchor label length). | VideoContentSearchOcrDescriptionTrainingDataSetFeatures | Metadata about the join of description anchors and OCR data for a set of description anchors. | number |
| medianEditDistance | The median edit distance of any description anchor to its closest OCR text. | VideoContentSearchOcrDescriptionTrainingDataSetFeatures | Metadata about the join of description anchors and OCR data for a set of description anchors. | integer |
| ocrFeature | Additional details about position/font/color etc. for the OCR text | VideoContentSearchOCRText | Contains OCR text, its start time and additional details about position/fonts | VideoContentSearchOnScreenTextFeature |
| ocrText | The OCR recognized text label | VideoContentSearchOCRText | Contains OCR text, its start time and additional details about position/fonts | String |
| timeMs | The time in ms at which the OCR text appears on the frame | VideoContentSearchOCRText | Contains OCR text, its start time and additional details about position/fonts | String |
| averageTextAreaRatio | Average text area ratio throughout video frames. Text area ratio for a frame is defined by sum(text area) / image area. | VideoContentSearchOcrVideoFeature | Features for video level info. | number |
| clusterIdToFrameSize | Cluster id to the num of frames in each cluster. | VideoContentSearchOcrVideoFeature | Features for video level info. | map |
| durationInMs | Total time of this video in milliseconds. | VideoContentSearchOcrVideoFeature | Features for video level info. | integer |
| langIdDetectedLanguage | Video level detected language by lang id, aggregated from each frame. | VideoContentSearchOcrVideoFeature | Features for video level info. | String |
| numClusters | The number of ShotInfo clusters. | VideoContentSearchOcrVideoFeature | Features for video level info. | integer |
| numFrames | The number of video frames contained in ShotInfo cluster. | VideoContentSearchOcrVideoFeature | Features for video level info. | integer |
| ocrDetectedLanguage | Video level detected language, aggregated from each frame. | VideoContentSearchOcrVideoFeature | Features for video level info. | String |
| averageConfidence | Average confidence. | VideoContentSearchOnScreenTextClusterFeature | Features for the set of OnScreenText. | number |
| averageDurationRatio | VideoContentSearchOnScreenTextClusterFeature | Features for the set of OnScreenText. | number | |
| averageHorizontalPosition | VideoContentSearchOnScreenTextClusterFeature | Features for the set of OnScreenText. | number | |
| averageOcrTextLength | Deprecated. Please use ocr_text_length_stats.median instead. The average length of anchor labels. average_ocr_text_length is deprecated, because now ocr_text_length_stats has a field for holding the same value. | VideoContentSearchOnScreenTextClusterFeature | Features for the set of OnScreenText. | number |
| averageOfAverageTextHeightRatio | Deprecated. Please use text_height_ratio_stats.mean instead. Average value of text height ratio (over image height), which is taken average over the same text. average_of_average_text_height_ratio is deprecated, because now text_height_ratio_stats has a field for keeping the same value. | VideoContentSearchOnScreenTextClusterFeature | Features for the set of OnScreenText. | number |
| averageVerticalPosition | Average of label center position. | VideoContentSearchOnScreenTextClusterFeature | Features for the set of OnScreenText. | number |
| clusterRatio | The number of anchors in the cluster over the number of anchors in the video. | VideoContentSearchOnScreenTextClusterFeature | Features for the set of OnScreenText. | number |
| clusterSize | The number of anchors in the cluster. | VideoContentSearchOnScreenTextClusterFeature | Features for the set of OnScreenText. | integer |
| countingNumberRatio | The number of anchors that had a counting number over the number of anchors in total. | VideoContentSearchOnScreenTextClusterFeature | Features for the set of OnScreenText. | number |
| durationMsStats | Median, average and standard deviation of duration_ms among anchors in the same cluster. | VideoContentSearchOnScreenTextClusterFeature | Features for the set of OnScreenText. | VideoContentSearchMetricStats |
| frameSizeRatio | Frame size ratio over total frames in video. | VideoContentSearchOnScreenTextClusterFeature | Features for the set of OnScreenText. | number |
| logOcrTextLengthStats | Average and standard deviation of logarithm of the length of labels among anchors in the same cluster. | VideoContentSearchOnScreenTextClusterFeature | Features for the set of OnScreenText. | VideoContentSearchMetricStats |
| logTextHeightRatioStats | Average and standard deviation of log(average_text_height_ratio) among anchors in the same cluster. | VideoContentSearchOnScreenTextClusterFeature | Features for the set of OnScreenText. | VideoContentSearchMetricStats |
| logp1000DurationMsStats | Average and standard deviation of log(1000 + duration_ms) among anchors in the same cluster. Since duration_ms can be zero, 1000 is added before applying logarithm. | VideoContentSearchOnScreenTextClusterFeature | Features for the set of OnScreenText. | VideoContentSearchMetricStats |
| maxVideoDurationRatioBetweenAnchors | The maximum ratio of duration between two consecutive anchors to video duration. This is calculated after all anchor filtering has been completed. | VideoContentSearchOnScreenTextClusterFeature | Features for the set of OnScreenText. | number |
| maximumDurationRatio | Stats for ratio of frame time intervals, over total video time. | VideoContentSearchOnScreenTextClusterFeature | Features for the set of OnScreenText. | number |
| medianClusteringDistance | The median cluster distance for the anchors in the cluster. The way the distance is calculated will vary depending on the clustering method. | VideoContentSearchOnScreenTextClusterFeature | Features for the set of OnScreenText. | number |
| medianDurationRatio | VideoContentSearchOnScreenTextClusterFeature | Features for the set of OnScreenText. | number | |
| medianOfAverageTextHeightRatio | Deprecated. Please use text_height_ratio_stats.median instead. Median value of text height ratio (over image height), which is taken average over the same text. median_of_average_text_height_ratio is deprecated, because now text_height_ratio_stats has a field for keeping the same value. | VideoContentSearchOnScreenTextClusterFeature | Features for the set of OnScreenText. | number |
| ocrAsrFeature | Features for the overlap between OCR and ASR. | VideoContentSearchOnScreenTextClusterFeature | Features for the set of OnScreenText. | VideoContentSearchOcrAsrSetFeature |
| ocrTextLengthStats | Median, average and standard deviation of the length of labels among anchors in the same cluster. | VideoContentSearchOnScreenTextClusterFeature | Features for the set of OnScreenText. | VideoContentSearchMetricStats |
| stddevDurationRatio | VideoContentSearchOnScreenTextClusterFeature | Features for the set of OnScreenText. | number | |
| textHeightRatioStats | Median, average and standard deviation of average_text_height_ratio among anchors in the same cluster. | VideoContentSearchOnScreenTextClusterFeature | Features for the set of OnScreenText. | VideoContentSearchMetricStats |
| shotInfoCountDuringText | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | integer | |
| averageFontweight | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | number | |
| countingNumber | Counting number in this anchor’s original label. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | integer |
| backgroundBlue | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | number | |
| relativeShotTimeMsPriorToEndTime | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | integer | |
| topOcrLanguage | OCR language that has the highest weight. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | String |
| relativeShotTimeMsPosteriorToStartTime | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | integer | |
| averageAngle | The average of rotation angles (degree) of texts. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | number |
| durationMs | Duration time in millisec. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | integer |
| centerVerticalPositionRatio | Vertical position of the center of this text, by ratio [0.0, 1.0]. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | number |
| countingNumberOooRatio | # of numbered anchors that are not out-of-order / # of all the numbered anchors. If no counting number is detected, this will be empty. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | number |
| medianClusteringDistance | The median distance between this anchor and other anchors in the cluster. The way the distance is calculated will vary depending on the clustering method. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | number |
| foregroundRed | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | number | |
| handwrittenTextRatio | # of LINE entities that are recognized as handwritten texts over # of merged LINE entities. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | number |
| averageFontsize | Font size or weight information. This is extracted from internal message, so may not be available in future. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | number |
| backgroundGreen | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | number | |
| averageHeightRatio | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | number | |
| occurrenceRatio | occurrence_count over the number of anchors merged to this anchor. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | number |
| backgroundRed | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | number | |
| nTextsInSameFrame | # of OCR texts that appear in the same frame. If duration of this OCR text is not zero, the maximum number among multiple frames where this OCR text appears is set to this field. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | integer |
| relativeShotTimeMsPriorToStartTime | Shot boundary time nearest to OnScreenText’s start and end time. The time is relative to each OnScreenText’s start / end time (ex. -1 means shot time exists prior to the start / end time). If shot time and start/end time is the same, 0 is set in ‘prior’ field. If no shot info is available, the below fields are not set. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | integer |
| originalLabel | The label this VideoAnchor originally had before label clearning steps. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | String |
| countingNumberPrefix | Prefix for counting number in this anchor’s label. If no counting number is detected, this will be empty. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | String |
| relativeShotTimeMsPosteriorToEndTime | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | integer | |
| centerHorizontalPositionRatio | Horizontal position of the center of this text, by ratio [0.0, 1.0]. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | number |
| averageConfidence | Average value of confidence. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | number |
| occurrenceCount | The number of OCR texts that have the same text among temporally-merged OCR texts. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | number |
| mergedLineCount | The number of LINE entities used for this text. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | integer |
| boxHeightRatio | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | number | |
| ocrAsrFeature | Features for the overlap between OCR and ASR. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | VideoContentSearchOcrAsrFeature |
| hadUrlInLabel | Whether or not this anchor had URL in its label before the label fixing step. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | boolean |
| leftPositionRatio | Left position of this text, by ratio [0, 1]. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | number |
| backgroundGray | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | number | |
| isCountingNumberOoo | Whether or not the counting number in this anchor’s label is out-of-order. If no counting number is detected, this will be empty. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | boolean |
| topPositionRatio | Note that top-left position is (0, 0) for position values. Top position of this text, by ratio [0, 1]. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | number |
| foregroundGray | Color information, normalized to [0-1]. This color information is extracted from the largest word in the line entities of PageLayout message. See goodoc::PageLayoutEntity::Colors for details. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | number |
| foregroundGreen | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | number | |
| languages | Languages predicted by OCR. “repeated” is employed for this field because LINE entities of PageLayout message are sometimes annotated with multiple languages, and also two VideoAnchor that are annotated with different languages can be merged into one VideoAnchor. When two VideoAnchor are merged into one, the weight field values of the new VideoAnchor will be the average of weight field values weighted by merged_line_count. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | list(GoodocLanguageCombinationLanguage) |
| foregroundBlue | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | number | |
| countingNumberSuffix | Suffix for counting number in this anchor’s label. If no counting number is detected, this will be empty. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | String |
| boxWidthRatio | Box width and height ratio, against to the frame size, so the value range is [0, 1]. If this text feature consists of multiple text boxes, the box width / height is a union of each text box. | VideoContentSearchOnScreenTextFeature | Keep feature values which are useful to filter titles, labels. | number |
| qbstAnchorOverlap | Fraction of salient terms of original query covered by anchor text. | VideoContentSearchQbstTermsOverlapFeatures | QBST terms overlap features for the candidate query. | number |
| qbstNavboostOverlap | Fraction of salient terms of original query covered by top navboost query of the video. | VideoContentSearchQbstTermsOverlapFeatures | QBST terms overlap features for the candidate query. | number |
| answer | Segment of text from the ASR. | VideoContentSearchQnaAnchorFeatures | Features for individual Q&A anchors. Next ID: 23 | String |
| descartesDotScore | VideoContentSearchQnaAnchorFeatures | Features for individual Q&A anchors. Next ID: 23 | number | |
| descartesRankingScore | VideoContentSearchQnaAnchorFeatures | Features for individual Q&A anchors. Next ID: 23 | number | |
| dolphinModelType | VideoContentSearchQnaAnchorFeatures | Features for individual Q&A anchors. Next ID: 23 | String | |
| dolphinScore | Dolphin score calculated using the question as the query, the ASR passage as the answer. See go/dolphin-models to learn more. | VideoContentSearchQnaAnchorFeatures | Features for individual Q&A anchors. Next ID: 23 | number |
| editDistance | Edit distance of the question and the title from 0 to 1 where 1 is most similar. | VideoContentSearchQnaAnchorFeatures | Features for individual Q&A anchors. Next ID: 23 | number |
| endMs | End time in milliseconds relative to the beginning of the video. | VideoContentSearchQnaAnchorFeatures | Features for individual Q&A anchors. Next ID: 23 | String |
| ensembleScore | VideoContentSearchQnaAnchorFeatures | Features for individual Q&A anchors. Next ID: 23 | number | |
| isDuplicateOfTitle | True if question_title_similarity is less than 0.2. | VideoContentSearchQnaAnchorFeatures | Features for individual Q&A anchors. Next ID: 23 | boolean |
| neonScore | Neon similarity of question and title. | VideoContentSearchQnaAnchorFeatures | Features for individual Q&A anchors. Next ID: 23 | number |
| pointwiseNormalizedGapScore | Pointwise GAP normalized score. Score ranges from 0 to 1 and corresponds to GAP precision. See go/wa-cgap-to-pgap-migration to learn more. | VideoContentSearchQnaAnchorFeatures | Features for individual Q&A anchors. Next ID: 23 | number |
| qbstScore | QBST similarity of question and title. | VideoContentSearchQnaAnchorFeatures | Features for individual Q&A anchors. Next ID: 23 | number |
| queryCount | NavBoostFeature f_query_count for questions that are NavBoost queries. | VideoContentSearchQnaAnchorFeatures | Features for individual Q&A anchors. Next ID: 23 | number |
| queryDocCount | NavBoostFeature f_query_doc_count for questions that are NavBoost queries. | VideoContentSearchQnaAnchorFeatures | Features for individual Q&A anchors. Next ID: 23 | number |
| question | Question from Related Questions SSTable or NavBoost. | VideoContentSearchQnaAnchorFeatures | Features for individual Q&A anchors. Next ID: 23 | String |
| questionTitleSimilarity | VideoContentSearchQnaAnchorFeatures | Features for individual Q&A anchors. Next ID: 23 | number | |
| questionType | VideoContentSearchQnaAnchorFeatures | Features for individual Q&A anchors. Next ID: 23 | String | |
| startMs | Start time in milliseconds relative to the beginning of the video. | VideoContentSearchQnaAnchorFeatures | Features for individual Q&A anchors. Next ID: 23 | String |
| videoDurationMs | Duration of the video. | VideoContentSearchQnaAnchorFeatures | Features for individual Q&A anchors. Next ID: 23 | String |
| videoTitle | Video title. | VideoContentSearchQnaAnchorFeatures | Features for individual Q&A anchors. Next ID: 23 | String |
| webrefMid | Mid corresponding to the WebRef entity from the CDoc that was used to source the question. | VideoContentSearchQnaAnchorFeatures | Features for individual Q&A anchors. Next ID: 23 | String |
| webrefTopicalityScore | The WebRef entity topicality score. Learn more about this score at: http://go/topicality-score | VideoContentSearchQnaAnchorFeatures | Features for individual Q&A anchors. Next ID: 23 | number |
| backgroundEncodingPath | Path to Descartes background encoding in the form of a serialized drishti.DenseFeatureData proto. This is generated by the flume_generate_background_encoding binary. | VideoContentSearchQnaAnchorSetFeatures | Debug info for Q&A anchors. Next ID: 15 | String |
| descartesModelVersion | This field is used for debugging which model the decartes_model_score is generated from. You can learn more about the Descartes model at go/descartes-qa. | VideoContentSearchQnaAnchorSetFeatures | Debug info for Q&A anchors. Next ID: 15 | String |
| descartesScoreThreshold | Descartes score threshold for determining whether to output a QA pair as an anchor. This currently effects only the Descartes ranking score. | VideoContentSearchQnaAnchorSetFeatures | Debug info for Q&A anchors. Next ID: 15 | number |
| dolphinConfig | The configuration used for fetching Dolphin scores. | VideoContentSearchQnaAnchorSetFeatures | Debug info for Q&A anchors. Next ID: 15 | VideoContentSearchDolphinScoringConfig |
| ensembleModelPath | Path to Ranklab ensemble model used in post-trigger step. | VideoContentSearchQnaAnchorSetFeatures | Debug info for Q&A anchors. Next ID: 15 | String |
| ensembleModelScoreThreshold | Minimum score for video anchor to pass the post-trigger step. Calculated by training a logisitic regression model with 95% precision. Training colab can be found at go/video-qa-ensemble. | VideoContentSearchQnaAnchorSetFeatures | Debug info for Q&A anchors. Next ID: 15 | number |
| minEntityTopicalityScore | Threshold for determining whether to consider an entity from a CDoc for sourcing questions on that topic. Learn more about this score at: http://go/topicality-score | VideoContentSearchQnaAnchorSetFeatures | Debug info for Q&A anchors. Next ID: 15 | number |
| minQuestionDistance | Threshold for determining whether questions belong in the same cluster. | VideoContentSearchQnaAnchorSetFeatures | Debug info for Q&A anchors. Next ID: 15 | number |
| relatedQuestionsSstablePath | Path to the Related Questions SSTable that maps entities to questions. | VideoContentSearchQnaAnchorSetFeatures | Debug info for Q&A anchors. Next ID: 15 | String |
| spanDurationSecs | The duration threshold for merging captions. | VideoContentSearchQnaAnchorSetFeatures | Debug info for Q&A anchors. Next ID: 15 | String |
| anchorReSimilarity | Rankembed similarity between the rankembed neighbor and the video anchor. | VideoContentSearchRankEmbedNearestNeighborsFeatures | Rankembed neighbor neighbor features for the candidate query. | number |
| navQueryReSimilarity | Rankembed similarity between the rankembed neighbor and the top navboost query of the video. | VideoContentSearchRankEmbedNearestNeighborsFeatures | Rankembed neighbor neighbor features for the candidate query. | number |
| reSimilarity | Rankembed similarity between the rankembed neighbor and the original query candidate. | VideoContentSearchRankEmbedNearestNeighborsFeatures | Rankembed neighbor neighbor features for the candidate query. | number |
| canonicalEntityName | Representative canonical name for the entity. | VideoContentSearchSaftEntityInfo | Saft named-entities info for a given topic. | String |
| entitySalience | Score indicating the saliency (centrality) of this entity to the original_text. | VideoContentSearchSaftEntityInfo | Saft named-entities info for a given topic. | float |
| entityTypeName | The type name, like “/saft/person”, “/saft/art”. See README.entity-types for the inventory of SAFT type tags. | VideoContentSearchSaftEntityInfo | Saft named-entities info for a given topic. | String |
| mentionText | Representative entity name mention extracted from original_text. | VideoContentSearchSaftEntityInfo | Saft named-entities info for a given topic. | String |
| mentionType | SAFT Mention type. | VideoContentSearchSaftEntityInfo | Saft named-entities info for a given topic. | String |
| mid | Freebase MID for entity if this the saft entity corresponds to a Webref KG mid. This field is not always populated and is taken from FREEBASE_MID mid in EntityProfile in the saft entity annotation. | VideoContentSearchSaftEntityInfo | Saft named-entities info for a given topic. | String |
| originalText | The original input text (e.g. the anchor text) where the saft entity annotation was run on. | VideoContentSearchSaftEntityInfo | Saft named-entities info for a given topic. | String |
| asrForProConExtraction | The asr with sentence break that was used for pro/con extraction. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | String |
| snippetWordCount | The number of words in the ASR for the selected segment window. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | integer |
| snippetQaScore | The QA model score for the selected segment window against the question. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | number |
| anchorLabelSentiment | The sentiment score of the anchor label, with range: [-1, 1]. If using Lumin Pro/Con tags as the anchor labels, the “Pro” Lumin tag will have a score of 1 and Con Lumin tag will have a score of -1. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | number |
| productNameFromTitle | The product name from title extracted by the grampus model. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | String |
| snippetSubSegmentQaScore | The QA model score for the best sub segment against the question. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | number |
| anchorLabelFirstMentionPos | The first anchor_label mention position (word index, 0-based). It is computed from the snippet_sub_segment if exists. Otherwise it is computed from the snippet. It is not populated if there is no such mention. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | integer |
| babelSimilarityScore | The Babel similarity score between the snippet and the anchor label. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | number |
| conScore | The classification score of the anchor being a con opinion. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | number |
| isPro | Whether the anchor is classified as a pro opinion. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | boolean |
| luminAspectWordsMentions | The number of times words in Lumin aspect (that is not a stopword) being mentioned in the snippet. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | integer |
| mumScore | The score from the MUM model if the pro/con anchor is extracted by MUM. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | number |
| grampusScore | The score from the Grampus model if the pro/con is extracted by Grampus. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | number |
| snippetSubSegment | The ASR for the best matched sub segment inside the selected segment. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | String |
| snippetSentimentScore | The go/scarlett sentiment score of the selected segment window. Positive score represents positive sentiment. Negative score represents negative sentiment. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | number |
| luminAspect | The lumin aspect of the Pro/Con Lumin tag. e.g. “weight”. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | String |
| question | The question used to score this video segment. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | String |
| snippetSubSegmentSentimentScore | The go/scarlett sentiment score of the best matched sub segment. Positive score represents positive sentiment. Negative score represents negative sentiment. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | number |
| opinionsDolphinUsefulnessScore | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | number | |
| snippetSubSegmentWordCount | The number of words in the ASR for the best matched sub segment. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | integer |
| mumProductAspect | The product aspect of the pro/con generated using the MUM model. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | String |
| luminScore | The Lumin model score for the anchor label against the segment. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | number |
| isCon | Whether the anchor is classified as a con opinion. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | boolean |
| anchorOrAspectWordsMentions | The number of times words in anchor label or Lumin aspect (that is not a stopword) being mentioned in the snippet. If a word exists in both anchor label and Lumin aspect, it shall be only counted once for a mention in the snippet. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | integer |
| aspect | Product aspect being discussed by this Shopping Opinions. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | VideoContentSearchAspect |
| proScore | The classification score of the anchor being a pro opinion. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | number |
| snippet | The ASR for the selected segment window. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | String |
| anchorOrAspectFirstMentionPos | The smaller number of anchor_label_first_mention_pos and lumin_aspect_first_mention_pos. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | integer |
| isProConWhenExtractedFromMum | True if the anchor is considered as pro or con when extracted from MUM. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | boolean |
| luminAspectFirstMentionPos | The first Lumin aspect mention position (word index, 0-based). It is computed from the snippet_sub_segment if exists. Otherwise it is computed from the snippet. It is not populated if there is no such mention. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | integer |
| opinionsDolphinDescriptivenessScore | Scores from Opinions Dolphin scorer. Opinions Dolphin scorer is built by finetuning the Dolphin-based Video Anchor Unified Scorer V2 on the Opinions anchors ratings. It outputs two scores, which are optimized for descriptiveness and usefulness ratings respectively. ‘descriptiveness_score’ measures how well the anchor label describes the video section. ‘usefulness_score’ measures how useful the anchor label is for jumping to an important section in the video. go/vs-opinions-migration-report | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | number |
| anchorLabel | The anchor label. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | String |
| anchorLabelWordsMentions | The number of times words in anchor label (that is not a stopword) being mentioned in the snippet. | VideoContentSearchShoppingOpinionsAnchorFeatures | Features for an individual Shopping Opinions Anchor. This file is used for video anchor use case. Next Id: 34 | integer |
| instructionStartMs | The timestamp of when the first token in the token sequence is spoken in the video. | VideoContentSearchSimilarityMatchInfo | integer | |
| instructionText | The instruction step text coming from the web document. Currently only populated for best_description_and_instruction_anchors_match_info. | VideoContentSearchSimilarityMatchInfo | String | |
| referenceText | The reference text used for matching against token_sequence (e.g. description anchor text or instruction step text). | VideoContentSearchSimilarityMatchInfo | String | |
| referenceTextTimeMs | The timestamp of when the reference text is pointing in the video (e.g. this is the description anchor timestamp when reference_text is description anchor. For instruction step used as the reference, no timestamps exists and thus this field is not populated). | VideoContentSearchSimilarityMatchInfo | integer | |
| scoringMethodName | Similarity scorer name. | VideoContentSearchSimilarityMatchInfo | String | |
| similarityScore | The similarity score given by the scoring method specified by the message scoring_method_name. | VideoContentSearchSimilarityMatchInfo | number | |
| stepIndex | The index of the step in HowToInstructions that this token_sequence corresponds to. | VideoContentSearchSimilarityMatchInfo | integer | |
| tokenSequence | The matched token sequence text in ASR. | VideoContentSearchSimilarityMatchInfo | String | |
| tokenSequenceLength | The length of the tokens in the token sequence. | VideoContentSearchSimilarityMatchInfo | integer | |
| tokenStartPos | The token offset of the matched token sequence from the beginning of the document. | VideoContentSearchSimilarityMatchInfo | integer | |
| passage | The text passage from ASR. | VideoContentSearchSpanDolphinFeatures | String | |
| title | The title of the video. | VideoContentSearchSpanDolphinFeatures | String | |
| spanCandidate | The span candidates extracted from the list of span tokens. Each token is added to a span if its score is above a certain threshold. | VideoContentSearchSpanDolphinScores | list(VideoContentSearchSpanDolphinScoresSpanCandidate) | |
| spanToken | The token-score pairs for the passage. | VideoContentSearchSpanDolphinScores | list(VideoContentSearchSpanDolphinScoresSpanToken) | |
| asrConfidenceStats | A summary of the token asr_confidence scores that make up the candidate. | VideoContentSearchSpanDolphinScoresSpanCandidate | VideoContentSearchMetricStats | |
| scoreStats | A summary of the token scores that make up the candidate. | VideoContentSearchSpanDolphinScoresSpanCandidate | VideoContentSearchMetricStats | |
| sourcePassage | The passage text from which this span candidate belongs to. In case of description spans, this field stores the sentence containing the span candidate where the sentence is a subset of the passage used for generating the span candidate. | VideoContentSearchSpanDolphinScoresSpanCandidate | String | |
| text | The span candidate text. | VideoContentSearchSpanDolphinScoresSpanCandidate | String | |
| timeMs | The start time for the span candidate. | VideoContentSearchSpanDolphinScoresSpanCandidate | String | |
| asrConfidence | The ASR confidence for the token, if available. | VideoContentSearchSpanDolphinScoresSpanToken | number | |
| isSentenceStart | Whether or not this token is the first token in a sentence. | VideoContentSearchSpanDolphinScoresSpanToken | boolean | |
| score | A score correlated with the probability that the token is part of a span candidate. | VideoContentSearchSpanDolphinScoresSpanToken | number | |
| text | The token text. | VideoContentSearchSpanDolphinScoresSpanToken | String | |
| timeMs | The start time of the passage with this token. | VideoContentSearchSpanDolphinScoresSpanToken | String | |
| prefilterClassificationLabel | The Prefilter classification label associated with the video that contains the VideoAnchorSets this object is asociated with. E.g. “basketball”. | VideoContentSearchSportsKeyMomentsAnchorSetFeatures | Features for a set of Sports Key Moments (SKM) Anchors. Each instance of this object should be associated with a VideoAnchorSets object. Next ID: 3 | String |
| tensorflowModelVersion | Version of the underlying TensorFlow model. | VideoContentSearchSportsKeyMomentsAnchorSetFeatures | Features for a set of Sports Key Moments (SKM) Anchors. Each instance of this object should be associated with a VideoAnchorSets object. Next ID: 3 | String |
| durationToPredictedTimeMs | The time gap of the matched_time_ms from the predicted timestamp of when this anchor should appear in the video. | VideoContentSearchTextMatchInfo | String | |
| matchScore | The float similarty score from the anchor label to matched_asr_text. | VideoContentSearchTextMatchInfo | number | |
| matchedAsrStartPos | The start token offset from the beginning of ASR where matched_asr_text starts. | VideoContentSearchTextMatchInfo | integer | |
| matchedAsrText | The ASR text that was a candidate match for the list anchor. | VideoContentSearchTextMatchInfo | String | |
| matchedAsrTimeMs | The timestamp of the matched ASR in the video in milliseconds. | VideoContentSearchTextMatchInfo | String | |
| matchedAsrTimeRatio | The ratio of the matched_asr_time_ms over the total duration of the video. | VideoContentSearchTextMatchInfo | number | |
| matchedAsrTokenCount | The number of tokens in matched_asr_text | VideoContentSearchTextMatchInfo | integer | |
| matchedDescriptionItemIndexRatio | The ratio of the video description item index this match corresponds to over the total number of list description items for the video. | VideoContentSearchTextMatchInfo | number | |
| matchedDescriptionText | The video description text matched with the ASR that’s used as the anchor label. | VideoContentSearchTextMatchInfo | String | |
| matchedDescriptionTokenCount | The number of tokens in matched_description_text. | VideoContentSearchTextMatchInfo | integer | |
| hypothesisText | The hypothesis text that was used for the token overlap calculation. | VideoContentSearchTextSimilarityFeatures | String | |
| hypothesisTextTime | The time in ms for the hypothesis_text. | VideoContentSearchTextSimilarityFeatures | String | |
| referenceText | VideoContentSearchTextSimilarityFeatures | String | ||
| scoringMethodName | Similarity scorer name. | VideoContentSearchTextSimilarityFeatures | String | |
| similarityScore | The similarity score given by the scoring method specified by the message scoring_method_name. | VideoContentSearchTextSimilarityFeatures | number | |
| tokenMatchCount | Token by token matching stats. Exact matched token count. | VideoContentSearchTextSimilarityFeatures | integer | |
| tokenMatchPercent | The token_overlap_count divided by the number of tokens in the hypothesis text. | VideoContentSearchTextSimilarityFeatures | number | |
| wordAlignment | Word by word alignment. | VideoContentSearchTextSimilarityFeatures | list(VideoContentSearchTokenAlignment) | |
| hypothesisIndex | Index of the token in hypothesis text. | VideoContentSearchTokenAlignment | Token by token mapping between hypothesis text and reference text. | integer |
| hypothesisToken | Token in hypothesis. | VideoContentSearchTokenAlignment | Token by token mapping between hypothesis text and reference text. | String |
| referenceIndex | Index of the word in reference. | VideoContentSearchTokenAlignment | Token by token mapping between hypothesis text and reference text. | integer |
| referenceToken | Token in label. | VideoContentSearchTokenAlignment | Token by token mapping between hypothesis text and reference text. | String |
| tokenIsMatched | Whether it’s a perfect match. | VideoContentSearchTokenAlignment | Token by token mapping between hypothesis text and reference text. | boolean |
| confidence | Generated from th PseudoVideoData Timestamp Confidence field, which is quantized values in range 0-127. To convert to range 0-1 this field divides the PseudoVideoData Timestamp Confidence field by 127. | VideoContentSearchTokenTimingInfo | Token level timing information for ASR spans. This is expected to be extracted from PseudoVideoData in the CDoc. Next ID: 5 | number |
| durationMs | VideoContentSearchTokenTimingInfo | Token level timing information for ASR spans. This is expected to be extracted from PseudoVideoData in the CDoc. Next ID: 5 | String | |
| startMs | VideoContentSearchTokenTimingInfo | Token level timing information for ASR spans. This is expected to be extracted from PseudoVideoData in the CDoc. Next ID: 5 | String | |
| text | Should be a single token. | VideoContentSearchTokenTimingInfo | Token level timing information for ASR spans. This is expected to be extracted from PseudoVideoData in the CDoc. Next ID: 5 | String |
| skipPatternStartOffsetInput | startOffset_input name as defined in https://schema.org/SeekToAction | VideoContentSearchVideoActions | Video level info for online pipeline usage. For example: skip pattern as defined in https://schema.org/SeekToAction. | String |
| skipToTimePattern | Skip to time pattern as defined in https://schema.org/SeekToAction | VideoContentSearchVideoActions | Video level info for online pipeline usage. For example: skip pattern as defined in https://schema.org/SeekToAction. | String |
| anchorScore | The score indicating anchor confidence. | VideoContentSearchVideoAnchor | Next ID: 23 | number |
| anchorType | Specifies the type of the anchor. | VideoContentSearchVideoAnchor | Next ID: 23 | String |
| contextText | Context text from ASR of long duration, used for longT5 models. | VideoContentSearchVideoAnchor | Next ID: 23 | String |
| destinationUrl | When set, this is the link that should be used when clicking on a video anchor. This should jump to the given time in the video. | VideoContentSearchVideoAnchor | Next ID: 23 | String |
| duration | The duration of the video anchor in milliseconds. | VideoContentSearchVideoAnchor | Next ID: 23 | String |
| entityScore | The score indicating the usefulness of the entity identified by ‘mid’. | VideoContentSearchVideoAnchor | Next ID: 23 | number |
| filterReason | If is_filtered is true, this field illustrates the reasons. | VideoContentSearchVideoAnchor | Next ID: 23 | list(String) |
| isFiltered | If true, the anchor is filtered and not served online. | VideoContentSearchVideoAnchor | Next ID: 23 | boolean |
| isSafe | Convenience field that consolidates signals for whether this label is safe. | VideoContentSearchVideoAnchor | Next ID: 23 | boolean |
| isScutiBad | whether this label is bad by go/scuti | VideoContentSearchVideoAnchor | Next ID: 23 | boolean |
| label | The text label of the video anchor. | VideoContentSearchVideoAnchor | Next ID: 23 | String |
| labelScore | The score indicating label confidence. | VideoContentSearchVideoAnchor | Next ID: 23 | number |
| mid | The mid of the video anchor. | VideoContentSearchVideoAnchor | Next ID: 23 | String |
| namedEntity | Specifies named enitities the label has. | VideoContentSearchVideoAnchor | Next ID: 23 | list(VideoContentSearchNamedEntity) |
| precisionScore | The precision for which the anchor should trigger. For example, if the desired precision is 95%, anchors with precision_score < 0.95 should be removed. | VideoContentSearchVideoAnchor | Next ID: 23 | number |
| scoreInfo | Additional scoring info used for debugging. | VideoContentSearchVideoAnchor | Next ID: 23 | VideoContentSearchVideoAnchorScoreInfo |
| starburstFeatures | Visual tokens for the anchor. Eg. starbust feature vectors for several frames concatenated together. | VideoContentSearchVideoAnchor | Next ID: 23 | VideoContentSearchVisualFeatures |
| thumbnail | Data about the thumbnail to display for this anchor. | VideoContentSearchVideoAnchor | Next ID: 23 | VideoContentSearchAnchorThumbnail |
| thumbnailUrl | The url for a frame to display for this anchor. | VideoContentSearchVideoAnchor | Next ID: 23 | String |
| time | The time stamp of the video anchor in milliseconds. | VideoContentSearchVideoAnchor | Next ID: 23 | String |
| tokenTimingInfo | Timing info for each token in the anchor label. | VideoContentSearchVideoAnchor | Next ID: 23 | list(VideoContentSearchTokenTimingInfo) |
| averageBookmarkUsefulness | Average score of bookmark usefulness. | VideoContentSearchVideoAnchorRatingScore | Aggregated rating score, used in training pipeline, etc. | number |
| averageDescriptionQuality | Average score of description quality. | VideoContentSearchVideoAnchorRatingScore | Aggregated rating score, used in training pipeline, etc. | number |
| furballUrl | Furball URL(s) of the rating score (may have been rated more than once) | VideoContentSearchVideoAnchorRatingScore | Aggregated rating score, used in training pipeline, etc. | list(String) |
| anchorType | VideoContentSearchVideoAnchors | A video can have a list of text anchors, which have different anchor types. Next ID: 15 | String | |
| entityGroupInfo | The list of entity groups derived from the caption entities. | VideoContentSearchVideoAnchors | A video can have a list of text anchors, which have different anchor types. Next ID: 15 | VideoContentSearchEntityGroupInfo |
| experimentalPredictedQuerylessTocUsefulness | Same as above, but used for experimenting with new models. | VideoContentSearchVideoAnchors | A video can have a list of text anchors, which have different anchor types. Next ID: 15 | number |
| filterReason | If is_filtered is true, this field illustrates the reasons. | VideoContentSearchVideoAnchors | A video can have a list of text anchors, which have different anchor types. Next ID: 15 | list(String) |
| isFiltered | If true, the anchor set is filtered and not served online. | VideoContentSearchVideoAnchors | A video can have a list of text anchors, which have different anchor types. Next ID: 15 | boolean |
| mergedAnchorsSources | The anchor sources being used to generate this merged anchors. This field is filled only when this is a merged anchor. | VideoContentSearchVideoAnchors | A video can have a list of text anchors, which have different anchor types. Next ID: 15 | list(String) |
| predictedQuerylessTocUsefulness | The score that predicts the usefulness of this anchor set on the Huh table of contents eval without considering the query. | VideoContentSearchVideoAnchors | A video can have a list of text anchors, which have different anchor types. Next ID: 15 | number |
| score | The quality of the anchor set. | VideoContentSearchVideoAnchors | A video can have a list of text anchors, which have different anchor types. Next ID: 15 | number |
| scoreInfo | Additional scoring info used for debugging. | VideoContentSearchVideoAnchors | A video can have a list of text anchors, which have different anchor types. Next ID: 15 | VideoContentSearchVideoAnchorsScoreInfo |
| shouldServeThumbnails | Whether or not thumbnails should be displayed when serving anchors. | VideoContentSearchVideoAnchors | A video can have a list of text anchors, which have different anchor types. Next ID: 15 | boolean |
| thumbnailForced | This field indicates that the thumbnail should be hidden but is forced to show. | VideoContentSearchVideoAnchors | A video can have a list of text anchors, which have different anchor types. Next ID: 15 | boolean |
| thumbnailSetInfo | Information about the set of thumbnails. | VideoContentSearchVideoAnchors | A video can have a list of text anchors, which have different anchor types. Next ID: 15 | VideoContentSearchAnchorsThumbnailInfo |
| videoAnchor | VideoContentSearchVideoAnchors | A video can have a list of text anchors, which have different anchor types. Next ID: 15 | list(VideoContentSearchVideoAnchor) | |
| videoIntroduction | Information about the video’s introduction segment. | VideoContentSearchVideoAnchors | A video can have a list of text anchors, which have different anchor types. Next ID: 15 | VideoContentSearchVideoIntroduction |
| anchorCommonFeatureSet | Common features for any anchor types. | VideoContentSearchVideoAnchorScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchor data, it should be put here. Next ID: 27 | VideoContentSearchAnchorCommonFeatureSet |
| attachments | Additional attachments which extend MessageSet. | VideoContentSearchVideoAnchorScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchor data, it should be put here. Next ID: 27 | Proto2BridgeMessageSet |
| babelCheckpointPath | The path to the particular babel checkpoint | VideoContentSearchVideoAnchorScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchor data, it should be put here. Next ID: 27 | String |
| captionEntityAnchorFeatures | Training features and debug info for caption entity anchors. | VideoContentSearchVideoAnchorScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchor data, it should be put here. Next ID: 27 | VideoContentSearchCaptionEntityAnchorFeatures |
| captionSpanAnchorFeatures | Features for caption span anchors for use in training. | VideoContentSearchVideoAnchorScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchor data, it should be put here. Next ID: 27 | VideoContentSearchCaptionSpanAnchorFeatures |
| descriptionAnchorFeatures | Description anchor features for use in training. | VideoContentSearchVideoAnchorScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchor data, it should be put here. Next ID: 27 | VideoContentSearchDescriptionAnchorFeatures |
| filterReason | A description of why the anchor was removed. This is intended for debugging anchor sets which use multiple heuristics to filter anchors. | VideoContentSearchVideoAnchorScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchor data, it should be put here. Next ID: 27 | list(String) |
| filtered | Whether or not the anchor will be removed in the final proto. | VideoContentSearchVideoAnchorScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchor data, it should be put here. Next ID: 27 | boolean |
| generativeFeatures | Generated predictions from generative models | VideoContentSearchVideoAnchorScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchor data, it should be put here. Next ID: 27 | list(VideoContentSearchGenerativePredictionFeatures) |
| instructionAnchorFeatures | Anchor level features for Instruction anchors. | VideoContentSearchVideoAnchorScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchor data, it should be put here. Next ID: 27 | VideoContentSearchInstructionAnchorFeatures |
| instructionTrainingDataAnchorFeatures | Training data features for Instruction anchors. | VideoContentSearchVideoAnchorScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchor data, it should be put here. Next ID: 27 | VideoContentSearchInstructionTrainingDataAnchorFeatures |
| labelLanguage | Detected language of label | VideoContentSearchVideoAnchorScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchor data, it should be put here. Next ID: 27 | String |
| labelTransformation | VideoContentSearchVideoAnchorScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchor data, it should be put here. Next ID: 27 | list(VideoContentSearchVideoAnchorScoreInfoLabelTransformation) | |
| listAnchorFeatures | List anchor features. | VideoContentSearchVideoAnchorScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchor data, it should be put here. Next ID: 27 | VideoContentSearchListAnchorFeatures |
| listTrainingDataAnchorFeatures | Anchor level metadata about the description anchors used to build training data for list anchors. | VideoContentSearchVideoAnchorScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchor data, it should be put here. Next ID: 27 | VideoContentSearchListTrainingDataAnchorFeatures |
| multimodalTopicFeatures | Multimodal features for a generated topic. | VideoContentSearchVideoAnchorScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchor data, it should be put here. Next ID: 27 | VideoContentSearchMultimodalTopicFeatures |
| multimodalTopicTrainingFeatures | Features for a generated topic used to build training data for multimodal topics. | VideoContentSearchVideoAnchorScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchor data, it should be put here. Next ID: 27 | VideoContentSearchMultimodalTopicTrainingFeatures |
| normalizedBabelEmbedding | Normalized babel embedding of anchor.label(). If the label has more than one sentences, the embedding will be the averaged normalized embedding of each sentence. | VideoContentSearchVideoAnchorScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchor data, it should be put here. Next ID: 27 | list(number) |
| ocrAnchorFeature | OCR anchor features. | VideoContentSearchVideoAnchorScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchor data, it should be put here. Next ID: 27 | VideoContentSearchOnScreenTextFeature |
| ocrDescriptionTrainingDataAnchorFeatures | Anchor level metadata about the join of description anchors and OCR data which is used to build training data. | VideoContentSearchVideoAnchorScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchor data, it should be put here. Next ID: 27 | VideoContentSearchOcrDescriptionTrainingDataAnchorFeatures |
| opinionsAnchorFeatures | Shopping Opinions anchor features. | VideoContentSearchVideoAnchorScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchor data, it should be put here. Next ID: 27 | VideoContentSearchShoppingOpinionsAnchorFeatures |
| qnaAnchorFeatures | Q&A anchor features for use in training. | VideoContentSearchVideoAnchorScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchor data, it should be put here. Next ID: 27 | VideoContentSearchQnaAnchorFeatures |
| ratingScore | Human rating score, used for training. | VideoContentSearchVideoAnchorScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchor data, it should be put here. Next ID: 27 | VideoContentSearchVideoAnchorRatingScore |
| safeSearchClassifierOutput | The output of Safe Search’s MultiLabelClassifier. | VideoContentSearchVideoAnchorScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchor data, it should be put here. Next ID: 27 | ClassifierPornQueryMultiLabelClassifierOutput |
| textSimilarityFeatures | ASR matching feature for any anchor types. | VideoContentSearchVideoAnchorScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchor data, it should be put here. Next ID: 27 | list(VideoContentSearchTextSimilarityFeatures) |
| thumbnailInfo | Information about the thumbnail anchor. | VideoContentSearchVideoAnchorScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchor data, it should be put here. Next ID: 27 | VideoContentSearchAnchorThumbnailInfo |
| description | A label for the transformation. | VideoContentSearchVideoAnchorScoreInfoLabelTransformation | Used to store the label before label cleaning or other transformations. If the label goes through multiple transformations, the original_label vector will include the transformations in chronological order. | String |
| sourceLabel | The label that was transformated from. | VideoContentSearchVideoAnchorScoreInfoLabelTransformation | Used to store the label before label cleaning or other transformations. If the label goes through multiple transformations, the original_label vector will include the transformations in chronological order. | String |
| averageSetDescriptionQuality | Average score of set level description quality. | VideoContentSearchVideoAnchorSetRatingScore | Aggregated set level rating score, used in training pipeline, etc. | number |
| averageSetNavigationUsefulness | Average score of how useful the set is for navigation. | VideoContentSearchVideoAnchorSetRatingScore | Aggregated set level rating score, used in training pipeline, etc. | number |
| videoActions | VideoContentSearchVideoAnchorSets | One video can have multiple types of text anchors. For example, https://www.youtube.com/watch?v=Rtk0I5PVOIc has both list anchors and OCR anchors. | VideoContentSearchVideoActions | |
| videoAnchors | VideoContentSearchVideoAnchorSets | One video can have multiple types of text anchors. For example, https://www.youtube.com/watch?v=Rtk0I5PVOIc has both list anchors and OCR anchors. | list(VideoContentSearchVideoAnchors) | |
| videoInfo | VideoContentSearchVideoAnchorSets | One video can have multiple types of text anchors. For example, https://www.youtube.com/watch?v=Rtk0I5PVOIc has both list anchors and OCR anchors. | VideoContentSearchVideoInfo | |
| videoScoreInfo | VideoContentSearchVideoAnchorSets | One video can have multiple types of text anchors. For example, https://www.youtube.com/watch?v=Rtk0I5PVOIc has both list anchors and OCR anchors. | VideoContentSearchVideoScoreInfo | |
| anchorsCommonFeatureSet | Common set-level features for any anchor types. | VideoContentSearchVideoAnchorsScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchors data, it should be put here. Next ID: 14 | VideoContentSearchAnchorsCommonFeatureSet |
| captionEntityAnchorSetFeatures | Training features and debug info for caption entity anchors. | VideoContentSearchVideoAnchorsScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchors data, it should be put here. Next ID: 14 | VideoContentSearchCaptionEntityAnchorSetFeatures |
| captionSpanAnchorSetFeatures | VideoContentSearchVideoAnchorsScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchors data, it should be put here. Next ID: 14 | VideoContentSearchCaptionSpanAnchorSetFeatures | |
| commentAnchorSetFeatures | Set-level features for comment anchors. | VideoContentSearchVideoAnchorsScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchors data, it should be put here. Next ID: 14 | VideoContentSearchCommentAnchorSetFeatures |
| descriptionAnchorSetFeatures | Description anchor features for use in training. | VideoContentSearchVideoAnchorsScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchors data, it should be put here. Next ID: 14 | VideoContentSearchDescriptionAnchorSetFeatures |
| filtered | Whether or not the anchors will be removed in the final proto. | VideoContentSearchVideoAnchorsScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchors data, it should be put here. Next ID: 14 | boolean |
| listAnchorSetFeatures | Set-level features for list anchors. | VideoContentSearchVideoAnchorsScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchors data, it should be put here. Next ID: 14 | VideoContentSearchListAnchorSetFeatures |
| listTrainingDataSetFeatures | Set level metadata about the description anchors used to build training data for List Description anchors. | VideoContentSearchVideoAnchorsScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchors data, it should be put here. Next ID: 14 | VideoContentSearchListTrainingDataSetFeatures |
| ocrAnchorClusterFeature | OCR anchor cluster features. | VideoContentSearchVideoAnchorsScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchors data, it should be put here. Next ID: 14 | VideoContentSearchOnScreenTextClusterFeature |
| ocrDescriptionTrainingDataSetFeatures | Set level metadata about the join of description anchors and OCR data which is used to build training data. | VideoContentSearchVideoAnchorsScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchors data, it should be put here. Next ID: 14 | VideoContentSearchOcrDescriptionTrainingDataSetFeatures |
| qnaAnchorSetFeatures | Metadata such as model versions for Q&A anchors. | VideoContentSearchVideoAnchorsScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchors data, it should be put here. Next ID: 14 | VideoContentSearchQnaAnchorSetFeatures |
| ratingScore | Human rating score, used for training. | VideoContentSearchVideoAnchorsScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchors data, it should be put here. Next ID: 14 | VideoContentSearchVideoAnchorSetRatingScore |
| sportsKeyMomentsAnchorSetFeatures | VideoContentSearchVideoAnchorsScoreInfo | Message to contain scoring / debugging information. If you want to add information which is not directly used in the final VideoAnchors data, it should be put here. Next ID: 14 | VideoContentSearchSportsKeyMomentsAnchorSetFeatures | |
| anchorCount | The total number of anchors in all video anchor sets. | VideoContentSearchVideoCommonFeatures | Contains video level features that apply to all anchor types. | integer |
| captionInfo | The caption data for the video transcript. The models used for unified scorer. Should be a filepath that contains saved_model.pb and a variables/ folder | VideoContentSearchVideoCommonFeatures | Contains video level features that apply to all anchor types. | VideoContentSearchCaptionInfo |
| labelPhraseEmbeddingModel | The model used for generating label_phrase_embedding. | VideoContentSearchVideoCommonFeatures | Contains video level features that apply to all anchor types. | String |
| unifiedScoringBertModels | VideoContentSearchVideoCommonFeatures | Contains video level features that apply to all anchor types. | list(String) | |
| filterReason | A description of why the video was removed. This is intended for debugging generated queries that are filtered at the video level. | VideoContentSearchVideoGeneratedQueryFeatures | Contains video level features for generated queries that are applied at the video level. | list(String) |
| prefilteredPassageCount | The total number of passages that were input to generating queries for this video. This count might be bigger than the total number of anchors in the video as some of the anchors might have been filtered by the pipeline. | VideoContentSearchVideoGeneratedQueryFeatures | Contains video level features for generated queries that are applied at the video level. | integer |
| titleEntityAnnotations | Entity annotations for one of the mids representing the video title. This entity is either one of the blocklisted entities if at least of the mentioned entities in the title belongs to the blocklisted categories, or is the highest confidence entity for the title. | VideoContentSearchVideoGeneratedQueryFeatures | Contains video level features for generated queries that are applied at the video level. | VideoContentSearchEntityAnnotations |
| totalRestrictedQueries | The total number of queries that belong to the blocklisted categories for this video. | VideoContentSearchVideoGeneratedQueryFeatures | Contains video level features for generated queries that are applied at the video level. | integer |
| amarnaDocid | A hash of the video bytes used as a key to Amarna’s video_metadata table. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | String |
| asrLanguage | Language information, extracted from content_based_metadata.speech_properties. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | String |
| crapsData | Craps data from the video cdoc. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | QualityNavboostCrapsCrapsData |
| description | Video description. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | String |
| docLanguage | Language information, extracted from DocProperties. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | String |
| durationMs | Video duration in ms. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | number |
| hasAsr | Whether or not automatic speech recognition has been generated for this video. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | boolean |
| hasDescriptionAnchors | Whether or not the video has description anchors. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | boolean |
| isSafe | Convenience field that is false if any of the video’s anchors have their is_safe field set to false. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | boolean |
| isWatchpage | Whether or not this is watchpage. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | boolean |
| navqueries | Navqueries for the video. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | list(String) |
| nsr | NSR for the video page document. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | number |
| numViews | Number of views. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | String |
| pseudoVideoData | ASR with timing info for each token copied from doc_videos.content_based_metadata.transcript_asr. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | PseudoVideoData |
| saftDoc | The Saft document generated from the anchor labels. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | NlpSaftDocument |
| saftTranscript | The transcript used to generate the Saft doc. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | String |
| salientTermSet | Salient term set from the document. This message contains a lot of data and dependencies, so sub-messages are disabled in model evaluation in scorer. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | QualitySalientTermsSalientTermSet |
| subindexid | The subindexid from the cdoc. Stored as an int to avoid a cyclical dependency. Should be convertible to CompositeDoc.SubIndexType. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | list(integer) |
| title | Video title. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | String |
| titleLanguage | Video title language Language information, set automatically by the SAFT LangID. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | String |
| transcriptAnnotations | Transcript annotations that include information about the ASR including timing and entity mentions. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | QualityWebanswersTranscriptAnnotations |
| uniqueChromeViews | Number of unique visits in Chrome. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | integer |
| url | Document url. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | String |
| verticalItem | Top petacat verticals of the video produced by indexing/ml/vertical, sorted in descending order by vertical confidence. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | list(IndexingMlVerticalVerticalItem) |
| videoGenre | Genre of the video from the page metadata. Concatenate all with a comma separator if there are multiple genres. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | String |
| videoType | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | String | |
| videoUrl | Video url. Note that VideoInfo::url is a page url that has this video, while this is a video file url. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | String |
| webrefEntities | Represents a collection of entities returned by the WebRef service. This message contains a lot of data and dependencies, so sub-messages are disabled in model evaluation in scorer. | VideoContentSearchVideoInfo | This message holds metadata and signals of one video. It is typically used for holding debug data in tables produced by offline pipelines related to video anchors. Please never populate this message into the search serving stack. Next ID: 31 | RepositoryWebrefWebrefEntities |
| hasIntro | If set to true, it means the video has an introduction spanning from intro_start_ms to intro_end_ms. | VideoContentSearchVideoIntroduction | Specifies whether a video has an introduction part that can be skipped. An introduction is the beginning part of a video that can be safely skipped without impacting user’s understanding of the overall video content. | boolean |
| introEndMs | Timestamp of the end of an introduction. Will only be set if has_intro is true. Indicates video may be skipped to this timestamp with minimal impact on understanding the overall video contents. | VideoContentSearchVideoIntroduction | Specifies whether a video has an introduction part that can be skipped. An introduction is the beginning part of a video that can be safely skipped without impacting user’s understanding of the overall video content. | String |
| introStartMs | Timestamp of the beginning of an introduction. Will only be set if has_intro is true. This value may be nonzero. | VideoContentSearchVideoIntroduction | Specifies whether a video has an introduction part that can be skipped. An introduction is the beginning part of a video that can be safely skipped without impacting user’s understanding of the overall video content. | String |
| frameStarburstData | Starburst vectors. Sorted by timestamp. | VideoContentSearchVideoMultimodalTopicFeatures | Video-level Multimodal features for generated topics. Next ID: 2 | list(VideoContentSearchFrameStarburstData) |
| commonFeatures | Anchor scoring features that apply to all anchor types. | VideoContentSearchVideoScoreInfo | Video level scoring info. | VideoContentSearchVideoCommonFeatures |
| ocrVideoFeature | OCR specific video level feature. | VideoContentSearchVideoScoreInfo | Video level scoring info. | VideoContentSearchOcrVideoFeature |
| safeSearchClassifierOutput | The output of Safe Search’s MultiLabelClassifier for video title. | VideoContentSearchVideoScoreInfo | Video level scoring info. | ClassifierPornQueryMultiLabelClassifierOutput |
| version | The version of this VideoAnchorSets in spanner. | VideoContentSearchVideoScoreInfo | Video level scoring info. | String |
| videoGeneratedQueryFeatures | Video-level features that apply to all the generated queries within this VideoAnchorSets. | VideoContentSearchVideoScoreInfo | Video level scoring info. | VideoContentSearchVideoGeneratedQueryFeatures |
| videoMultimodalTopicFeatures | Video-level features for Multimodal topics. | VideoContentSearchVideoScoreInfo | Video level scoring info. | VideoContentSearchVideoMultimodalTopicFeatures |
| features | Starburst features semantic or visual/ | VideoContentSearchVisualFeatures | Startburst visual tokens or features, more details in go/starburst-mum-user-guide | list(number) |
| starbustVersion | VideoContentSearchVisualFeatures | Startburst visual tokens or features, more details in go/starburst-mum-user-guide | String | |
| tokens | Starburst visual tokens | VideoContentSearchVisualFeatures | Startburst visual tokens or features, more details in go/starburst-mum-user-guide | list(integer) |
| expirationTimestampSec | Timestamp (measured in seconds since epoch) when a video may not be used for inline playback in the interest feed. | VideoCrawlVideoInlinePlaybackMetadata | This message is used to store information about Inline Playback in the VideoWebAttachment portion of the websearch index. LINT.IfChange | String |
| googleAnalyticsId | Publisher’s Google Analytics Id to which we can report view metrics. | VideoCrawlVideoInlinePlaybackMetadata | This message is used to store information about Inline Playback in the VideoWebAttachment portion of the websearch index. LINT.IfChange | String |
| playbackCountryBlacklist | All two-letter codes for countries where this video may NOT be played. | VideoCrawlVideoInlinePlaybackMetadata | This message is used to store information about Inline Playback in the VideoWebAttachment portion of the websearch index. LINT.IfChange | list(String) |
| playbackCountryWhitelist | All two-letter codes for countries where this video may be played. If empty, then all countries not on the blacklist are allowed for playback. | VideoCrawlVideoInlinePlaybackMetadata | This message is used to store information about Inline Playback in the VideoWebAttachment portion of the websearch index. LINT.IfChange | list(String) |
| transcodeItags | Set of transcodes which are available for the video. | VideoCrawlVideoInlinePlaybackMetadata | This message is used to store information about Inline Playback in the VideoWebAttachment portion of the websearch index. LINT.IfChange | list(integer) |
| vastTag | VAST tag for ads to be played along with this video. Currently, we only support VAST tags from Doubleclick and FreeWheel. | VideoCrawlVideoInlinePlaybackMetadata | This message is used to store information about Inline Playback in the VideoWebAttachment portion of the websearch index. LINT.IfChange | String |
| videoId | Identifier video is known by in the video infrastructure. The format given here is the YoutubeId format (base-64) used in Venom; for Viper/Bandaid/ StreamingURLService, convert to ContentIdHex. | VideoCrawlVideoInlinePlaybackMetadata | This message is used to store information about Inline Playback in the VideoWebAttachment portion of the websearch index. LINT.IfChange | String |
| videoUrlOnExternalCdn | Set if the video is hosted on an external CDN, in which case it is not to be transcoded and hosted at Google for the Interest Feed. | VideoCrawlVideoInlinePlaybackMetadata | This message is used to store information about Inline Playback in the VideoWebAttachment portion of the websearch index. LINT.IfChange | String |
| blPresentFlag | If a track contains the base layer substream. | VideoDoViDecoderConfiguration | Decoder configuration for Dolby Vision encoded by any codec. Dolby Vision defines a separate profile & level hierarchy regardless of the base codec. See Dolby Vision profiles, levels and compatibility: https://dolby.my.salesforce.com/sfc/p/#700000009YuG/a/4u000000l6G4/4R18riPaaW3gxpVx7XwyQLdEITLFjB.w.Si0LoQR5j8 Dolby Vision DASH streaming: https://professional.dolby.com/siteassets/content-creation/dolby-vision-for-content-creators/dolbyvisioninmpegdashspecification_v2_0_public_20190107.pdf HTTP Live Streaming: https://professional.dolby.com/siteassets/content-creation/dolby-vision-for-content-creators/dolby-vision-streams-within-the-http-live-streaming-format-v2.0-13-november-2018.pdf Dolby Vision bitstreams: https://professional.dolby.com/siteassets/pdfs/dolbyvisionstreamsinisobmffspecification-v2.1.2.pdf | boolean |
| dvBlSignalCompatibilityId | Whether the stream is compatible with other sets of standard. | VideoDoViDecoderConfiguration | Decoder configuration for Dolby Vision encoded by any codec. Dolby Vision defines a separate profile & level hierarchy regardless of the base codec. See Dolby Vision profiles, levels and compatibility: https://dolby.my.salesforce.com/sfc/p/#700000009YuG/a/4u000000l6G4/4R18riPaaW3gxpVx7XwyQLdEITLFjB.w.Si0LoQR5j8 Dolby Vision DASH streaming: https://professional.dolby.com/siteassets/content-creation/dolby-vision-for-content-creators/dolbyvisioninmpegdashspecification_v2_0_public_20190107.pdf HTTP Live Streaming: https://professional.dolby.com/siteassets/content-creation/dolby-vision-for-content-creators/dolby-vision-streams-within-the-http-live-streaming-format-v2.0-13-november-2018.pdf Dolby Vision bitstreams: https://professional.dolby.com/siteassets/pdfs/dolbyvisionstreamsinisobmffspecification-v2.1.2.pdf | integer |
| dvLevel | VideoDoViDecoderConfiguration | Decoder configuration for Dolby Vision encoded by any codec. Dolby Vision defines a separate profile & level hierarchy regardless of the base codec. See Dolby Vision profiles, levels and compatibility: https://dolby.my.salesforce.com/sfc/p/#700000009YuG/a/4u000000l6G4/4R18riPaaW3gxpVx7XwyQLdEITLFjB.w.Si0LoQR5j8 Dolby Vision DASH streaming: https://professional.dolby.com/siteassets/content-creation/dolby-vision-for-content-creators/dolbyvisioninmpegdashspecification_v2_0_public_20190107.pdf HTTP Live Streaming: https://professional.dolby.com/siteassets/content-creation/dolby-vision-for-content-creators/dolby-vision-streams-within-the-http-live-streaming-format-v2.0-13-november-2018.pdf Dolby Vision bitstreams: https://professional.dolby.com/siteassets/pdfs/dolbyvisionstreamsinisobmffspecification-v2.1.2.pdf | integer | |
| dvProfile | VideoDoViDecoderConfiguration | Decoder configuration for Dolby Vision encoded by any codec. Dolby Vision defines a separate profile & level hierarchy regardless of the base codec. See Dolby Vision profiles, levels and compatibility: https://dolby.my.salesforce.com/sfc/p/#700000009YuG/a/4u000000l6G4/4R18riPaaW3gxpVx7XwyQLdEITLFjB.w.Si0LoQR5j8 Dolby Vision DASH streaming: https://professional.dolby.com/siteassets/content-creation/dolby-vision-for-content-creators/dolbyvisioninmpegdashspecification_v2_0_public_20190107.pdf HTTP Live Streaming: https://professional.dolby.com/siteassets/content-creation/dolby-vision-for-content-creators/dolby-vision-streams-within-the-http-live-streaming-format-v2.0-13-november-2018.pdf Dolby Vision bitstreams: https://professional.dolby.com/siteassets/pdfs/dolbyvisionstreamsinisobmffspecification-v2.1.2.pdf | integer | |
| dvVersionMajor | Specifies the major version number of the Dolby Vision specification that the stream complies with. | VideoDoViDecoderConfiguration | Decoder configuration for Dolby Vision encoded by any codec. Dolby Vision defines a separate profile & level hierarchy regardless of the base codec. See Dolby Vision profiles, levels and compatibility: https://dolby.my.salesforce.com/sfc/p/#700000009YuG/a/4u000000l6G4/4R18riPaaW3gxpVx7XwyQLdEITLFjB.w.Si0LoQR5j8 Dolby Vision DASH streaming: https://professional.dolby.com/siteassets/content-creation/dolby-vision-for-content-creators/dolbyvisioninmpegdashspecification_v2_0_public_20190107.pdf HTTP Live Streaming: https://professional.dolby.com/siteassets/content-creation/dolby-vision-for-content-creators/dolby-vision-streams-within-the-http-live-streaming-format-v2.0-13-november-2018.pdf Dolby Vision bitstreams: https://professional.dolby.com/siteassets/pdfs/dolbyvisionstreamsinisobmffspecification-v2.1.2.pdf | integer |
| dvVersionMinor | Specifies the minor version number of the Dolby Vision specification that the stream complies with. | VideoDoViDecoderConfiguration | Decoder configuration for Dolby Vision encoded by any codec. Dolby Vision defines a separate profile & level hierarchy regardless of the base codec. See Dolby Vision profiles, levels and compatibility: https://dolby.my.salesforce.com/sfc/p/#700000009YuG/a/4u000000l6G4/4R18riPaaW3gxpVx7XwyQLdEITLFjB.w.Si0LoQR5j8 Dolby Vision DASH streaming: https://professional.dolby.com/siteassets/content-creation/dolby-vision-for-content-creators/dolbyvisioninmpegdashspecification_v2_0_public_20190107.pdf HTTP Live Streaming: https://professional.dolby.com/siteassets/content-creation/dolby-vision-for-content-creators/dolby-vision-streams-within-the-http-live-streaming-format-v2.0-13-november-2018.pdf Dolby Vision bitstreams: https://professional.dolby.com/siteassets/pdfs/dolbyvisionstreamsinisobmffspecification-v2.1.2.pdf | integer |
| elPresentFlag | If a track contains the enhancement layer substream. | VideoDoViDecoderConfiguration | Decoder configuration for Dolby Vision encoded by any codec. Dolby Vision defines a separate profile & level hierarchy regardless of the base codec. See Dolby Vision profiles, levels and compatibility: https://dolby.my.salesforce.com/sfc/p/#700000009YuG/a/4u000000l6G4/4R18riPaaW3gxpVx7XwyQLdEITLFjB.w.Si0LoQR5j8 Dolby Vision DASH streaming: https://professional.dolby.com/siteassets/content-creation/dolby-vision-for-content-creators/dolbyvisioninmpegdashspecification_v2_0_public_20190107.pdf HTTP Live Streaming: https://professional.dolby.com/siteassets/content-creation/dolby-vision-for-content-creators/dolby-vision-streams-within-the-http-live-streaming-format-v2.0-13-november-2018.pdf Dolby Vision bitstreams: https://professional.dolby.com/siteassets/pdfs/dolbyvisionstreamsinisobmffspecification-v2.1.2.pdf | boolean |
| fourccTag | dvhe, dvh1, dvav, dva1: https://screenshot.googleplex.com/ipMGXFqLX9E | VideoDoViDecoderConfiguration | Decoder configuration for Dolby Vision encoded by any codec. Dolby Vision defines a separate profile & level hierarchy regardless of the base codec. See Dolby Vision profiles, levels and compatibility: https://dolby.my.salesforce.com/sfc/p/#700000009YuG/a/4u000000l6G4/4R18riPaaW3gxpVx7XwyQLdEITLFjB.w.Si0LoQR5j8 Dolby Vision DASH streaming: https://professional.dolby.com/siteassets/content-creation/dolby-vision-for-content-creators/dolbyvisioninmpegdashspecification_v2_0_public_20190107.pdf HTTP Live Streaming: https://professional.dolby.com/siteassets/content-creation/dolby-vision-for-content-creators/dolby-vision-streams-within-the-http-live-streaming-format-v2.0-13-november-2018.pdf Dolby Vision bitstreams: https://professional.dolby.com/siteassets/pdfs/dolbyvisionstreamsinisobmffspecification-v2.1.2.pdf | String |
| rpuPresentFlag | If a track contains the reference picture unit substream. | VideoDoViDecoderConfiguration | Decoder configuration for Dolby Vision encoded by any codec. Dolby Vision defines a separate profile & level hierarchy regardless of the base codec. See Dolby Vision profiles, levels and compatibility: https://dolby.my.salesforce.com/sfc/p/#700000009YuG/a/4u000000l6G4/4R18riPaaW3gxpVx7XwyQLdEITLFjB.w.Si0LoQR5j8 Dolby Vision DASH streaming: https://professional.dolby.com/siteassets/content-creation/dolby-vision-for-content-creators/dolbyvisioninmpegdashspecification_v2_0_public_20190107.pdf HTTP Live Streaming: https://professional.dolby.com/siteassets/content-creation/dolby-vision-for-content-creators/dolby-vision-streams-within-the-http-live-streaming-format-v2.0-13-november-2018.pdf Dolby Vision bitstreams: https://professional.dolby.com/siteassets/pdfs/dolbyvisionstreamsinisobmffspecification-v2.1.2.pdf | boolean |
| matrixCoefficients | VideoFileColorInfo | A message holding all of the color information about a signal: -Color primaries identify the meaning of red, green, and blue ( and the white point). -The transfer characteristic identifies the mapping used to go between linear and coded values of light. -The matrix coefficients identifies, e.g., the conversion between Ycbcr to RGB (in the space of the primaries) -And the color range defines the min/max of the levels used. | String | |
| primaries | VideoFileColorInfo | A message holding all of the color information about a signal: -Color primaries identify the meaning of red, green, and blue ( and the white point). -The transfer characteristic identifies the mapping used to go between linear and coded values of light. -The matrix coefficients identifies, e.g., the conversion between Ycbcr to RGB (in the space of the primaries) -And the color range defines the min/max of the levels used. | String | |
| range | VideoFileColorInfo | A message holding all of the color information about a signal: -Color primaries identify the meaning of red, green, and blue ( and the white point). -The transfer characteristic identifies the mapping used to go between linear and coded values of light. -The matrix coefficients identifies, e.g., the conversion between Ycbcr to RGB (in the space of the primaries) -And the color range defines the min/max of the levels used. | String | |
| transferCharacteristics | VideoFileColorInfo | A message holding all of the color information about a signal: -Color primaries identify the meaning of red, green, and blue ( and the white point). -The transfer characteristic identifies the mapping used to go between linear and coded values of light. -The matrix coefficients identifies, e.g., the conversion between Ycbcr to RGB (in the space of the primaries) -And the color range defines the min/max of the levels used. | String | |
| maxContentLightLevel | Defines the maximum content light level (in cd/m^2) over the entire video. | VideoFileContentLightLevel | A message holding the equivalent of the content light level information in HEVC or its representation in matroska/webm. This gives coarse stats on the luminance levels in the content and may be used as a hint by algorithms & displays to tone map. | integer |
| maxFrameAverageLightLevel | The maximum (over entire video) of the frame average light level. | VideoFileContentLightLevel | A message holding the equivalent of the content light level information in HEVC or its representation in matroska/webm. This gives coarse stats on the luminance levels in the content and may be used as a hint by algorithms & displays to tone map. | integer |
| gridOffset0Horizontal | Grid positions | VideoFileFramePackingArrangement | Information on Frame Packing arrangement | integer |
| gridOffset0Vertical | VideoFileFramePackingArrangement | Information on Frame Packing arrangement | integer | |
| gridOffset1Horizontal | VideoFileFramePackingArrangement | Information on Frame Packing arrangement | integer | |
| gridOffset1Vertical | VideoFileFramePackingArrangement | Information on Frame Packing arrangement | integer | |
| interpretation | Content interpretation | VideoFileFramePackingArrangement | Information on Frame Packing arrangement | String |
| quincunxSampling | Quincunx sampling flag indicating if quincunx sampling is used | VideoFileFramePackingArrangement | Information on Frame Packing arrangement | boolean |
| type | Arrangement type | VideoFileFramePackingArrangement | Information on Frame Packing arrangement | String |
| applicationVersion | Application version is set to max version over all frames. | VideoFileHDR10PlusStats | Stats on HDR10+ (SMPTE 2094-40:2016 standard) over video frames. | integer |
| averageTargetedSystemDisplayMaximumLuminance | The average of the nominal maximum display luminance of the targeted system display over all frames. | VideoFileHDR10PlusStats | Stats on HDR10+ (SMPTE 2094-40:2016 standard) over video frames. | float |
| masteringDisplayActualPeakLuminanceFlag | This flag is set if any frame has it. | VideoFileHDR10PlusStats | Stats on HDR10+ (SMPTE 2094-40:2016 standard) over video frames. | boolean |
| maxNumWindows | VideoFileHDR10PlusStats | Stats on HDR10+ (SMPTE 2094-40:2016 standard) over video frames. | integer | |
| targetedSystemDisplayActualPeakLuminanceFlag | This flag is set if any frame has it. | VideoFileHDR10PlusStats | Stats on HDR10+ (SMPTE 2094-40:2016 standard) over video frames. | boolean |
| blue | Coordinates of the blue primary of the mastering display. | VideoFileMasteringDisplayMetadata | A message holding information about the mastering display color volume. This metadata can be used when tone mapping an HDR signal to a display with a different gamut or brightness characteristics than the mastering display. This message is capable of containing SMPTE 2086 metadata. | VideoFileMasteringDisplayMetadataCIE1931Coordinate |
| green | Coordinates of the green primary of the mastering display. | VideoFileMasteringDisplayMetadata | A message holding information about the mastering display color volume. This metadata can be used when tone mapping an HDR signal to a display with a different gamut or brightness characteristics than the mastering display. This message is capable of containing SMPTE 2086 metadata. | VideoFileMasteringDisplayMetadataCIE1931Coordinate |
| maxLuminance | Maximum luminance of the display (in cd/m^2). | VideoFileMasteringDisplayMetadata | A message holding information about the mastering display color volume. This metadata can be used when tone mapping an HDR signal to a display with a different gamut or brightness characteristics than the mastering display. This message is capable of containing SMPTE 2086 metadata. | number |
| minLuminance | Minimum luminance of the display (in cd/m^2). | VideoFileMasteringDisplayMetadata | A message holding information about the mastering display color volume. This metadata can be used when tone mapping an HDR signal to a display with a different gamut or brightness characteristics than the mastering display. This message is capable of containing SMPTE 2086 metadata. | number |
| red | Coordinates of the red primary of the mastering display. | VideoFileMasteringDisplayMetadata | A message holding information about the mastering display color volume. This metadata can be used when tone mapping an HDR signal to a display with a different gamut or brightness characteristics than the mastering display. This message is capable of containing SMPTE 2086 metadata. | VideoFileMasteringDisplayMetadataCIE1931Coordinate |
| whitePoint | Coordinates of the white point of the mastering display. | VideoFileMasteringDisplayMetadata | A message holding information about the mastering display color volume. This metadata can be used when tone mapping an HDR signal to a display with a different gamut or brightness characteristics than the mastering display. This message is capable of containing SMPTE 2086 metadata. | VideoFileMasteringDisplayMetadataCIE1931Coordinate |
| x | VideoFileMasteringDisplayMetadataCIE1931Coordinate | Representation of a color coordinate in CIE1931 color space. | number | |
| y | VideoFileMasteringDisplayMetadataCIE1931Coordinate | Representation of a color coordinate in CIE1931 color space. | number | |
| clampedOptimalFovBounds | Like above, but with high-pass motion filtering applied and yaw rotation limited to +/- 15-degrees | VideoFileSphericalMetadata | Globally allowed spherical meta data. | VideoFileSphericalMetadataFOVBounds |
| cubemap | VideoFileSphericalMetadata | Globally allowed spherical meta data. | VideoFileSphericalMetadataCubemapProjection | |
| deprecatedCroppedArea | VideoFileSphericalMetadata | Globally allowed spherical meta data. | VideoFileSphericalMetadataCroppedArea | |
| deprecatedInitialView | InitialView is from v1 spec, and is more or less equivalent to Pose from v2 spec. Therefore, InitialView found in xml metadata would populate the pose field in this proto. | VideoFileSphericalMetadata | Globally allowed spherical meta data. | VideoFileSphericalMetadataViewDirection |
| equirect | VideoFileSphericalMetadata | Globally allowed spherical meta data. | VideoFileSphericalMetadataEquirectProjection | |
| fullPanoHeightPixels | VideoFileSphericalMetadata | Globally allowed spherical meta data. | integer | |
| fullPanoWidthPixels | Dimensions of the full video frame. | VideoFileSphericalMetadata | Globally allowed spherical meta data. | integer |
| mesh | VideoFileSphericalMetadata | Globally allowed spherical meta data. | VideoFileSphericalMetadataMeshProjection | |
| metadataSource | Metadata source v2(svhd) | VideoFileSphericalMetadata | Globally allowed spherical meta data. | String |
| optimalFovBounds | If video contains Wally-sanitized mesh and camera motion metadata (see go/wally-format ), this contains the optimal FOV (smallest FOV that encompass all combinations of input mesh FOV and rotations). This field will only be present if full FfmpegAnalyze is performed. | VideoFileSphericalMetadata | Globally allowed spherical meta data. | VideoFileSphericalMetadataFOVBounds |
| pose | VideoFileSphericalMetadata | Globally allowed spherical meta data. | VideoFileSphericalMetadataPose | |
| projectionType | Mapping type used to map the sphere to the rectangular video E.g., “equirectangular”, http://en.wikipedia.org/wiki/Equirectangular_projection This is kept as string so that we can retain values that are unknown to us. | VideoFileSphericalMetadata | Globally allowed spherical meta data. | String |
| sourceCount | The number of camera sources used to generate this video. | VideoFileSphericalMetadata | Globally allowed spherical meta data. | integer |
| spherical | Whether the video is spherical or not. | VideoFileSphericalMetadata | Globally allowed spherical meta data. | boolean |
| stereoMode | The stereo mode. | VideoFileSphericalMetadata | Globally allowed spherical meta data. | String |
| stitched | Whether the video has already been stitched. | VideoFileSphericalMetadata | Globally allowed spherical meta data. | boolean |
| stitchingSoftware | The stitching software. | VideoFileSphericalMetadata | Globally allowed spherical meta data. | String |
| timestamp | Epoch Timestamp of when the first frame in the video was recorded | VideoFileSphericalMetadata | Globally allowed spherical meta data. | String |
| height | VideoFileSphericalMetadataCroppedArea | The cropping coordinates, in pixels. | integer | |
| left | VideoFileSphericalMetadataCroppedArea | The cropping coordinates, in pixels. | integer | |
| top | VideoFileSphericalMetadataCroppedArea | The cropping coordinates, in pixels. | integer | |
| width | VideoFileSphericalMetadataCroppedArea | The cropping coordinates, in pixels. | integer | |
| layout | Values 0 to 255 are reserved for current and future layouts. Value of 0 corresponds to a grid with 3 columns and 2 rows as follows: | right face | left face | up face | | down face | front face | back face | | VideoFileSphericalMetadataCubemapProjection | Specifies usage of cubemap projection. | integer |
| padding | Number of pixels to pad from the edge of each cube face | VideoFileSphericalMetadataCubemapProjection | Specifies usage of cubemap projection. | integer |
| projectionBoundsBottom | VideoFileSphericalMetadataEquirectProjection | Specifies usage of equirectangular projection. More specifically, these are the proportion of projection cropped from each edge not covered by the video frame. For uncropped frame, all values are 0. For v1 metadata, this contains CroppedArea information (CroppedAreaLeftPixels, CroppedAreaTopPixels, CroppedAreaImageWidthPixels, CroppedAreaImageHeightPixels) | integer | |
| projectionBoundsLeft | VideoFileSphericalMetadataEquirectProjection | Specifies usage of equirectangular projection. More specifically, these are the proportion of projection cropped from each edge not covered by the video frame. For uncropped frame, all values are 0. For v1 metadata, this contains CroppedArea information (CroppedAreaLeftPixels, CroppedAreaTopPixels, CroppedAreaImageWidthPixels, CroppedAreaImageHeightPixels) | integer | |
| projectionBoundsRight | VideoFileSphericalMetadataEquirectProjection | Specifies usage of equirectangular projection. More specifically, these are the proportion of projection cropped from each edge not covered by the video frame. For uncropped frame, all values are 0. For v1 metadata, this contains CroppedArea information (CroppedAreaLeftPixels, CroppedAreaTopPixels, CroppedAreaImageWidthPixels, CroppedAreaImageHeightPixels) | integer | |
| projectionBoundsTop | VideoFileSphericalMetadataEquirectProjection | Specifies usage of equirectangular projection. More specifically, these are the proportion of projection cropped from each edge not covered by the video frame. For uncropped frame, all values are 0. For v1 metadata, this contains CroppedArea information (CroppedAreaLeftPixels, CroppedAreaTopPixels, CroppedAreaImageWidthPixels, CroppedAreaImageHeightPixels) | integer | |
| endTiltInDegrees | VideoFileSphericalMetadataFOVBounds | float | ||
| endYawInDegrees | VideoFileSphericalMetadataFOVBounds | float | ||
| startTiltInDegrees | VideoFileSphericalMetadataFOVBounds | float | ||
| startYawInDegrees | VideoFileSphericalMetadataFOVBounds | float | ||
| bounds | Once mesh is analyzed, this field contains the bounds of the mesh(es) In case of stereo mesh, this will be the aggregate of both eye meshes | VideoFileSphericalMetadataMeshProjection | Specifies usage of mesh projection. “content” contains the mshp atom: version/flags, CRC, compression method, description of the mesh(es) (vertices, coordinates corresponding to each vertex, and vertex lists to describe the projection). See go/pir-spec for mshp atom data layout. | VideoFileSphericalMetadataFOVBounds |
| content | VideoFileSphericalMetadataMeshProjection | Specifies usage of mesh projection. “content” contains the mshp atom: version/flags, CRC, compression method, description of the mesh(es) (vertices, coordinates corresponding to each vertex, and vertex lists to describe the projection). See go/pir-spec for mshp atom data layout. | String | |
| type | The mesh type field will only be populated when we have done analysis on the mesh. If this field is missing, mesh analysis has not been done. | VideoFileSphericalMetadataMeshProjection | Specifies usage of mesh projection. “content” contains the mshp atom: version/flags, CRC, compression method, description of the mesh(es) (vertices, coordinates corresponding to each vertex, and vertex lists to describe the projection). See go/pir-spec for mshp atom data layout. | String |
| headingDegrees | VideoFileSphericalMetadataPose | Specifies the compass heading, pitch & roll for the origin of the projection. The origin for the “equirectangular” projection is the center of the image. The origin for the other projection types is defined as the location in the image that corresponds to the origin of an “equirectangular” projection. | number | |
| pitchDegrees | VideoFileSphericalMetadataPose | Specifies the compass heading, pitch & roll for the origin of the projection. The origin for the “equirectangular” projection is the center of the image. The origin for the other projection types is defined as the location in the image that corresponds to the origin of an “equirectangular” projection. | number | |
| rollDegrees | VideoFileSphericalMetadataPose | Specifies the compass heading, pitch & roll for the origin of the projection. The origin for the “equirectangular” projection is the center of the image. The origin for the other projection types is defined as the location in the image that corresponds to the origin of an “equirectangular” projection. | number | |
| headingDegrees | VideoFileSphericalMetadataViewDirection | integer | ||
| pitchDegrees | VideoFileSphericalMetadataViewDirection | integer | ||
| rollDegrees | VideoFileSphericalMetadataViewDirection | integer | ||
| aloudLoggingId | Used to track videos produced via Aloud dubbing. | VideoGoogleVideoClipInfo | YT app video information. (go/yt-create-vsi-data) | String |
| appVersion | YT app version (ie. YT Create app version). | VideoGoogleVideoClipInfo | YT app video information. (go/yt-create-vsi-data) | String |
| assetLoggingId | List of YT media asset logging ids. | VideoGoogleVideoClipInfo | YT app video information. (go/yt-create-vsi-data) | list(String) |
| dubbingLoggingId | Used to track videos produced via Universal Dubbing. | VideoGoogleVideoClipInfo | YT app video information. (go/yt-create-vsi-data) | String |
| productType | Product used to create this video clip. | VideoGoogleVideoClipInfo | YT app video information. (go/yt-create-vsi-data) | String |
| featureSetName | VideoLegosLegosAnnotationsSet | String | ||
| legosAnnotations | VideoLegosLegosAnnotationsSet | YoutubeDiscoveryLegosLegosAnnotations | ||
| annotationsSet | VideoLegosLegosAnnotationsSets | list(VideoLegosLegosAnnotationsSet) | ||
| audioStream | Each entry corresponds to one audio stream in the original media file. | VideoMediaInfo | Feel free to ignore this lint warning if only the trivia (e.g., comments) is is changed. LINT.IfChange | list(VideoAudioStream) |
| containerId | Container type of the file, e.g. FLV, H264, MP3. Uses the numeric value corresponding to the ContainerId enum objects, in order to avoid the dependency on vsi/videostreaminfo.proto. http://cs/symbol:ContainerId%20f:google3/video/vidproc/vsi/videostreaminfo.proto | VideoMediaInfo | Feel free to ignore this lint warning if only the trivia (e.g., comments) is is changed. LINT.IfChange | integer |
| fileSize | Media file size in bytes. | VideoMediaInfo | Feel free to ignore this lint warning if only the trivia (e.g., comments) is is changed. LINT.IfChange | String |
| overview | This is a high-level description of the media. It does not contain PII. | VideoMediaInfo | Feel free to ignore this lint warning if only the trivia (e.g., comments) is is changed. LINT.IfChange | VideoMediaOverview |
| videoStream | Each entry corresponds to one video stream (usually just one) in the original media file. | VideoMediaInfo | Feel free to ignore this lint warning if only the trivia (e.g., comments) is is changed. LINT.IfChange | list(VideoVideoStream) |
| aspectRatio | VideoMediaOverview | Next ID: 19 IMPORTANT: This file is used in scattered directories, such that it is risky to add values to any enumerated type. (First of all, compilation breaks on switch statements without default clauses.) Run a global tap presubmit: tap_presubmit -p all –train -c before submitting. Also check out the blame layer of previous updates for hints on what other files to changes. | String | |
| audioOverview | VideoMediaOverview | Next ID: 19 IMPORTANT: This file is used in scattered directories, such that it is risky to add values to any enumerated type. (First of all, compilation breaks on switch statements without default clauses.) Run a global tap presubmit: tap_presubmit -p all –train -c before submitting. Also check out the blame layer of previous updates for hints on what other files to changes. | list(VideoMediaOverviewAudioOverview) | |
| authoringTool | VideoMediaOverview | Next ID: 19 IMPORTANT: This file is used in scattered directories, such that it is risky to add values to any enumerated type. (First of all, compilation breaks on switch statements without default clauses.) Run a global tap presubmit: tap_presubmit -p all –train -c before submitting. Also check out the blame layer of previous updates for hints on what other files to changes. | String | |
| colorDynamicRange | VideoMediaOverview | Next ID: 19 IMPORTANT: This file is used in scattered directories, such that it is risky to add values to any enumerated type. (First of all, compilation breaks on switch statements without default clauses.) Run a global tap presubmit: tap_presubmit -p all –train -c before submitting. Also check out the blame layer of previous updates for hints on what other files to changes. | String | |
| creationTimeStampUsec | Creation timestamp of this media_info, in Unix timestamp since epoch. | VideoMediaOverview | Next ID: 19 IMPORTANT: This file is used in scattered directories, such that it is risky to add values to any enumerated type. (First of all, compilation breaks on switch statements without default clauses.) Run a global tap presubmit: tap_presubmit -p all –train -c before submitting. Also check out the blame layer of previous updates for hints on what other files to changes. | String |
| dataOverview | VideoMediaOverview | Next ID: 19 IMPORTANT: This file is used in scattered directories, such that it is risky to add values to any enumerated type. (First of all, compilation breaks on switch statements without default clauses.) Run a global tap presubmit: tap_presubmit -p all –train -c before submitting. Also check out the blame layer of previous updates for hints on what other files to changes. | list(VideoMediaOverviewDataOverview) | |
| frameRate | VideoMediaOverview | Next ID: 19 IMPORTANT: This file is used in scattered directories, such that it is risky to add values to any enumerated type. (First of all, compilation breaks on switch statements without default clauses.) Run a global tap presubmit: tap_presubmit -p all –train -c before submitting. Also check out the blame layer of previous updates for hints on what other files to changes. | String | |
| hasChapters | Currently used by originals replacement pipeline to exclude all videos containing chapter info. | VideoMediaOverview | Next ID: 19 IMPORTANT: This file is used in scattered directories, such that it is risky to add values to any enumerated type. (First of all, compilation breaks on switch statements without default clauses.) Run a global tap presubmit: tap_presubmit -p all –train -c before submitting. Also check out the blame layer of previous updates for hints on what other files to changes. | boolean |
| mediaClipInfoOverview | VideoMediaOverview | Next ID: 19 IMPORTANT: This file is used in scattered directories, such that it is risky to add values to any enumerated type. (First of all, compilation breaks on switch statements without default clauses.) Run a global tap presubmit: tap_presubmit -p all –train -c before submitting. Also check out the blame layer of previous updates for hints on what other files to changes. | VideoMediaOverviewMediaClipInfoOverview | |
| orientation | The orientation is annotated based on the final displayed resolution of the video file. A video will be labelled PORTRAIT whenever the height is greater than the width. The orientation is only labelled UNKNOWN in the case that the video stream had some transformation that was not a rotation in the video stream. | VideoMediaOverview | Next ID: 19 IMPORTANT: This file is used in scattered directories, such that it is risky to add values to any enumerated type. (First of all, compilation breaks on switch statements without default clauses.) Run a global tap presubmit: tap_presubmit -p all –train -c before submitting. Also check out the blame layer of previous updates for hints on what other files to changes. | String |
| origin | VideoMediaOverview | Next ID: 19 IMPORTANT: This file is used in scattered directories, such that it is risky to add values to any enumerated type. (First of all, compilation breaks on switch statements without default clauses.) Run a global tap presubmit: tap_presubmit -p all –train -c before submitting. Also check out the blame layer of previous updates for hints on what other files to changes. | String | |
| projection | VideoMediaOverview | Next ID: 19 IMPORTANT: This file is used in scattered directories, such that it is risky to add values to any enumerated type. (First of all, compilation breaks on switch statements without default clauses.) Run a global tap presubmit: tap_presubmit -p all –train -c before submitting. Also check out the blame layer of previous updates for hints on what other files to changes. | String | |
| resolution | The resolution for a video takes into account the displayed video size, and takes into account the orientation. For example: – A 1920×1080 video will have ORIENTATION_LANDSCAPE and RESOLUTION_1080P – A 1080×1920 video will have ORIENTATION_PORTRAIT and RESOLUTION_1080P – A 1080×1080 video will have ORIENTATION_LANDSCAPE and RESOLUTION_1080P | VideoMediaOverview | Next ID: 19 IMPORTANT: This file is used in scattered directories, such that it is risky to add values to any enumerated type. (First of all, compilation breaks on switch statements without default clauses.) Run a global tap presubmit: tap_presubmit -p all –train -c before submitting. Also check out the blame layer of previous updates for hints on what other files to changes. | String |
| spatialAudioMode | VideoMediaOverview | Next ID: 19 IMPORTANT: This file is used in scattered directories, such that it is risky to add values to any enumerated type. (First of all, compilation breaks on switch statements without default clauses.) Run a global tap presubmit: tap_presubmit -p all –train -c before submitting. Also check out the blame layer of previous updates for hints on what other files to changes. | String | |
| stereoMode | VideoMediaOverview | Next ID: 19 IMPORTANT: This file is used in scattered directories, such that it is risky to add values to any enumerated type. (First of all, compilation breaks on switch statements without default clauses.) Run a global tap presubmit: tap_presubmit -p all –train -c before submitting. Also check out the blame layer of previous updates for hints on what other files to changes. | String | |
| timedtextOverview | VideoMediaOverview | Next ID: 19 IMPORTANT: This file is used in scattered directories, such that it is risky to add values to any enumerated type. (First of all, compilation breaks on switch statements without default clauses.) Run a global tap presubmit: tap_presubmit -p all –train -c before submitting. Also check out the blame layer of previous updates for hints on what other files to changes. | list(VideoMediaOverviewTimedTextOverview) | |
| videoOverview | VideoMediaOverview | Next ID: 19 IMPORTANT: This file is used in scattered directories, such that it is risky to add values to any enumerated type. (First of all, compilation breaks on switch statements without default clauses.) Run a global tap presubmit: tap_presubmit -p all –train -c before submitting. Also check out the blame layer of previous updates for hints on what other files to changes. | list(VideoMediaOverviewVideoOverview) | |
| wallyMeshType | This only applies when: projection = PROJECTION_PARTIALLY_SPHERICAL | VideoMediaOverview | Next ID: 19 IMPORTANT: This file is used in scattered directories, such that it is risky to add values to any enumerated type. (First of all, compilation breaks on switch statements without default clauses.) Run a global tap presubmit: tap_presubmit -p all –train -c before submitting. Also check out the blame layer of previous updates for hints on what other files to changes. | String |
| channels | Number of audio channels. | VideoMediaOverviewAudioOverview | Audio stream description with no PII. | integer |
| contentType | Content type of the audio track extracted from VSI. This is only populated with valid “acont” xtag values at the moment, i.e., if VSI reports an invalid string, we ignore it. Supported acont xtag values can be found in google3/video/storage/common/xtag_validation.cc. Examples: “original”, “dubbed”, “descriptive”, “commentary”, etc. | VideoMediaOverviewAudioOverview | Audio stream description with no PII. | String |
| language | Language of the audio track extracted from VSI. Populated if it’s deemed a valid code by ISO639-2b, ISO639-2t or III library. | VideoMediaOverviewAudioOverview | Audio stream description with no PII. | String |
| loudness1770Lkfs | VideoMediaOverviewAudioOverview | Audio stream description with no PII. | float | |
| roundedUpOriginalDurationSec | Approximate audio length, has the same caveats as its video equivalent. | VideoMediaOverviewAudioOverview | Audio stream description with no PII. | integer |
| spatialAudioMode | VideoMediaOverviewAudioOverview | Audio stream description with no PII. | String | |
| hasCameraMotionMetadata | Whether the data stream has camera motion metadata (dynamic) or not (static). Some Wally/VR180 videos do. | VideoMediaOverviewDataOverview | Data stream description with no PII. Currently used by originals replacement pipeline to exclude all clips that have data streams. Fields in proto are used to exclude clips with certain types of data streams. | boolean |
| hasOzoAudio | If true, source contains metadata for OZO spatial audio support. See b/62393568 for more information about the OZO spatial audio format. Note that SpatialAudioMode is independent of this format. | VideoMediaOverviewDataOverview | Data stream description with no PII. Currently used by originals replacement pipeline to exclude all clips that have data streams. Fields in proto are used to exclude clips with certain types of data streams. | boolean |
| hasGeolocation | Corresponds to vsi.video_clip_info().has_geolocation() | VideoMediaOverviewMediaClipInfoOverview | Video clip info description with no PII. | boolean |
| aspectRatio | VideoMediaOverviewVideoOverview | Video stream description with no PII. | String | |
| averageFps | Prefer average_fps to match the logic used in transcoder for format profile frame rate checks. First added for Photos, see b/165839654. | VideoMediaOverviewVideoOverview | Video stream description with no PII. | float |
| codecId | VideoMediaOverviewVideoOverview | Video stream description with no PII. | integer | |
| colorDynamicRange | VideoMediaOverviewVideoOverview | Video stream description with no PII. | String | |
| fps | VideoMediaOverviewVideoOverview | Video stream description with no PII. | float | |
| height | VideoMediaOverviewVideoOverview | Video stream description with no PII. | integer | |
| resolution | VideoMediaOverviewVideoOverview | Video stream description with no PII. | String | |
| roundedUpOriginalDurationSec | Approximate video length. Data is rounded up to the next second, to avoid being PII. (Long ago, YTFE set a precedent of rounding up durations, rather than rounding to the closest second.) This value is derived from metadata in the source video, and often differs from the actual duration of any given transcode. In videos without valid timestamps, this value is not calculable, and is reported as zero. Prefer the value from MediaInfo::VideoStream over this value, which was added to resolve b/202864365. | VideoMediaOverviewVideoOverview | Video stream description with no PII. | integer |
| videoHasClosedCaptions | VideoMediaOverviewVideoOverview | Video stream description with no PII. | boolean | |
| width | VideoMediaOverviewVideoOverview | Video stream description with no PII. | integer | |
| coreSignals | VideoPerDocData | MediaIndexVideoCoreSignals | ||
| frames | VideoPerDocData | MediaIndexVideoFrames | ||
| frameBlobRefs | The blobRef where the representative frame is stored. This is repeated in order to support multiple thumbnails in the future. | VideoPipelineViperThumbnailerColumnData | list(BlobstoreBlobRef) | |
| frameFileList | Video frame files (based on file_dir_to_save_frames parameter) | VideoPipelineViperThumbnailerColumnData | VideoThumbnailsFrameFileList | |
| frameTypeGenerated | Frame type generated (VR/360/3D/default). | VideoPipelineViperThumbnailerColumnData | String | |
| generatedFromDrishtiThumbnailer | True if the thumbnails are generated from drishti_thumbnailer. | VideoPipelineViperThumbnailerColumnData | boolean | |
| highResPreviewThumbnailGenerated | VideoPipelineViperThumbnailerColumnData | boolean | ||
| hq720Generated | hq720.jpg is a 1280×720 pixel image generated only when the input video resolution is 1280×720 or higher. | VideoPipelineViperThumbnailerColumnData | boolean | |
| hqdefaultGenerated | The flags below indicate whether certain optional thumbnail images were generated. hqdefault.jpg is a 480×360 pixel high quality image which should normally be always generated. | VideoPipelineViperThumbnailerColumnData | boolean | |
| hvcBackupGenerated | True if a set of backup HVC thumbnails is generated. | VideoPipelineViperThumbnailerColumnData | boolean | |
| improvedVerticalGenerated | True if the thumbnails are generated with background crop and scrim. | VideoPipelineViperThumbnailerColumnData | boolean | |
| maxresdefaultGenerated | maxresdefault.jpg is an image of the same resolution as the input video. It is generated only when the input video is significantly higher-resolution than 640×480. | VideoPipelineViperThumbnailerColumnData | boolean | |
| maxresdefaultHeight | Height of the generated maxresdefault thumbnail. | VideoPipelineViperThumbnailerColumnData | integer | |
| maxresdefaultWidth | Width of the generated maxresdefault thumbnail. | VideoPipelineViperThumbnailerColumnData | integer | |
| movingThumbnailGenerated | True if moving thumbnails are generated. | VideoPipelineViperThumbnailerColumnData | boolean | |
| privateThumbnailsGenerated | True if private thumbnails were generated and stored in the thumbnail database. | VideoPipelineViperThumbnailerColumnData | boolean | |
| publicThumbnailsGenerated | True if public thumbnails were generated and stored in the thumbnail database. | VideoPipelineViperThumbnailerColumnData | boolean | |
| rerunStatus | Analysis result of running the rerun thumbnailer | VideoPipelineViperThumbnailerColumnData | String | |
| sddefaultGenerated | sddefault.jpg is a 640×480 pixel image generated only when the input video resolution is 640×480 or higher. | VideoPipelineViperThumbnailerColumnData | boolean | |
| storyboardGenerated | This flag indicates if storyboard mosaic images were generated and stored in the thumbnail database. | VideoPipelineViperThumbnailerColumnData | boolean | |
| storyboardNumLevels | Number of levels of storyboard generated (0 if policy default). | VideoPipelineViperThumbnailerColumnData | integer | |
| storyboardPolicy | Policy number that governed the storyboard generation. If zero, no policy was used and the storyboard format is not fully specified by the parameters contained in this message. | VideoPipelineViperThumbnailerColumnData | integer | |
| storyboardVersion | Version of the storyboard. | VideoPipelineViperThumbnailerColumnData | integer | |
| storyboardVideoDurationMs | Video duration of the video. | VideoPipelineViperThumbnailerColumnData | integer | |
| storyboardVideoHeight | Height of the video that was storyboarded. | VideoPipelineViperThumbnailerColumnData | integer | |
| storyboardVideoWidth | Width of the video that was storyboarded. | VideoPipelineViperThumbnailerColumnData | integer | |
| webpGenerated | This flag indicates if images in WebP format were created and stored in the thumbnail database. | VideoPipelineViperThumbnailerColumnData | boolean | |
| info | VideoPipelineViperVSIColumnData | VideoVideoStreamInfo | ||
| inputReadTime | Total time taken in seconds to read the input | VideoPipelineViperVSIColumnData | float | |
| partialFile | Was the VSI computed on a partial file ? | VideoPipelineViperVSIColumnData | boolean | |
| totalVsiTime | Total time (of all attempts) taken in seconds to compute VSI | VideoPipelineViperVSIColumnData | float | |
| vsiStats | VideoPipelineViperVSIColumnData | list(VideoPipelineViperVSIColumnDataVsiStats) | ||
| partialVsi | True if the output vsi is a partial vsi. | VideoPipelineViperVSIColumnDataVsiStats | The stats of each output vsi. | boolean |
| vsiTime | The time (in secondes) from vsi_engine init to vsi written to output buffer. | VideoPipelineViperVSIColumnDataVsiStats | The stats of each output vsi. | float |
| denominator | VideoRational32 | integer | ||
| numerator | VideoRational32 | integer | ||
| count | message count of each payloadtype | VideoSEIMessage | This SEI message only takes the payload type and the sum of the payload sizes for all SEI messages of this type. More informations, such as timestamp, payload, may be added in the future. | integer |
| cumulativeSize | If the video stream has multiple SEI messages with the same payload type, this is the sum of all these payloads’ sizes. | VideoSEIMessage | This SEI message only takes the payload type and the sum of the payload sizes for all SEI messages of this type. More informations, such as timestamp, payload, may be added in the future. | String |
| payloadtype | use int type in case there are payload types that are not included in the SEIPayloadType enum below. The enum can be used for lookup | VideoSEIMessage | This SEI message only takes the payload type and the sum of the payload sizes for all SEI messages of this type. More informations, such as timestamp, payload, may be added in the future. | integer |
| itu1770LoudnessDb | Loudness measured using ITU-R BS. 1770 | VideoStorageLoudnessData | Measurement of loudness. Next tag = 3 | number |
| perceptualLoudnessDb | Perceived loudness of audio measured using replaygain. | VideoStorageLoudnessData | Measurement of loudness. Next tag = 3 | number |
| filename | VideoThumbnailsFrameFile | Individual video frame saved in an image file. | String | |
| height | VideoThumbnailsFrameFile | Individual video frame saved in an image file. | integer | |
| msOffset | VideoThumbnailsFrameFile | Individual video frame saved in an image file. | integer | |
| width | VideoThumbnailsFrameFile | Individual video frame saved in an image file. | integer | |
| frameFiles | VideoThumbnailsFrameFileList | List of individual video frames, each saved as an image file | list(VideoThumbnailsFrameFile) | |
| checksum | Checksum of the thumbnail bytes used to identify which image the score belongs to. Only filled when thumbnail version is 0. | VideoThumbnailsThumbnailScore | LINT.IfChange Score calculated from a thumbnail. NextID: 16 | String |
| colorSampling | Color sampling score encoded as uint32. Encode/Decode using youtube::color::RgbToUint / UIntToRgb. Field is only relevant for TYPE_COLOR_SAMPLING. | VideoThumbnailsThumbnailScore | LINT.IfChange Score calculated from a thumbnail. NextID: 16 | integer |
| denseFeatures | Thumbnail dense features. | VideoThumbnailsThumbnailScore | LINT.IfChange Score calculated from a thumbnail. NextID: 16 | list(number) |
| denseGeneralExtraFeatures | FeatureExtra extension for dense features. | VideoThumbnailsThumbnailScore | LINT.IfChange Score calculated from a thumbnail. NextID: 16 | DrishtiFeatureExtra |
| externalImageId | A unique identifier for the image that is independent of the resolution. The Image ID accompanies the image bytes through its lifecycle, from creation till vanishing. Image ID is not based on image content; it is different than checksum (e.g. two different images with the same bytes may not have the same image ID). This ID is used as a unique identifier for clients such as T&S and classifiers. For more info refer to go/thumbnail-id-ts-ab-testing Note: Image ID’s are still in development and are currently not exposed externally (may be done in the future). Please contact yt-thumbnails-core@ before using it. Do not use externally or in logs before contacting yt-thumbnails-core@ | VideoThumbnailsThumbnailScore | LINT.IfChange Score calculated from a thumbnail. NextID: 16 | String |
| isAssigned | If true, score is manually assigned. | VideoThumbnailsThumbnailScore | LINT.IfChange Score calculated from a thumbnail. NextID: 16 | boolean |
| isInstant | If true, score will be instantly indexed by YouTube search indexer. | VideoThumbnailsThumbnailScore | LINT.IfChange Score calculated from a thumbnail. NextID: 16 | boolean |
| modelVersion | VideoThumbnailsThumbnailScore | LINT.IfChange Score calculated from a thumbnail. NextID: 16 | String | |
| overwriteReason | VideoThumbnailsThumbnailScore | LINT.IfChange Score calculated from a thumbnail. NextID: 16 | String | |
| quantizedFeatures | Thumbnail quantized dense features, available in TYPE_STARBURST_COMPRESSED | VideoThumbnailsThumbnailScore | LINT.IfChange Score calculated from a thumbnail. NextID: 16 | String |
| score | VideoThumbnailsThumbnailScore | LINT.IfChange Score calculated from a thumbnail. NextID: 16 | float | |
| sparseFeatures | Thumbnail sparse features, available in TYPE_STARBURST | VideoThumbnailsThumbnailScore | LINT.IfChange Score calculated from a thumbnail. NextID: 16 | DrishtiSparseFeatureData |
| thumbnailSet | VideoThumbnailsThumbnailScore | LINT.IfChange Score calculated from a thumbnail. NextID: 16 | String | |
| thumbnailVersion | Version number of the thumbnail. Should be consistent with the version number in the ytimg_content column family. | VideoThumbnailsThumbnailScore | LINT.IfChange Score calculated from a thumbnail. NextID: 16 | String |
| type | VideoThumbnailsThumbnailScore | LINT.IfChange Score calculated from a thumbnail. NextID: 16 | String | |
| langResults | The complete list of language scores, sorted from high score to low. | VideoTimedtextS4ALIResults | list(VideoTimedtextS4LangScore) | |
| speechClass | What kind of speech (if any) was detected. | VideoTimedtextS4ALIResults | String | |
| confidence | A score between 0.0 and 1.0; the relative probability that this is the language of the video. This should not be interpreted as an absolute probability. For instance, scores may be calculated for all languages even for videos for which no speech was detected. | VideoTimedtextS4LangScore | number | |
| langCode | The language code for one of the languages supported by automatic language identification. | VideoTimedtextS4LangScore | String | |
| count | Counts itu-t t.35 message with the same country code and provider code | VideoUserDataRegisteredItuTT35 | This message contains user data registered itu-t t.35 data | integer |
| countryCode | VideoUserDataRegisteredItuTT35 | This message contains user data registered itu-t t.35 data | integer | |
| providerCode | VideoUserDataRegisteredItuTT35 | This message contains user data registered itu-t t.35 data | integer | |
| count | Counts user data with the same uuid and payload If payload size is larger than limit, the payload will be ‘Payload size is larger than limit: ‘ + limit size Count will be for user data with same uuid and payload exceeds limit in this case | VideoUserDataUnregistered | This message contains unregistered user data identified by a UUID | integer |
| payload | Payload may not be filled in Payload may contain user data | VideoUserDataUnregistered | This message contains unregistered user data identified by a UUID | String |
| uuid | VideoUserDataUnregistered | This message contains unregistered user data identified by a UUID | String | |
| artist | Lists the artist of the original subject of the file. | VideoVideoClipInfo | VideoClipInfo : meta information extracted from video file Next id: 26 | String |
| audioVendorId | Audio vendor ID | VideoVideoClipInfo | VideoClipInfo : meta information extracted from video file Next id: 26 | String |
| author | Different containers use different video clip info. The following fields include info from popular formats: AVI, MOV, and WMV. | VideoVideoClipInfo | VideoClipInfo : meta information extracted from video file Next id: 26 | String |
| comment | VideoVideoClipInfo | VideoClipInfo : meta information extracted from video file Next id: 26 | String | |
| commissioned | Lists the name of the person or organization that commissioned the subject of the file. | VideoVideoClipInfo | VideoClipInfo : meta information extracted from video file Next id: 26 | String |
| copyright | Records the copyright information for the file. | VideoVideoClipInfo | VideoClipInfo : meta information extracted from video file Next id: 26 | String |
| digitizationTime | VideoVideoClipInfo | VideoClipInfo : meta information extracted from video file Next id: 26 | String | |
| director | VideoVideoClipInfo | VideoClipInfo : meta information extracted from video file Next id: 26 | String | |
| engineer | The engineer who worked on the file. | VideoVideoClipInfo | VideoClipInfo : meta information extracted from video file Next id: 26 | String |
| geolocation | Optional geo-location information in WGS 84. | VideoVideoClipInfo | VideoClipInfo : meta information extracted from video file Next id: 26 | VideoVideoGeoLocation |
| info | VideoVideoClipInfo | VideoClipInfo : meta information extracted from video file Next id: 26 | String | |
| keywords | Provides a list of keywords that refer to the file or subject of the file. | VideoVideoClipInfo | VideoClipInfo : meta information extracted from video file Next id: 26 | String |
| make | The camera make such as Apple, Samsung etc. | VideoVideoClipInfo | VideoClipInfo : meta information extracted from video file Next id: 26 | String |
| medium | Describes the original subject of the file. | VideoVideoClipInfo | VideoClipInfo : meta information extracted from video file Next id: 26 | String |
| metadata | Container level metadata | VideoVideoClipInfo | VideoClipInfo : meta information extracted from video file Next id: 26 | list(VideoClipInfo) |
| model | The camera model such as iPhone7 or Pixel, etc. | VideoVideoClipInfo | VideoClipInfo : meta information extracted from video file Next id: 26 | String |
| performer | VideoVideoClipInfo | VideoClipInfo : meta information extracted from video file Next id: 26 | String | |
| producer | VideoVideoClipInfo | VideoClipInfo : meta information extracted from video file Next id: 26 | String | |
| requirements | VideoVideoClipInfo | VideoClipInfo : meta information extracted from video file Next id: 26 | String | |
| software | Identifies the name of the software packages used to create the file. | VideoVideoClipInfo | VideoClipInfo : meta information extracted from video file Next id: 26 | String |
| sourceProvider | Identifies the name of the person or organization who supplied the original subject of the file. | VideoVideoClipInfo | VideoClipInfo : meta information extracted from video file Next id: 26 | String |
| subject | Describes the contents of the file. | VideoVideoClipInfo | VideoClipInfo : meta information extracted from video file Next id: 26 | String |
| technician | Identifies the technician who digitized the subject file. | VideoVideoClipInfo | VideoClipInfo : meta information extracted from video file Next id: 26 | String |
| title | VideoVideoClipInfo | VideoClipInfo : meta information extracted from video file Next id: 26 | String | |
| videoVendorId | Video vendor ID | VideoVideoClipInfo | VideoClipInfo : meta information extracted from video file Next id: 26 | String |
| altitudeE2 | Altitude is in meters and multiplied by 100 (i.e., in centimeters). Up till 10 km this fits in 3 bytes. | VideoVideoGeoLocation | Generic geo-location information. This is error-prone due to the fact that is uses signed integer fields, which are not supported by proto1 API and are cast to unsigned integers. Consider using the metadata_util function directly, which fills out a version 2 API proto. | integer |
| latitudeE7 | Latitude and longitude are in degrees and multiplied by 10^7. This gives the worst precision of about 1 cm at the equator. | VideoVideoGeoLocation | Generic geo-location information. This is error-prone due to the fact that is uses signed integer fields, which are not supported by proto1 API and are cast to unsigned integers. Consider using the metadata_util function directly, which fills out a version 2 API proto. | integer |
| longitudeE7 | VideoVideoGeoLocation | Generic geo-location information. This is error-prone due to the fact that is uses signed integer fields, which are not supported by proto1 API and are cast to unsigned integers. Consider using the metadata_util function directly, which fills out a version 2 API proto. | integer | |
| bitrate | Video bitrate in bits/s. | VideoVideoStream | String | |
| codecId | Video codec ID. Uses the numeric value corresponding to the CodecId enum object, in order to avoid the dependency on vsi/videostreaminfo.proto. http://cs/symbol:CodecId%20f:google3/video/vidproc/vsi/videostreaminfo.proto | VideoVideoStream | integer | |
| fps | Video frame per second, obtained by parsing video header information. The value can be inaccurate for some types of codecs. See comments at http://cs/symbol:video_fps%20f:google3/video/vidproc/vsi/videostreaminfo.proto | VideoVideoStream | float | |
| height | VideoVideoStream | integer | ||
| lengthSec | Video length, in seconds. This value is derived from metadata in the source video, and often differs from the actual duration of any given transcode. In videos without valid timestamps, this value is not calculable, and is reported as zero. | VideoVideoStream | float | |
| streamIndex | Index of the stream in the file, 0-based. | VideoVideoStream | String | |
| width | The video stream’s width and height. Important notes: 1) These are the coded dimensions of the video stream and DO NOT take into account any rotation metadata that may be present in the video container. Prefer to use the MediaOverview::resolution and MediaOverview::orientation when possible. 2) In the case you want detailed displayed width/height information, you can use the MediaOverview::orientation to determine the displayed dimensions. E.g., in the case of PORTRAIT orientation: displayed_width = min(width, height) displayed_height = max(width, height) And for LANDSCAPE orientation: displayed_width = max(width, height) displayed_height = min(width, height) | VideoVideoStream | integer | |
| profile | video profile | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | String |
| audioStream | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | list(VideoVideoStreamInfoAudioStream) | |
| fileHeaderFingerprint | Input file header fingerprint | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | String |
| videoStream | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | list(VideoVideoStreamInfoVideoStream) | |
| videoNumberOfFrames | Number of Video frames Warning: running video::FfmpegVideoFileInformation() won’t set this info Ffmpeg tool does not report the number of frames accurately. We can’t rely on fps and video length. So we will set this after we processed every frame using the filter framework | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | String |
| pixFmt | Pixel format for the video stream. | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | String |
| fileMagic | The file type string returned by libmagic, a third party library. It might accidentally include some user content. Some normal file_magic examples: — RIFF (little-endian) data, AVI, 1016 x 696, 30.00 fps, video: XviD, audio: (stereo, 48000 Hz) — MPEG sequence, v2, program multiplex — ISO Media, MPEG v4 system, iTunes AVC-LC — Microsoft Windows Movie Maker project file | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | String |
| isImageFile | True if the video is actually an image file (JPEG, PNG, GIF, etc) and not a video file. | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | boolean |
| videoHasNonMonotonicPts | video has non-monotonic PTS. | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | boolean |
| numTimedtextStreams | Total number of timedtext streams in the file | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | integer |
| videoEndTimestamp | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | String | |
| videoFps | video frame per second, obtained by parsing video header information. It could be inaccurate for some types of codecs, notably, WMV, ASF, and FLV. It will be inaccurate for videos that does not have constant frame rate since it is the smallest framerate that can accurately represent all timestamps (see ffmpeg doc for AVStream.r_frame_rate). Also frame rate can be parsed from headers and can be wrong if it is not available there since ffmpeg uses a heuristic for determining it. | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | float |
| videoNumberOfInvisibleFrames | Invisible frame count Keep a count of frames that are not displayed should the full frame count be needed for the video stream. The only codec currently reporting this value is VP8 with alternate reference frames enabled | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | integer |
| videoHasNonMonotonicDts | video has non-monotonic DTS (potential problem) | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | boolean |
| audioChannels | audio channels | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | integer |
| videoPixelAspectRatio | video pixel aspect ratio | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | float |
| videoClipInfo | Video clip information, such as copyright, title, and author. | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | VideoVideoClipInfo |
| videostreaminfoVersion | Version number of the videostreaminfo application that generated this protobuf. | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | integer |
| audioFrameSize | audio frame size | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | String |
| audioStreamCodecTag | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | String | |
| audioEndTimestamp | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | String | |
| metadata | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | VideoVideoStreamInfoMetadata | |
| timedtextStream | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | list(VideoVideoStreamInfoTimedTextStream) | |
| videoHasNonZeroStartEditList | video (MOV) has a possibly av desync issue due to edit lists not starting at 0 | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | boolean |
| numDataStreams | Total number of data streams in the file | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | integer |
| avDistance | Audio-Video interleaving distance between packets (in bytes) | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | String |
| audioLength | audio length in seconds Note that when the VSI is from users videos, it is not guaranteed to be the same as transcode lengths and it could be 0 when the full VSI cannot compute the length from the source header and timestamps (for example when header and timestamps are too broken). | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | float |
| parsedByInHouseParsers | True if the file was successfully parsed by in-house parsers. Unset if parsing wasn’t attepmted. | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | boolean |
| videoHasPossibleOpenGop | video has possible open GOP | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | boolean |
| fileName | Input file name. DEPRECATED; don’t expect the file name to be correct. | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | String |
| numVideoStreams | Total number of video streams in the file | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | integer |
| dataStream | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | list(VideoVideoStreamInfoDataStream) | |
| audioSampleSize | Number of meaningful bits per decoded audio sample. This is an implicit conceptual meaning. This is *NOT* the same as ffmpeg’s internal sample format that is used when actually decoding with ffmpeg. | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | integer |
| containsChapters | If the video contains chapters info. | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | boolean |
| containerType | Name of the container format guessed by ffmpeg. | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | String |
| audioBitrate | audio bitrate in bits/s | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | float |
| containerId | Container Id. | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | String |
| videoInterlace | Information on interlaced video. | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | String |
| partialFile | By default we assume that the entire file was given computing the VSI – if that is not true this flag should be set to true. | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | boolean |
| videoHeight | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | integer | |
| avLength | Audio and video length in seconds. It’s the max of the audio and video length. Note that when the VSI is from users videos, it is not guaranteed to be the same as transcode lengths and it could be 0 when the full VSI cannot compute the length from the source header and timestamps (for example when header and timestamps are too broken). | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | float |
| averageVideoFps | Average video fps from analyzing entire file. | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | float |
| audioSampleRate | audio sample rate | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | String |
| audioNumberOfFrames | Number of audio frames. Ffmpeg does not report the number of frames accurately. video::TranscodedVideoFileInformation calls Google’s analyzer to get information of both audio and video frame numbers. | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | String |
| imageStream | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | list(VideoVideoStreamInfoVideoStream) | |
| videoHasBFrames | video has b frames | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | boolean |
| fileModifiedTime | Input file modification time | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | String |
| videoStartTimestamp | Start/end timestamps of audio/video in ms. | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | String |
| isAsf | True if the video is likely to be an ASF file. | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | boolean |
| videoRotation | Is the video rotated ? | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | String |
| videoFrameSize | video frame size | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | String |
| videoHasLeadingMoovAtom | video (MOV) has moov atom before mdat atom allowing streaming transcoding | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | boolean |
| videoCodecId | Primary video codec information Fields 1-2, 4-10, 28, 37, 44, 49, 51, 54-55, 57-62, 69 will be obsolete soon. Please start using the new repeated video_stream. For now, video_stream(0) will match these fields. Note however that some of the fields in VideoStream are not populated correctly yet in videostreaminfo.cc, but that will be handled gradually. | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | String |
| parsedByFfmpeg | If this field is not set, then only base video file information has been generated (and ffmpeg parsing hasn’t yet been done). If this is set to ‘false’, then ffmpeg failed to parse the file – otherwise it will set to ‘true’ | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | boolean |
| videoBitrate | video bitrate in bits/s | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | float |
| audioCodecId | Primary audio codec information Fields 15-20, 41-42, 48, 52-53 for audio will be obsolete soon. Please start using the new repeated audio_stream and video_stream. For now, audio_stream(0) will match these fields. Primary audio codec information starts: | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | String |
| googleVideoClipInfo | YT app created video information, | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | VideoGoogleVideoClipInfo |
| level | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | integer | |
| videoHasVariableAspectRatio | video has frames with different aspect ratios. | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | boolean |
| fileType | High-level file type guessed by looking at the file headers and libmagic. | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | integer |
| isVideoInsaneSize | Check if a video size insane or not. It is set if the input file is an MOV file. | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | boolean |
| displayHeight | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | integer | |
| numAudioStreams | Total number of audio streams in the file | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | integer |
| videoWidth | source video width and height | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | integer |
| fileSize | Input file size in bytes | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | String |
| audioStartTimestamp | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | String | |
| videoLength | video length in seconds Note that when the VSI is from users videos, it is not guaranteed to be the same as transcode lengths and it could be 0 when the full VSI cannot compute the length from the source header and timestamps (for example when header and timestamps are too broken). | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | float |
| videoHasFragments | video (MOV) has fragments | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | boolean |
| yPsnr | Luma PSNR of the transcoded file. | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | float |
| numImageStreams | Total number of image streams in the file | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | integer |
| videoStreamCodecTag | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | integer | |
| buildLabel | Build label of the VSI mpm. | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | String |
| displayWidth | final display video width and height if explicitly set in the video otherwise this can be calculated from source width/height and video_pixel_aspect_ratio | VideoVideoStreamInfo | Note that when a VSI is from a user video, the information reflects the info in that source. Fields like lengths, fps, etc. are not guaranteed to be the same as those of transcodes. If the relevant info in source is too broken, the corresponding fields (e.g., lengths) could be unset or with the default value, meaning VSI cannot compute them from the given info. Next id: 84 | integer |
| ambisonics | Optional ambisonics metadata. | VideoVideoStreamInfoAudioStream | Next id: 25 | VideoAmbisonicsAmbisonicsMetadata |
| bitrate | audio bitrate in bits/s | VideoVideoStreamInfoAudioStream | Next id: 25 | String |
| channelPosition | VideoVideoStreamInfoAudioStream | Next id: 25 | list(String) | |
| channels | number of audio channels | VideoVideoStreamInfoAudioStream | Next id: 25 | integer |
| clockDiscontinuityUs | some container allows for a clock discontinuity. In this case, the end_timestamp may not be the correct DTS of the stream. | VideoVideoStreamInfoAudioStream | Next id: 25 | String |
| codecFourcc | VideoVideoStreamInfoAudioStream | Next id: 25 | String | |
| codecId | Primary audio codec information | VideoVideoStreamInfoAudioStream | Next id: 25 | String |
| codecString | RFC6381 Codec string. | VideoVideoStreamInfoAudioStream | Next id: 25 | String |
| contentType | Specifies the content_type of the audio stream as given in the metadata. | VideoVideoStreamInfoAudioStream | Next id: 25 | String |
| decodeOffset | The bytes offset of the end of the first decodable packet. | VideoVideoStreamInfoAudioStream | Next id: 25 | String |
| endTimestamp | VideoVideoStreamInfoAudioStream | Next id: 25 | String | |
| frameSize | audio frame size | VideoVideoStreamInfoAudioStream | Next id: 25 | String |
| language | Specifies the language of the audio stream as given in the metadata. | VideoVideoStreamInfoAudioStream | Next id: 25 | String |
| length | audio length in seconds Note that when the VSI is from users videos, it is not guaranteed to be the same as transcode lengths and it could be 0 when the full VSI cannot compute the length from the source header and timestamps (for example when header and timestamps are too broken). | VideoVideoStreamInfoAudioStream | Next id: 25 | float |
| metadata | Metadata for audio elementary stream; | VideoVideoStreamInfoAudioStream | Next id: 25 | list(VideoClipInfo) |
| numberOfFrames | Number of audio frames. | VideoVideoStreamInfoAudioStream | Next id: 25 | String |
| profile | VideoVideoStreamInfoAudioStream | Next id: 25 | String | |
| sampleRate | audio sample rate | VideoVideoStreamInfoAudioStream | Next id: 25 | String |
| sampleSize | Number of meaningful bits per decoded audio sample. This is an implicit conceptual meaning. This is *NOT* the same as ffmpeg’s internal sample format that is used when actually decoding with ffmpeg. | VideoVideoStreamInfoAudioStream | Next id: 25 | integer |
| startTimestamp | Start/end timestamps of audio in ms. | VideoVideoStreamInfoAudioStream | Next id: 25 | String |
| streamCodecTag | VideoVideoStreamInfoAudioStream | Next id: 25 | String | |
| streamIndex | Index of the stream in the file. it is 0 based. | VideoVideoStreamInfoAudioStream | Next id: 25 | String |
| codecFourcc | VideoVideoStreamInfoDataStream | Data streams refer to additional data separate from audio and video streams For example: camera motion metadata (see http://go/wally-format) Available tags: 4+ | String | |
| codecId | Codec information | VideoVideoStreamInfoDataStream | Data streams refer to additional data separate from audio and video streams For example: camera motion metadata (see http://go/wally-format) Available tags: 4+ | String |
| streamCodecTag | VideoVideoStreamInfoDataStream | Data streams refer to additional data separate from audio and video streams For example: camera motion metadata (see http://go/wally-format) Available tags: 4+ | String | |
| streamIndex | Index of the stream in the file | VideoVideoStreamInfoDataStream | Data streams refer to additional data separate from audio and video streams For example: camera motion metadata (see http://go/wally-format) Available tags: 4+ | String |
| luts | VideoVideoStreamInfoMetadata | VideoVideoStreamInfoMetadataLutAttachments | ||
| videoFpa | Information on Frame Packing arrangement | VideoVideoStreamInfoMetadata | VideoFileFramePackingArrangement | |
| lut | VideoVideoStreamInfoMetadataLutAttachments | An attached 3D look up table | list(VideoVideoStreamInfoMetadataLutAttachmentsLut3D) | |
| data | Lut data, sanitized and encoded in google’s binary coded form of 3D look-up tables. | VideoVideoStreamInfoMetadataLutAttachmentsLut3D | Description and encoding of a 3d lut. | String |
| fileName | Original file name of the lut (present in the original file) | VideoVideoStreamInfoMetadataLutAttachmentsLut3D | Description and encoding of a 3d lut. | String |
| size | The size (in each dimension) of the lut. For a 3D cube of size NxNxN, this will be N. If the value is -1, then the file was determined to be invalid. This is useful for logging files where the input could not be parsed, and is useful for to indicate info of the 3D lut without having to decode/inspect the binary data. | VideoVideoStreamInfoMetadataLutAttachmentsLut3D | Description and encoding of a 3d lut. | integer |
| codecId | Codec information. | VideoVideoStreamInfoTimedTextStream | Timed text streams refer to the streams that are separated from audio and video streams. Closed caption streams embedded in video streams (e.g. MPEG-2 – Line 21) do not belong here. | String |
| metadata | Metadata for the stream. | VideoVideoStreamInfoTimedTextStream | Timed text streams refer to the streams that are separated from audio and video streams. Closed caption streams embedded in video streams (e.g. MPEG-2 – Line 21) do not belong here. | list(VideoClipInfo) |
| streamCodecTag | VideoVideoStreamInfoTimedTextStream | Timed text streams refer to the streams that are separated from audio and video streams. Closed caption streams embedded in video streams (e.g. MPEG-2 – Line 21) do not belong here. | String | |
| streamIndex | Index of the stream in the file. it is 0 based. | VideoVideoStreamInfoTimedTextStream | Timed text streams refer to the streams that are separated from audio and video streams. Closed caption streams embedded in video streams (e.g. MPEG-2 – Line 21) do not belong here. | String |
| profile | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | String | |
| rationalFps | The nominal frame rate (‘fps’ field) represented as a fraction. | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | VideoRational32 |
| pixFmt | Pixel format for the video stream. | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | String |
| numberOfInvisibleFrames | Invisible frame count Keep a count of frames that are not displayed should the full frame count be needed for the video stream. The only codec currently reporting this value is VP8 with alternate reference frames enabled | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | integer |
| closedCaptions | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | VideoClosedCaptions | |
| userDataUnregistered | User data unregistered SEI message | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | list(VideoUserDataUnregistered) |
| bitrate | video bitrate in bits/s | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | String |
| ituTT35 | User data registered Itu-T T.35 SEI message | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | list(VideoUserDataRegisteredItuTT35) |
| masteringDisplayMetadata | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | VideoFileMasteringDisplayMetadata | |
| averageFps | This represents the canonical frame rate of the video. This is named average_fps for historical reasons, and may not actually be the arithmetic mean. For variable frame rate videos, the algorithm may change again in future. Currently, full vsi set it with arithmetic mean, and partial vsi set it with median. | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | float |
| hasBFrames | video has b frames | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | boolean |
| width | source video width and height | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | integer |
| metadata | Metadata for video elementary stream; | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | list(VideoClipInfo) |
| interlace | Information on interlaced video. | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | String |
| height | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | integer | |
| length | video length in seconds Note that when the VSI is from users videos, it is not guaranteed to be the same as transcode lengths and it could be 0 when the full VSI cannot compute the length from the source header and timestamps (for example when header and timestamps are too broken). | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | float |
| pixelAspectRatio | video pixel aspect ratio | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | float |
| rotation | Is the video rotated ? | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | String |
| frameSize | video frame size | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | String |
| numberOfFrames | Number of video frames. | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | String |
| gopSize | Statistics about gop sizes of the video. | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | VideoVideoStreamInfoVideoStreamStatistics |
| codecId | Primary video codec information | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | String |
| contentLightLevel | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | VideoFileContentLightLevel | |
| streamCodecTag | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | String | |
| doviConfiguration | Dolby Vision configuration if stream is compatible. | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | VideoDoViDecoderConfiguration |
| codecFourcc | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | String | |
| isInsaneSize | Check if a video size insane or not. It is set if the input file is an MOV file. | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | boolean |
| fps | video frame per second, obtained by parsing video header information. It could be inaccurate for some types of codecs, notably, WMV, ASF, and FLV. It will be inaccurate for videos that does not have constant frame rate since it is the smallest framerate that can accurately represent all timestamps (see ffmpeg doc for AVStream.r_frame_rate). Also frame rate can be parsed from headers and can be wrong if it is not available there since ffmpeg uses a heuristic for determining it. | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | float |
| minFps | Minimum instantaneous frame rate seen from analyzing the entire stream. | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | float |
| endTimestamp | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | String | |
| maxFps | Maximum instantaneous frame rate seen from analyzing the entire stream. | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | float |
| spherical | Optional spherical video information. | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | VideoFileSphericalMetadata |
| streamIndex | Index of the stream in the file. it is 0 based. | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | String |
| clockDiscontinuityUs | some container allows for a clock discontinuity. In this case, the end_timestamp may not be the correct DTS of the stream. | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | String |
| seiMessage | video SEI payload types and total payload size of a type this is only for H.264 and H.265 | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | list(VideoSEIMessage) |
| level | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | integer | |
| codecString | RFC6381 Codec string. | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | String |
| cleanAperture | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | VideoVideoStreamInfoVideoStreamCleanAperture | |
| flip | Should the video be mirrored horizontally / vertically? When rotation and flip both are present for a video, it is assumed that the flip is applied first, and then the rotation. | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | String |
| displayHeight | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | integer | |
| colorInfo | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | VideoFileColorInfo | |
| bitstreamColorInfo | Contains the color information obtained after inspection of the bitstream in cases where there may be inconsistencies between container and coded bitstream that are resolved in favor of the container. | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | VideoFileColorInfo |
| closedGopSize | closed_gop_size refers to chunkable boundaries for each specified codec and may actually contain one or more GOPs, e.g. for H.264, closed_gop_size will denote the distance (frame count) between two IDR frames. | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | VideoVideoStreamInfoVideoStreamStatistics |
| decodeOffset | The bytes offset of the end of the first decodable packet. | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | String |
| hdr10PlusStats | Stats on HDR10+ over video frames. | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | VideoFileHDR10PlusStats |
| startTimestamp | Start/end timestamps of audio/video in ms. | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | String |
| displayWidth | final display video width and height if explicitly set in the video otherwise this can be calculated from source width/height and video_pixel_aspect_ratio | VideoVideoStreamInfoVideoStream | TODO(yanghu) add 25/50/75 percentiles of FPS to have a 5 number summary. Next id: 48 | integer |
| height | VideoVideoStreamInfoVideoStreamCleanAperture | integer | ||
| horizontalOffset | VideoVideoStreamInfoVideoStreamCleanAperture | integer | ||
| verticalOffset | VideoVideoStreamInfoVideoStreamCleanAperture | integer | ||
| width | VideoVideoStreamInfoVideoStreamCleanAperture | integer | ||
| max | VideoVideoStreamInfoVideoStreamStatistics | String | ||
| mean | VideoVideoStreamInfoVideoStreamStatistics | float | ||
| min | VideoVideoStreamInfoVideoStreamStatistics | String | ||
| diversificationThreshold | Diversification threshold used in prediction. Additional responses which are closer than the threshold to the already selected responses will be skipped. | VideoYoutubeCommentsClassificationProtoSmartSuggestion | number | |
| likelihoodBiasWeight | Bias weight used in prediction. | VideoYoutubeCommentsClassificationProtoSmartSuggestion | number | |
| replyContent | Content of the reply snippet (could include emoji as well as text). | VideoYoutubeCommentsClassificationProtoSmartSuggestion | String | |
| score | Model score for the predicted reply snippet. | VideoYoutubeCommentsClassificationProtoSmartSuggestion | float | |
| smartSuggestions | The order of the reply snippets in the list determines how they should be displayed in the UI and the client is not supposed to re-order the list using the scores. | VideoYoutubeCommentsClassificationProtoYouTubeCommentSmartReply | Smart reply suggestions for comment. | list(VideoYoutubeCommentsClassificationProtoSmartSuggestion) |
| suggestionListIdentifier | Identifier (language_code, channel_id, etc) for the suggestion list from which the top k suggestions are selected. | VideoYoutubeCommentsClassificationProtoYouTubeCommentSmartReply | Smart reply suggestions for comment. | String |
| downvotes | VideoYoutubeCommentsRankingCTRMetrics | Used for stanza KV pair. Next tag: 7. | String | |
| impressions | VideoYoutubeCommentsRankingCTRMetrics | Used for stanza KV pair. Next tag: 7. | String | |
| measureWindow | VideoYoutubeCommentsRankingCTRMetrics | Used for stanza KV pair. Next tag: 7. | String | |
| teaserClicks | VideoYoutubeCommentsRankingCTRMetrics | Used for stanza KV pair. Next tag: 7. | String | |
| teaserImpressions | VideoYoutubeCommentsRankingCTRMetrics | Used for stanza KV pair. Next tag: 7. | String | |
| upvotes | VideoYoutubeCommentsRankingCTRMetrics | Used for stanza KV pair. Next tag: 7. | String | |
| languageScore | A list of watchpage languages predicted arranged according to their scores. | WatchpageLanguageWatchPageLanguageModelPredictions | Next ID: 4 | list(WatchpageLanguageWatchPageLanguageModelPredictionsLanguageScore) |
| usesSpeechSignals | Does the prediction uses speech signals like audio language. | WatchpageLanguageWatchPageLanguageModelPredictions | Next ID: 4 | boolean |
| version | An identifier to recognize the model version used for this prediction. | WatchpageLanguageWatchPageLanguageModelPredictions | Next ID: 4 | String |
| score | Score for the predicted language by the WatchPage Language model. | WatchpageLanguageWatchPageLanguageModelPredictionsLanguageScore | Next ID: 3 | number |
| watchpageLanguage | The language predicted by the WatchPage Language model. | WatchpageLanguageWatchPageLanguageModelPredictionsLanguageScore | Next ID: 3 | String |
| predictions | Versioned WatchPageLanguageResults. This is to experiment and launch new models. The first prediction is the latest production version. | WatchpageLanguageWatchPageLanguageResult | Next ID: 3 | list(WatchpageLanguageWatchPageLanguageModelPredictions) |
| watchpageLanguage | The language predicted by the V1 WatchPage Language model. For new and experimental versions use versioned_language_result. | WatchpageLanguageWatchPageLanguageResult | Next ID: 3 | String |
| boostLevel | Identifies the degree to which the existence of this LiveResult should boost a query’s score (when the query is performed within the hot_times range). This field is always in the range [0,1]. A missing field, a value of 0, or a value outside the legal range indicates that no boosting is performed. A value of 1 indicates that the maximum level of boosting will be applied. This field will be updated from time to time based on CTR and other signals. | WeboftrustLiveResultDocBoostData | Page boosting using Live Results data. Attaching this proto to a document indicates that a Live Result feed exists for that document, and that this feed has sufficient reliability to warrant potential boosting of the document rank. Next ID: 3 | number |
| hotTimes | Specifies the time range within which this LiveResult is relevant. Used for deciding whether the rank of the corresponding page should be boosted. For example, this range can be set to encompass a few days before and after a sports game to which the page refers. If this field is missing, no boosting is performed. Specifying that a page should always be boosted is not recommended, but can be accomplished by setting hot_times.start_unix_time=0 and hot_time.end_unix_time=0x7fffffff. Note that multiple time ranges can be implemented by adding several LiveResultDocBoostData messages to the LiveResultsDocAttachments proto. If overlapping time ranges are used, the proto containing the highest boost level will be used. | WeboftrustLiveResultDocBoostData | Page boosting using Live Results data. Attaching this proto to a document indicates that a Live Result feed exists for that document, and that this feed has sufficient reliability to warrant potential boosting of the document rank. Next ID: 3 | WeboftrustTimeRange |
| providerId | WeboftrustLiveResultProviderDocAttachment | Per-provider attachment of a LiveResult. Used to identify pages for which result-based triggering of Live Results should appear. Theoretically there can be more than one attachment per web document, so we keep them as a repeated field of the LiveResultsDocAttachment. Next ID: 4 | String | |
| tag | Tag that specifies the use-case within provider’s data. It appears as a string in Alexandria signal and in the DocJoins. During the indexing stage this field will be converted to a 64-bit fingerprint to save space. See the “tag_fp” field, below. | WeboftrustLiveResultProviderDocAttachment | Per-provider attachment of a LiveResult. Used to identify pages for which result-based triggering of Live Results should appear. Theoretically there can be more than one attachment per web document, so we keep them as a repeated field of the LiveResultsDocAttachment. Next ID: 4 | String |
| tagFp | A fingerprint of the “tag” field, automatically calculated during the indexing stage. Will be used as a key for fetching the data. | WeboftrustLiveResultProviderDocAttachment | Per-provider attachment of a LiveResult. Used to identify pages for which result-based triggering of Live Results should appear. Theoretically there can be more than one attachment per web document, so we keep them as a repeated field of the LiveResultsDocAttachment. Next ID: 4 | String |
| docBoost | Information about potential rank boosting for the document by virtue of its Live Result feed. | WeboftrustLiveResultsDocAttachments | Message to which we attach to web documents in order to decide which LiveResult to trigger. Next ID: 3 | list(WeboftrustLiveResultDocBoostData) |
| providerAttachment | Identifies a Live Result which is to be attached to the document. | WeboftrustLiveResultsDocAttachments | Message to which we attach to web documents in order to decide which LiveResult to trigger. Next ID: 3 | list(WeboftrustLiveResultProviderDocAttachment) |
| endUnixTime | WeboftrustTimeRange | Time range (start time and end time). Used to indicate the times in which a LiveResult is considered “hot” and thus a potential for boosting. Specified as Unix time (seconds since midnight, January 1, 1970). Time zone is same as that for query_start_time (i.e., GMT). Next ID: 3 | String | |
| startUnixTime | Start and end times should always appear. Marked as optional to avoid breaking code. | WeboftrustTimeRange | Time range (start time and end time). Used to indicate the times in which a LiveResult is considered “hot” and thus a potential for boosting. Specified as Unix time (seconds since midnight, January 1, 1970). Time zone is same as that for query_start_time (i.e., GMT). Next ID: 3 | String |
| privateDoNotAccessOrElseSafeHtmlWrappedValue | IMPORTANT: Never set or read this field, even from tests, it is private. See documentation at the top of .proto file for programming language packages with which to create or read this message. | WebutilHtmlTypesSafeHtmlProto | IMPORTANT: It is unsafe to accept this message from an untrusted source, since it’s trivial for an attacker to forge serialized messages that don’t fulfill the type’s safety contract — for example, it could contain attacker controlled script. A system which receives a SafeHtmlProto implicitly trusts the producer of the SafeHtmlProto. So, it’s generally safe to return this message in RPC responses, but generally unsafe to accept it in RPC requests. | String |
| name | WirelessTranscoderFetchFetchMetadata | String | ||
| value | WirelessTranscoderFetchFetchMetadata | String | ||
| detail | Provides fetcher-specific detail about how source satisfied the request. | WirelessTranscoderFetchFetchSourceInfo | To tag which fetcher satisfied this fetch request with optional detail. | String |
| source | The fetcher that ultimately satisfied this fetch request. | WirelessTranscoderFetchFetchSourceInfo | To tag which fetcher satisfied this fetch request with optional detail. | String |
| shoppingAttachment | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | QualityShoppingShoppingAttachment | |
| isRoboted | Is disallowed for crawling according to host’s robots.txt. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | boolean |
| googleLabelData | Addition to support google label per-search-result annotation. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | String |
| thumbHeight | thumbnail height | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | integer |
| visibleImage | If an image request, was the coupled image visible on the page? | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | boolean |
| thumbnail | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | list(WWWDocInfoThumbnail) | |
| docVersionId | Fields generated by the docserver, but whose meaning is unclear. Sometimes last crawl time | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | String |
| authMethod | Sometimes called secureid | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | integer |
| relatedimages | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | list(WWWDocInfoRelatedImages) | |
| isSoftporn | Doc softporn classification. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | boolean |
| imageSize | size in bytes; | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | integer |
| metaDescriptionLanguages | If meta description/body title were detected to be in a different language from the document language (the ‘language’ field above) in RosettaLanguageAnnotator, the detected languages are populated here. Note: as of ariane/154728, no more than one language is populated for each field. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | list(String) |
| visualType | Is this doc visual RTL? See enum VisualType in visualtype.h. Default is NOT_VISUAL_DOCUMENT. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | String |
| seenNoindex | Has noindex meta robots flag | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | boolean |
| imageLicenseInfo | Image license info such as license url and how to acquire the license. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | ImageSearchImageLicenseInfo |
| isAnimated | Is this image animated? | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | boolean |
| badMetadescription | Bad meta flag | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | boolean |
| isHostedImage | Hosted Images related fields. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | boolean |
| seenNoarchive | Has noarchive meta robots flag | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | boolean |
| additionalSafesearchStats | Additional stats output by SafeSearch. See classifier/porn/public/porn-attachments.h. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | list(integer) |
| fuzzyMetadescription | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | boolean | |
| contentType | If not present, then the type | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | String |
| indexingTs | The timestamp (the time since the Epoch, in microseconds) when the docjoin is exported from indexing. This is mainly exported and used by Youtube Search. See MustangBasicInfo.indexing_ts for more details. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | String |
| encoding | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | String | |
| shoppingOffers | Shopping offer info from Inventory & Policy Service. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | list(ImageMustangShoppingOffer) |
| imageHeight | image height | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | integer |
| cropData | Thumbnail cropping information. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | integer |
| crawlTime | Last time this doc crawled | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | String |
| seenNoodp | NOTE(kinoue): ODP/GWD snippet is unlaunched as of June 2017. This is no longer used. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | boolean |
| bodySize | Size of document | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | integer |
| languageTag | This returns the most probable language for the document. The complete set of languages is in the GenericSearchResponse. (If some future use requires all languages from the doc request, note that fetching that will require decoding the entire per-doc data attachment, which is a performance hit) Use docinfo-util.h to set & read language fields. Language tag as defined by http://www.unicode.org/reports/tr35/#Identifiers and https://tools.ietf.org/html/bcp47 If not present, then use language. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | String |
| thumbWidth | Additions for image search. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | integer |
| fileTypeId | If converted to TEXT or HTML | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | String |
| noimageframeoverlayreason | If not 0, we should not show the image in overlay mode in image snippets. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | integer |
| nearbyText | Nearby text of the image on landing page. Used to construct Scroll to Image urls. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | String |
| pornStats | ‘porn_stats’ is used in porn demotion and filtering. See classifier/porn/public/porn-attachments.h. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | integer |
| boilerplateMetadescription | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | boolean | |
| partialBoilerplateMetadescription | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | boolean | |
| language | go/iii-td b/130371355 | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | String |
| ipaddr | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | String | |
| foreignMetadescription | Indicate if the meta description in a different language than its page. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | boolean |
| nsrSitechunk | Sitechunk used by NSR. For most pages this is equivalent HOST_LEVEL_V3 sitechunk. Main difference is that, for sites like youtube.com and vimeo.com, nsr_sitechunks are channel level (based on schema.org markup, not url alone). See go/nsr-chunks for more details. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | String |
| qualityWithoutAdjustment | Quality score (also known as QScore, see go/qscore-faq). | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | number |
| isPorn | Doc porn classification. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | boolean |
| hasBadSslCertificate | If true, the original document has a bad SSL certificate. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | boolean |
| seenNosnippet | Has nosnippet meta robots flag | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | boolean |
| dataVersion | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | String | |
| ip | If ipaddr is set, ip should be ignored (it should not be set). Ipaddr should be either 4- or 16-byte string for IPv4 or IPv6 addresses. If ipaddr is not set, ip is set to the IPv4 address for the host. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | integer |
| seenNopreview | Has nopreview meta robots flag | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | boolean |
| imageWidth | image width | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | integer |
| lastModTime | Unused by gws | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | String |
| referrerUrl | Url of referring doc | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | String |
| urlAfterRedirects | empty => same as url | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | String |
| unionBuildTime | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | String | |
| url | Url | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | String |
| licensedWebImagesOptInState | Indicates the web-master opt-in state of this image. This project is still in MVP stage, please contact us licensed-media-team@ before use. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | String |
| colorDetectionResult | Detected color in the image in RGB565 format in the lower 16 bits. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | integer |
| coupledUrl | Url of coupled doc (e.g. image) | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | String |
| imagePublisher | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | String | |
| subindex | Subindex id of the document should be one of the values defined by enum CompositeDoc::SubIndexType. Used for superroot/gws logging if a shard has documents from multiple indices. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | integer |
| rootpageDuplicateMetadescription | True if the meta-description is duplicated on many other pages and this page is the rootpage of such pages which have the same meta-description. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | boolean |
| urlEncoding | See webutil/urlencoding | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | integer |
| bodyTitleLanguages | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | list(String) | |
| lowQualityMetadescription | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | boolean | |
| isSitePorn | Consider the page classification is_porn as an alternative for is_site_porn, and talk to [email protected] for additional information if needed. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | boolean |
| failsSafeSearch | fails_safe_search is never filled in production. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | String |
| seenNotranslate | Has notranslate meta robots flag | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | boolean |
| coupledUrlEncoding | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | integer | |
| title | Landing page title. | WWWDocInfo | Some per-doc info is returned for all www DocInfo requests. Next id: 94 | String |
| imageDocid | WWWDocInfoRelatedImages | Return related images. | String | |
| thumbHeight | WWWDocInfoRelatedImages | Return related images. | integer | |
| thumbType | WWWDocInfoRelatedImages | Return related images. | String | |
| thumbWidth | WWWDocInfoRelatedImages | Return related images. | integer | |
| expirationTimestampMicros | WWWDocInfoThumbnail | String | ||
| height | WWWDocInfoThumbnail | integer | ||
| type | The type here corresponds to image_base::ThumbnailType defined in image/base/thumbnail-type.proto. | WWWDocInfoThumbnail | integer | |
| width | WWWDocInfoThumbnail | integer | ||
| content | WWWMetaTag | We can return the content attribute for some or all meta tags. | String | |
| name | WWWMetaTag | We can return the content attribute for some or all meta tags. | String | |
| additionalSafesearchSignals | WWWResultInfoSubImageDocInfo | The following message contains info of sub image docs, it is populated in query_state and consumed in web image boost twiddler: (go/WebImageBoostTwiddler). NextID: 26 | list(integer) | |
| bestThumbnailType | The best thumbnail type is either 300K or 50K. | WWWResultInfoSubImageDocInfo | The following message contains info of sub image docs, it is populated in query_state and consumed in web image boost twiddler: (go/WebImageBoostTwiddler). NextID: 26 | String |
| crops | WWWResultInfoSubImageDocInfo | The following message contains info of sub image docs, it is populated in query_state and consumed in web image boost twiddler: (go/WebImageBoostTwiddler). NextID: 26 | integer | |
| deepCropBytes | Deepcrop thumbnail cropping hints. | WWWResultInfoSubImageDocInfo | The following message contains info of sub image docs, it is populated in query_state and consumed in web image boost twiddler: (go/WebImageBoostTwiddler). NextID: 26 | String |
| dimeScore | EQ* v3: Deep Image Engagingness(DImE) go/deep-image-engagingness-slides | WWWResultInfoSubImageDocInfo | The following message contains info of sub image docs, it is populated in query_state and consumed in web image boost twiddler: (go/WebImageBoostTwiddler). NextID: 26 | number |
| docid | WWWResultInfoSubImageDocInfo | The following message contains info of sub image docs, it is populated in query_state and consumed in web image boost twiddler: (go/WebImageBoostTwiddler). NextID: 26 | String | |
| documentTrust | WWWResultInfoSubImageDocInfo | The following message contains info of sub image docs, it is populated in query_state and consumed in web image boost twiddler: (go/WebImageBoostTwiddler). NextID: 26 | number | |
| eqStar | EQ* is a unified signal to capture the emotional quality (e.g. inspiration, lifestyle, context, etc.) of an image. For more information, please refer to go/image-inspiration-ranking-framework. | WWWResultInfoSubImageDocInfo | The following message contains info of sub image docs, it is populated in query_state and consumed in web image boost twiddler: (go/WebImageBoostTwiddler). NextID: 26 | number |
| estRelevance | Estimated Image Relevance ranging between 0.0 (Off-Topic) to 1.0 (Very Useful). | WWWResultInfoSubImageDocInfo | The following message contains info of sub image docs, it is populated in query_state and consumed in web image boost twiddler: (go/WebImageBoostTwiddler). NextID: 26 | number |
| estSigmaU | Estimated Sigma U calculated from U*. | WWWResultInfoSubImageDocInfo | The following message contains info of sub image docs, it is populated in query_state and consumed in web image boost twiddler: (go/WebImageBoostTwiddler). NextID: 26 | number |
| flowOutput | WWWResultInfoSubImageDocInfo | The following message contains info of sub image docs, it is populated in query_state and consumed in web image boost twiddler: (go/WebImageBoostTwiddler). NextID: 26 | ImageContentFlowProtoProd | |
| height | WWWResultInfoSubImageDocInfo | The following message contains info of sub image docs, it is populated in query_state and consumed in web image boost twiddler: (go/WebImageBoostTwiddler). NextID: 26 | integer | |
| height50k | WWWResultInfoSubImageDocInfo | The following message contains info of sub image docs, it is populated in query_state and consumed in web image boost twiddler: (go/WebImageBoostTwiddler). NextID: 26 | integer | |
| humanModelScore | DeepTags human model score. go/VisualShoppingImageAttributes | WWWResultInfoSubImageDocInfo | The following message contains info of sub image docs, it is populated in query_state and consumed in web image boost twiddler: (go/WebImageBoostTwiddler). NextID: 26 | number |
| imageUrl | WWWResultInfoSubImageDocInfo | The following message contains info of sub image docs, it is populated in query_state and consumed in web image boost twiddler: (go/WebImageBoostTwiddler). NextID: 26 | String | |
| pamirNormalizedScore | WWWResultInfoSubImageDocInfo | The following message contains info of sub image docs, it is populated in query_state and consumed in web image boost twiddler: (go/WebImageBoostTwiddler). NextID: 26 | number | |
| pornSignals | Encoded Safe Search annotations of the image. See image/safesearch/overall/public/image_porn_attachments.h for decoding functions. | WWWResultInfoSubImageDocInfo | The following message contains info of sub image docs, it is populated in query_state and consumed in web image boost twiddler: (go/WebImageBoostTwiddler). NextID: 26 | integer |
| safeForUniversal | Result is not on the Images Universal blacklist. For more comprehensive filtering of IU images, including this bit, see superroot/impls/images/quality/safesearch/iu_inappropriate_filter_lib.h | WWWResultInfoSubImageDocInfo | The following message contains info of sub image docs, it is populated in query_state and consumed in web image boost twiddler: (go/WebImageBoostTwiddler). NextID: 26 | boolean |
| salience | Salient score, indicating how important an image is to the page it’s on. Check go/salient-images-design-doc for details. | WWWResultInfoSubImageDocInfo | The following message contains info of sub image docs, it is populated in query_state and consumed in web image boost twiddler: (go/WebImageBoostTwiddler). NextID: 26 | number |
| salientColorInfo | 4-bytes: (low order on the left) RRRRRRRR GGGGGGGG BBBBBBBB SS where R: 8-bits encoding color ‘r’ G: 8-bits encoding color ‘g’ B: 8-bits encoding color ‘b’ S: 2-bits encoding the color source – 00 = from color detection result – 01 = from cairo This field has the salient color information. | WWWResultInfoSubImageDocInfo | The following message contains info of sub image docs, it is populated in query_state and consumed in web image boost twiddler: (go/WebImageBoostTwiddler). NextID: 26 | integer |
| score | WWWResultInfoSubImageDocInfo | The following message contains info of sub image docs, it is populated in query_state and consumed in web image boost twiddler: (go/WebImageBoostTwiddler). NextID: 26 | number | |
| tqStar | TQ* is a signal to capture the technical quality (e.g. exposure, sharpness, composition, etc.) of an image. For more information, please refer to go/tqstar. | WWWResultInfoSubImageDocInfo | The following message contains info of sub image docs, it is populated in query_state and consumed in web image boost twiddler: (go/WebImageBoostTwiddler). NextID: 26 | number |
| tradFrac | WWWResultInfoSubImageDocInfo | The following message contains info of sub image docs, it is populated in query_state and consumed in web image boost twiddler: (go/WebImageBoostTwiddler). NextID: 26 | number | |
| width | WWWResultInfoSubImageDocInfo | The following message contains info of sub image docs, it is populated in query_state and consumed in web image boost twiddler: (go/WebImageBoostTwiddler). NextID: 26 | integer | |
| width50k | Width and height of the AREA_50K thumbnail for this image. | WWWResultInfoSubImageDocInfo | The following message contains info of sub image docs, it is populated in query_state and consumed in web image boost twiddler: (go/WebImageBoostTwiddler). NextID: 26 | integer |
| odp | Was odp used in the snippets? DEPRECATED – this is no longer populated as of June 2017. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | boolean |
| titleRenderedToken | How tokens are rendered in generating title. Note: In rendering a title, the page title part and the site/host/domain title part can be flipped after initial rendering. The flip, if happened, may not be reflected in this field. That is, this field may contain the tokens in the original, pre-flip, order. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | list(MustangSnippetsRenderedToken) |
| snippetPrefixCharCount | Character counts of snippet prefix, if any. E.g. section heading, list summary, byline date. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | integer |
| obsoleteSitemap | These fields were previously optional messages, but CL 2388905 moved them into the MessageSet. However, at this time, old Mustang binaries are still deployed in production and probably will be around for awhile. So, servers which need to talk to old binaries and need to use these fields need to check both the obsolete versions and the MessageSet version. Sitemap | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | String |
| extraInfo | If requested, the extra snippet info | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | ExtraSnippetInfoResponse |
| docInfo | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | WWWDocInfo | |
| matchesBitmapEncoded | Bitmap representing matches to leaf query terms within document (body section and url). It gets populated if query_matches_info = true. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | String |
| snippethash | A hash for duplicate detection. Two results with the same content can return different snippets if, for example, one has an ODP entry and the other does not. Gws can use this value reliably to filter duplicates. It is a hash of body only tidbits. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | String |
| metaTags | Meta tags | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | list(WWWMetaTag) |
| keyword | Document keywords | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | list(String) |
| titleSizeParams | Will only be set when `title_use_num_of_chars` is false. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | TitleSizeParams |
| chosenBodyTidbits | Tidbits chosen from the document body. Consists of repeated [begin, end) half-open ranges in token offsets from the beginning of the document. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | list(integer) |
| hasMessageType | Additional available data (message type ids) | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | list(integer) |
| events | Bitfield of snippet events and the various events. See SnippetEvents in ./snippets/defines.h for details on the contents. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | String |
| numTokensSkippedByInDocRestrictionsInPrinting | Similar to num_tokens_skipped_by_in_doc_restrictions_in_scoring, but this number is for tokens skipped during printing, since printer owns its own token info manager which populates tokens. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | integer |
| snippetBylineDate | Byline date for time sensitive snippets. Most of the time it originates from quality_timebased::SyntacticDate and it is floored to PT midnight. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | String |
| listSummary | List summary phrase for list pages. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | String |
| snippetRenderedToken | How tokens are rendered in generating snippet. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | list(MustangSnippetsRenderedToken) |
| sectionHeadingAnchorName | If requested, the snippet generator may take note of query items present in an entry in an on-page table-of-contents (i.e. a series of on-page links to named anchors.) If so, these two fields contain the formatted and highlighted entry and the name of the on-page anchor it links to, respectively. This may be used by GWS to show a direct link to that named anchor on the page. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | String |
| obsoleteManybox | ManyboxData | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | String |
| orionEntities | DEPRECATED If requested, the orion entities | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | OrionDocEntitiesProto |
| sentimentSnippets | DEPRECATED Sentiment snippets | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | list(RepositoryAnnotationsMustangSentimentSnippetAnnotations) |
| findyTidbits | A bitvector of the tidbits in the snippet that are appropriate for the Quick Scroll (Findy) Chrome extension. Typically these contain “extra body matches”, i.e., important query items not in the title. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | integer |
| answerDocMatches | A list of answers that had at least one hit in the document. Answers are identified by their index into the QRewriteQueryParams_AnswerSnippetInfo array (see //query/proto/query-params.proto). | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | list(integer) |
| scienceInfo | Abbreviated bibliographic data from Google Scholar. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | ScienceIndexSignal |
| titleLengthAdjustedForBrowserWidth | True if the title length is already adjusted for the browser width. If it is true, GWS needs not truncate the title. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | boolean |
| snippetsRanklabFeatures | Records features to analyze titles/snippets in ranklab. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | MustangReposWwwSnippetsSnippetsRanklabFeatures |
| isLoginPage | True if the document represents a login page. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | boolean |
| numberOfPages | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | integer | |
| docPreviewRestrictionsForAmp | DocPreviewRestrictions for amp result. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | QualityDniDocPreviewRestrictions |
| siteDisplayName | The domain-level display name of the website, such as “Google” for google.com. See go/site-display-name for more details. As of Aug 2023, this field is being deprecated in favor of `info.[AlternativeTitlesResponse].site_display_name_response` field, which also contains host-level site display names with additional information. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | String |
| docPreviewRestrictions | DocPreviewRestrictions for canonical url. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | QualityDniDocPreviewRestrictions |
| truncatedTitle | Only for desktop web search. Please refer to Title.keep_original_title_and_populate_truncated_one for more details. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | String |
| snippetPageNumber | If requested the page number on which the snippet begins. (Only for documents such as PDFs where page numbers are well-defined.) | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | integer |
| snippetExtraInfo | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | SnippetExtraInfo | |
| matchesBitmapSize | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | integer | |
| seenNotTerm | Did a negative query term match the meta description? | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | boolean |
| numTokensSkippedByInDocRestrictionsInScoring | Number of tokens that is skipped because of in doc restrictions during scoring. This is an estimate, as the list of tokens is cached in TokenInfoManager. We should only monitor the cases where this number is too big or non-zero. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | integer |
| snippetHighlightMatchesBitmap | List of bitmaps representing matches to leaf query terms within each of the highlighted snippet text fragments. Consecutive bitmaps correspond to consecutive text fragments. It gets populated iff return_query_snippet_highlight_matches = true. Example: document body section: “This cafe has pet friendly patio.” squery: (a (o dog 😮 pet :syn:general) friendly 😮 (o restaurant 😮 cafe :syn:general)) Let’s assume the returned snippet text contains the whole document body section where two fragments get highlighted as follows: “This *cafe* has *pet friendly* patio.” Then, the returned snippet_highlight_matches_bitmap[] list will have two bitmaps: bitmap[0] = <"cafe" -> leaf term with index 4> = {encoded: DenseEncode(“00001”), size: 5} bitmap[1] = <"pet" and "friendly" -> leaf terms with indexes 1 and 2> = {encoded: DenseEncode(“011”), size: 3} | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | list(WWWSnippetResponseBitmapPB) |
| obsoleteLocalinfo | LocalWWWInfo | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | String |
| longStructuredSnippet | Returned if want_long_structured_snippets. If present, caller should ignore the normal snippet. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | LongStructuredSnippet |
| listSnippet | List snippet data. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | ListSnippetResponse |
| squeryFingerprint | This field is never set. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | String |
| isValidResult | Assume this is true unless we discover that the result doesn’t match the the query, in which case this result is invalid despite having returned docinfo. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | boolean |
| info | Additional data. Currently, this is used for sitelinks, localinfo, manybox, discussion metadata, richsnippets, similarpages and breadcrumbs. | WWWSnippetResponse | Per-document response for a www DocInfo request. Next field position: 55 | Proto2BridgeMessageSet |
| encoded | WWWSnippetResponseBitmapPB | Encoded bitmap. | String | |
| size | WWWSnippetResponseBitmapPB | Encoded bitmap. | integer | |
| currencyCode | Currency code the user uses to purchase this Super Thanks item. | YoutubeBackstageSuperVodCommentInfo | Contains information about comment that is posted through a Super Thanks purchase. Next ID: 7 | String |
| entitlementId | The ID of the Super Thanks entitlement. It uniquely identifies a Super Thanks purchase. This field is deprecated in favor of transaction_id, see go/st-deprecate-ent-id. | YoutubeBackstageSuperVodCommentInfo | Contains information about comment that is posted through a Super Thanks purchase. Next ID: 7 | String |
| priceInMicros | Price of Super Thanks item the user purchases in micros. | YoutubeBackstageSuperVodCommentInfo | Contains information about comment that is posted through a Super Thanks purchase. Next ID: 7 | String |
| superVodItemId | The Super Thanks item the user purchases, it represents price tier. | YoutubeBackstageSuperVodCommentInfo | Contains information about comment that is posted through a Super Thanks purchase. Next ID: 7 | String |
| transactionId | The ID of the Super Thanks transaction. It uniquely identifies a Super Thanks purchase. | YoutubeBackstageSuperVodCommentInfo | Contains information about comment that is posted through a Super Thanks purchase. Next ID: 7 | String |
| version | Which version of experiment this Super Thanks comment is posted in. | YoutubeBackstageSuperVodCommentInfo | Contains information about comment that is posted through a Super Thanks purchase. Next ID: 7 | String |
| demotedRestrictionSeverity | Output only. The severity of the active demotion. At most one CommentDemotedRestriction can be active at any time. Only supported for Comments with an associated ChatEvent. | YoutubeCommentsApiCommentEnforcementStatus | Derived fields that encapsulate the possible enforcement states of a Comment. Used to influence the viewer experience. NextID: 11 —– CommentDemotedRestriction Summary —– Demoted Restriction hides live chat messages from being shown in Top Chat. | String |
| exemptFromHold | Output only. True if the comment is auto-approved by creator-defined roles and is not subject to automod hold. | YoutubeCommentsApiCommentEnforcementStatus | Derived fields that encapsulate the possible enforcement states of a Comment. Used to influence the viewer experience. NextID: 11 —– CommentDemotedRestriction Summary —– Demoted Restriction hides live chat messages from being shown in Top Chat. | boolean |
| held | Output only. True if the comment is held and going to be reviewed by channel owner or moderators. The issuers that can hold entity comments are: 1) TNS 2) AUTOMOD, 3) CHANNEL_SETTINGS, 4) CHANNEL_MODERATOR, 5)GLOBAL, 6) ISSUER_UNSPECIFIED. The issuers that can hold live chat are // 1) AUTOMOD, 2) GLOBAL, 3) ISSUER_UNSPECIFIED. Issuer definitions: https://source.corp.google.com/piper///depot/google3/video/youtube/comments/api/proto/comment_restriction_issuer.proto;rcl=586954033;l=15 This is used to infer the SBE moderation_state for entity comment and live chat. | YoutubeCommentsApiCommentEnforcementStatus | Derived fields that encapsulate the possible enforcement states of a Comment. Used to influence the viewer experience. NextID: 11 —– CommentDemotedRestriction Summary —– Demoted Restriction hides live chat messages from being shown in Top Chat. | boolean |
| heldForCreatorReviewStatus | Output only. The moderation state of comments that have been held. Currently only effective for live chat because we can not tell the rejected creator review status for entity comments from current data model. | YoutubeCommentsApiCommentEnforcementStatus | Derived fields that encapsulate the possible enforcement states of a Comment. Used to influence the viewer experience. NextID: 11 —– CommentDemotedRestriction Summary —– Demoted Restriction hides live chat messages from being shown in Top Chat. | String |
| moderated | Output only. True if the comment is moderated and not overridden by creator reviews. | YoutubeCommentsApiCommentEnforcementStatus | Derived fields that encapsulate the possible enforcement states of a Comment. Used to influence the viewer experience. NextID: 11 —– CommentDemotedRestriction Summary —– Demoted Restriction hides live chat messages from being shown in Top Chat. | boolean |
| moderatedByBlockedWords | Output only. True if the comment is moderated due to any of the creator-defined blocked words. | YoutubeCommentsApiCommentEnforcementStatus | Derived fields that encapsulate the possible enforcement states of a Comment. Used to influence the viewer experience. NextID: 11 —– CommentDemotedRestriction Summary —– Demoted Restriction hides live chat messages from being shown in Top Chat. | boolean |
| moderatedByChatRemoval | Output only. Live Chat only. True only if the live chat message is directly moderated by a privileged user from Live Chat chat room. go/ytfexit-live-chat-moderation#remove-chat-messages | YoutubeCommentsApiCommentEnforcementStatus | Derived fields that encapsulate the possible enforcement states of a Comment. Used to influence the viewer experience. NextID: 11 —– CommentDemotedRestriction Summary —– Demoted Restriction hides live chat messages from being shown in Top Chat. | boolean |
| moderatedByTns | Output only. True if the comment is moderated by TnS. Maps to SBE Spam http://google3/video/youtube/comments/backstage/backend/lib/stream_v2/stream_item_reader.cc?l=597 | YoutubeCommentsApiCommentEnforcementStatus | Derived fields that encapsulate the possible enforcement states of a Comment. Used to influence the viewer experience. NextID: 11 —– CommentDemotedRestriction Summary —– Demoted Restriction hides live chat messages from being shown in Top Chat. | boolean |
| rejected | Output only. True if the comment is rejected or taken down by TNS. | YoutubeCommentsApiCommentEnforcementStatus | Derived fields that encapsulate the possible enforcement states of a Comment. Used to influence the viewer experience. NextID: 11 —– CommentDemotedRestriction Summary —– Demoted Restriction hides live chat messages from being shown in Top Chat. | boolean |
| userModerationDecision | Output only. The moderation decision on comments from privileged users. This field can be used to take place of `held_for_creator_review_status` for live chat, together with `held_by_non_tns`. | YoutubeCommentsApiCommentEnforcementStatus | Derived fields that encapsulate the possible enforcement states of a Comment. Used to influence the viewer experience. NextID: 11 —– CommentDemotedRestriction Summary —– Demoted Restriction hides live chat messages from being shown in Top Chat. | YoutubeCommentsApiCommentEnforcementStatusUserModerationDecision |
| moderationStatus | The moderation status of comments due to privileged user decision. Privileged user can manually reject comments in multiple ways or approve held comments. | YoutubeCommentsApiCommentEnforcementStatusUserModerationDecision | String | |
| rejectType | For comments with REJECTED status, it can result from privileged users directly rejecting comments or reviewing comments that have been held, for both entity comment and live chat, but reject type is only captured for live chat because we are not able to distinguish the 2 types from data model for entity comment. | YoutubeCommentsApiCommentEnforcementStatusUserModerationDecision | String | |
| autoModEnforcements | Live chat auto moderation only. The HOLD decisions and whether they are enforced correspondingly. | YoutubeCommentsApiCommentModeratedRestriction | Data representing a comment moderated restriction. A moderated comment is hidden from all viewers except for comment author. A comment can be moderated due to multiple moderated restrictions from multiple issuers. Each is represented by a CommentModeratedRestriction entry which is uniquely identified by the external comment id and the create time in the storage. Conceptually, there should be exactly one moderated restriction for a specific reason per issuer per reviewable value and this constraint will be enforced in the Comment API endpoints. For more context see go/yt-comment-restriction-data-model ## Next id: 11. ## Spanner primary key attributes | list(YoutubeCommentsApiCommentModeratedRestrictionAutoModDecisionEnforcement) |
| createTime | Required. The creation time of this restriction. | YoutubeCommentsApiCommentModeratedRestriction | Data representing a comment moderated restriction. A moderated comment is hidden from all viewers except for comment author. A comment can be moderated due to multiple moderated restrictions from multiple issuers. Each is represented by a CommentModeratedRestriction entry which is uniquely identified by the external comment id and the create time in the storage. Conceptually, there should be exactly one moderated restriction for a specific reason per issuer per reviewable value and this constraint will be enforced in the Comment API endpoints. For more context see go/yt-comment-restriction-data-model ## Next id: 11. ## Spanner primary key attributes | DateTime |
| externalCommentId | Required. The external ID of the comment that this restriction described. | YoutubeCommentsApiCommentModeratedRestriction | Data representing a comment moderated restriction. A moderated comment is hidden from all viewers except for comment author. A comment can be moderated due to multiple moderated restrictions from multiple issuers. Each is represented by a CommentModeratedRestriction entry which is uniquely identified by the external comment id and the create time in the storage. Conceptually, there should be exactly one moderated restriction for a specific reason per issuer per reviewable value and this constraint will be enforced in the Comment API endpoints. For more context see go/yt-comment-restriction-data-model ## Next id: 11. ## Spanner primary key attributes | String |
| issuer | Required. The system who moderated the comment. For CommentModeratedRestriction all issuer enums apply.”Issuer” is different from the grouping for permission check, which will be enforced via Boq Scaffolding RpcSecurityPolicy. | YoutubeCommentsApiCommentModeratedRestriction | Data representing a comment moderated restriction. A moderated comment is hidden from all viewers except for comment author. A comment can be moderated due to multiple moderated restrictions from multiple issuers. Each is represented by a CommentModeratedRestriction entry which is uniquely identified by the external comment id and the create time in the storage. Conceptually, there should be exactly one moderated restriction for a specific reason per issuer per reviewable value and this constraint will be enforced in the Comment API endpoints. For more context see go/yt-comment-restriction-data-model ## Next id: 11. ## Spanner primary key attributes | YoutubeCommentsApiCommentRestrictionIssuer |
| reason | Required. The specific restriction reason why the comment is moderated. When Automod issues multiple HOLD decisions for a chat message, they always share the same reason. | YoutubeCommentsApiCommentModeratedRestriction | Data representing a comment moderated restriction. A moderated comment is hidden from all viewers except for comment author. A comment can be moderated due to multiple moderated restrictions from multiple issuers. Each is represented by a CommentModeratedRestriction entry which is uniquely identified by the external comment id and the create time in the storage. Conceptually, there should be exactly one moderated restriction for a specific reason per issuer per reviewable value and this constraint will be enforced in the Comment API endpoints. For more context see go/yt-comment-restriction-data-model ## Next id: 11. ## Spanner primary key attributes | YoutubeCommentsApiCommentRestrictionReason |
| reviewable | True if moderation comes from T&S, Automod, and some of channel owner settings and comments will be put into “Held For Review” queue for channel owner review. After any creator review, this restriction will remain in this status to capture the original restriction. True maps to ModerationState=HOLD in Stanza. False if moderation results from channel owner manual opertation or author in hidden user list, and maps to ModerationState=REJECTED in Stanza. | YoutubeCommentsApiCommentModeratedRestriction | Data representing a comment moderated restriction. A moderated comment is hidden from all viewers except for comment author. A comment can be moderated due to multiple moderated restrictions from multiple issuers. Each is represented by a CommentModeratedRestriction entry which is uniquely identified by the external comment id and the create time in the storage. Conceptually, there should be exactly one moderated restriction for a specific reason per issuer per reviewable value and this constraint will be enforced in the Comment API endpoints. For more context see go/yt-comment-restriction-data-model ## Next id: 11. ## Spanner primary key attributes | boolean |
| status | Required. For moderated restriction on comment and live chat but not issued by Automod, the field should be always set to ACTIVE. For Automod moderation on live chat, the restriction is active as long as one of the HOLD decisions is enforced. Can only be changed by upcoming QPS threshold configuration changes and backfills. | YoutubeCommentsApiCommentModeratedRestriction | Data representing a comment moderated restriction. A moderated comment is hidden from all viewers except for comment author. A comment can be moderated due to multiple moderated restrictions from multiple issuers. Each is represented by a CommentModeratedRestriction entry which is uniquely identified by the external comment id and the create time in the storage. Conceptually, there should be exactly one moderated restriction for a specific reason per issuer per reviewable value and this constraint will be enforced in the Comment API endpoints. For more context see go/yt-comment-restriction-data-model ## Next id: 11. ## Spanner primary key attributes | String |
| updateTime | The timestamp when this restriction is updated. | YoutubeCommentsApiCommentModeratedRestriction | Data representing a comment moderated restriction. A moderated comment is hidden from all viewers except for comment author. A comment can be moderated due to multiple moderated restrictions from multiple issuers. Each is represented by a CommentModeratedRestriction entry which is uniquely identified by the external comment id and the create time in the storage. Conceptually, there should be exactly one moderated restriction for a specific reason per issuer per reviewable value and this constraint will be enforced in the Comment API endpoints. For more context see go/yt-comment-restriction-data-model ## Next id: 11. ## Spanner primary key attributes | DateTime |
| enforced | Whether or not the decision is enforced. | YoutubeCommentsApiCommentModeratedRestrictionAutoModDecisionEnforcement | Whether a HOLD decision is enforced based on the decision name and QPS requirement. For LiveChat, there could be multiple Automod moderations generated at chat message creation time. Only HOLD decisions are persisted. At most one HOLD decision can be enforced based on write QPS. | boolean |
| name | Current the enforcement rule depends on live chat write QPS at chat message creation time. Enforce MEDIAN when QPS<=4. Enforce HIGH_RECALL when QPS>4 AND QPS<=10. Enforce ULTRA_HIGH_RECALL when QPS>10. | YoutubeCommentsApiCommentModeratedRestrictionAutoModDecisionEnforcement | Whether a HOLD decision is enforced based on the decision name and QPS requirement. For LiveChat, there could be multiple Automod moderations generated at chat message creation time. Only HOLD decisions are persisted. At most one HOLD decision can be enforced based on write QPS. | String |
| channelModeratorDetails | Only set when the issuer type is CHANNEL_MODERATOR. | YoutubeCommentsApiCommentRestrictionIssuer | The restriction issuers here identify “who” issues the restriction. It represents restriction granularity at the issuer level so restrictions from different issuers will not override each other. | YoutubeCommentsApiCommentRestrictionIssuerChannelModeratorDetails |
| channelOwnerDetails | Only set when the issuer type is CHANNEL_OWNER. | YoutubeCommentsApiCommentRestrictionIssuer | The restriction issuers here identify “who” issues the restriction. It represents restriction granularity at the issuer level so restrictions from different issuers will not override each other. | YoutubeCommentsApiCommentRestrictionIssuerChannelOwnerDetails |
| issuer | YoutubeCommentsApiCommentRestrictionIssuer | The restriction issuers here identify “who” issues the restriction. It represents restriction granularity at the issuer level so restrictions from different issuers will not override each other. | String | |
| externalChannelId | YoutubeCommentsApiCommentRestrictionIssuerChannelModeratorDetails | Channel moderator info details. Supports audit log functionality that shows moderator activity. | String | |
| externalChannelId | YoutubeCommentsApiCommentRestrictionIssuerChannelOwnerDetails | Channel owner info details. Supports audit log functionality that shows creator activity. | String | |
| reason | YoutubeCommentsApiCommentRestrictionReason | The restriction issuers here identify “why” the restriction is issued. Most reasons are specific to one type of issuer but some of them are shared among multiple issuers. | String | |
| isDeleted | Whether a comment is from deleted shares. See stanza_restrictions for more specific information and is_publicly_visible for comments which are allowed to be seen by everyone. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | boolean |
| numRepliers | Number of different repliers the comment has. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | integer |
| ytReplyToItemId | For replies to replies, this contains the parent reply’s id. The parent_id field is actually the root stanza_id (not guaranteed AFAIK). | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | String |
| detailedLanguageCode | The language code with extra script details. This is derived from detailed_language_code if it’s populated, otherwise the same as language_code. E.g. mr-Latn | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | String |
| contentUpdateTimestamp | The stanza content last update timestamp, as observed by the server. Note that for many comments older than Nov. 2014 this is unset in the original stanza. MiniStanza tries to be consistent with the original so for such comments it remains unset in MiniStanza. If you use this field you should check has_content_update_timestamp(). | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | DateTime |
| ytCommentQualityScore3 | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | float | |
| channelId | The channel of the video or post this comment belongs to. In certain circumstances a video can belong to multiple channels, this channel_id does not handle that situation well. go/yt-identity-overview for further reading. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | String |
| textQualityScores2 | Predicted probability of the comment being flagged based on the text. For testing the new annotation process only. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | YoutubeCommentsRankingYouTubeCommentTextQualityAnnotation |
| isPinned | Whether the comment is pinned. This is derived from YTMS and may be out of sync with other fields (a day early or behind). | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | boolean |
| creationTimeInSeconds | The time when the comment is created. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | String |
| ytCommentQualityScore | Existing quality corpus scores. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | float |
| textQualityScores | Predicted probability of the comment being flagged based on the text. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | YoutubeCommentsRankingYouTubeCommentTextQualityAnnotation |
| superThanksInfo | Super Thanks related info if a comment is posted through a Super Thanks purchase. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | YoutubeBackstageSuperVodCommentInfo |
| wordEntropy | Word entropy of the comment. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | float |
| endUserDeleted | Whether a comment is deleted by the end user. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | boolean |
| commentClassificationBuckets | List of pre-defined classification score buckets to which the comment belongs. E.g. satisfaction_v1_percentile_80. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | list(String) |
| parentId | The parent stanza’s stanza_id, empty for top-level posts (non-replies). Prefer is_reply field for checking if a comment is a reply since that is unaffected by surrogatization. For replies to replies, this is the root stanza_id (not guaranteed AFAIK). | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | String |
| mustDeleteComments | Whether a comment’s author channel is deleted. Populated from http://shortn/_YttLvbraAI. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | boolean |
| offlineEngagementScores | Offline engagement scores map. Keyed by various model names. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | map |
| empiricalCtrs | Comments empirical CTRs. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | VideoYoutubeCommentsRankingCTRMetrics |
| postId | The post this comment belongs to. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | String |
| sensitivityScores | Sensitivity scores map for smart reply sensitivity scores. Keyed by model names. See (g3doc/company/teams/expander/research/conversation/sensitive.md) for more information on sensitivity scores. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | map |
| misinfoScores | Misinfo scores map. Keyed by various model names. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | map |
| languageCode | Unicode CLDR language code of the segments, as implemented by //depot/google3/java/com/google/i18n/identifiers/LanguageCode.java This is derived from user_content and should be considered the canonical language code of the comment. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | String |
| subjectIsVideoOwner | Whether the comment is authored by the creator. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | boolean |
| automodScores | Automod scores map. Keyed by various model names. Deprecated. Consider using low_quality_scores instead. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | map |
| lowQualityDecisions | Low quality decisions. Keyed by decision types corresponding to secondary keys. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | map |
| distillerEngagements | All distiller engagements like reports and downvotes. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | AppsPeopleActivityStreamqualityDistillerEngagements |
| commentType | Whether the comment is on a video, post, or other product. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | String |
| shortReplyVideoId | Associated Short Reply video ID if the comment represents a Short Reply. See go/yt-comment-sticker-m2. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | String |
| ansibleScores | TnS Ansible scores map. Keyed by various model names. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | map |
| commentClassificationRanking | Comment classification for ranking mapping all secondary keys to values. E.g. {“joke_v1”:0.8, “joke_v2”:0.7, “question_v1”:0.3}. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | map |
| videoId | The video this comment belongs to. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | String |
| mentionedTimestampCommentSecond | Timed comments for the “mentioned” secondary key. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | integer |
| commentModeratedRestrictions | Contains various comment moderated restrictions. Only available in the Atlas version. Extracted from http://shortn/_2LzgPEF5K3 | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | list(YoutubeCommentsApiCommentModeratedRestriction) |
| channelProfileQualityScores | Channel profile quality scores map. Keyed by various model names. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | map |
| ytCommentQualityScore2 | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | float | |
| subscriptionTimestamp | The timestamp (in seconds) when the author subscribed to the channel. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | String |
| numDislikes | Number of dislikes the comment has. num_likes and num_dislikes are retrieved from a different source than other fields and may be out of sync (a day early or behind). | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | integer |
| isSubscriber | If the comment author is publicly subscribed to the channel. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | boolean |
| stanzaId | Refers to the stanza this data is derived from. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | String |
| impersonationScores | Impersonation scores map. Keyed by secondary key (score type). | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | map |
| subject | The author of the comment Prefer using yt_author_channel_id instead of subject when possible. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | SecurityCredentialsPrincipalProto |
| segments | A textual content for the context. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | SocialCommonSegments |
| eligibleQualifiedTeaserFilters | The qualified comment teaser filters that this comment is eligible for. Refer to go/comment-teaser-design for more information. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | list(String) |
| isAuthorSponsor | If the author is a channel member (sponsor). | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | boolean |
| coverageSamplingEligible | Whether or not this comment is eligible for comment classifier coverage sampling (in Kapla). Refer to go/coverage-monitoring-for-kapla-comment-classifiers for more information. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | boolean |
| hasCreatorReply | If the comment has a creator reply. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | boolean |
| stanzaRestrictions | Contains various restriction information about a stanza. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | list(SocialStanzaStanzaRestriction) |
| commentEnforcementStatus | Contains the current status of comment enforcement. This provides a summary/aggregation of all restrictions (one per comment), while CommentModeratedRestriction provides the history of restrictions (multiple per comment). Extracted from http://shortn/_m5yiWa8ENR | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | YoutubeCommentsApiCommentEnforcementStatus |
| lastReplyTimestampUsec | The time when last reply is created. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | String |
| numReplies | Number of non-abusive replies the comment has. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | integer |
| numSubscribersBucket | Bucketed number of subscribers held by comment author. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | integer |
| numLikes | Number of likes the comment has. num_likes and num_dislikes are retrieved from a different source than other fields and may be out of sync (a day early or behind). | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | integer |
| charEntropy | Char entropy of the comment. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | float |
| hasCreatorHeart | Indicator for whether there is creator heart on this comment. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | boolean |
| isPubliclyVisible | If the post is publicly visible. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | boolean |
| creationDevice | The creation device. Derived from shares:yt_creation_device | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | String |
| commentClassification | Comment classification mapping all secondary keys to values. E.g. {“joke_v1”:0.8, “joke_v2”:0.7, “question_v1”:0.3}. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | map |
| content | The text content of the comment. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | String |
| isReply | Whether the comment is a reply. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | boolean |
| ytAuthorChannelId | The youtube channel id of the comment author. One person can have multiple channels and one channel can have multiple users. go/yt-identity-overview for further reading. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | String |
| channelDiscussionId | The channel this channel discussion comment belongs to. Note that this will match channel_id for such comments. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | String |
| lowQualityScores | Comment low quality scores. Keyed by various model names. Rename from the old automod_scores. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | map |
| sentiment | Sentiment. This omits entity_sentiment and keeps only the polarity, magnitude, and score. Sentiment as currently implemented is not debiased and has limited language coverage. Please read go/comments-sentiment-access before using. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | YoutubeCommentsSentimentSentiment |
| textLength | Text length of the comment in UTF-16 code points. The encoding could change in the future. | YoutubeCommentsClusteringMiniStanza | Intended to be simpler to work with than the ExportedStanza it’s derived from See documentation: https://g3doc.corp.google.com/company/teams/youtube/community_intelligence/eng_resources/data_sources.md#ministanza Next available: 84 | integer |
| textEmbedding | Comment text embedding. | YoutubeCommentsRankingYouTubeCommentTextEmbedding | Comment text embedding. | list(number) |
| flagPredictionScore | Score produced by the user flag prediction model. | YoutubeCommentsRankingYouTubeCommentTextQualityAnnotation | Text quality scores for a single comment. | number |
| flagPredictionVersion | Version identifier of the flag prediction model. | YoutubeCommentsRankingYouTubeCommentTextQualityAnnotation | Text quality scores for a single comment. | String |
| entitySentiment | YoutubeCommentsSentimentSentiment | Sentiment information extracted from the annotated content by Goldmine. This mirrors nlp_sentiment.SentimentAnnotation. Next tag: 5. | list(YoutubeCommentsSentimentSentimentEntitySentimentAnnotation) | |
| magnitude | Total magnitude of the sentiment. A positive number representing the total intensity of sentiment regardless of positive vs negative polarity. | YoutubeCommentsSentimentSentiment | Sentiment information extracted from the annotated content by Goldmine. This mirrors nlp_sentiment.SentimentAnnotation. Next tag: 5. | number |
| polarity | Polarity of the sentiment. Value is between -1.0 and 1.0 inclusive, with larger numbers representing more positive sentiment and negative numbers representing negative sentiment. | YoutubeCommentsSentimentSentiment | Sentiment information extracted from the annotated content by Goldmine. This mirrors nlp_sentiment.SentimentAnnotation. Next tag: 5. | number |
| score | The average score over sentences. This combines the polarity and magnitude signals into one value. Bounded between -1.0 and 1.0. | YoutubeCommentsSentimentSentiment | Sentiment information extracted from the annotated content by Goldmine. This mirrors nlp_sentiment.SentimentAnnotation. Next tag: 5. | number |
| entityName | The representative entity name. This can be blank for cases when there is no explicit name like “I” or “it”. The mentions’ tokens can be used to get more details about each entity. | YoutubeCommentsSentimentSentimentEntitySentimentAnnotation | An entity level sentiment annotation containing the sentiment values aggregated over all mentions of an entity. Next tag: 7. | String |
| magnitude | Total magnitude of the sentiment. | YoutubeCommentsSentimentSentimentEntitySentimentAnnotation | An entity level sentiment annotation containing the sentiment values aggregated over all mentions of an entity. Next tag: 7. | number |
| mentionSentiment | YoutubeCommentsSentimentSentimentEntitySentimentAnnotation | An entity level sentiment annotation containing the sentiment values aggregated over all mentions of an entity. Next tag: 7. | list(YoutubeCommentsSentimentSentimentEntitySentimentAnnotationMentionSentimentAnnotation) | |
| mid | MID for this entity, if available. | YoutubeCommentsSentimentSentimentEntitySentimentAnnotation | An entity level sentiment annotation containing the sentiment values aggregated over all mentions of an entity. Next tag: 7. | String |
| polarity | Polarity of the sentiment. See above for detail. | YoutubeCommentsSentimentSentimentEntitySentimentAnnotation | An entity level sentiment annotation containing the sentiment values aggregated over all mentions of an entity. Next tag: 7. | number |
| score | The per entity score between -1.0 and 1.0. Combines the signal from polarity and magnitude values. | YoutubeCommentsSentimentSentimentEntitySentimentAnnotation | An entity level sentiment annotation containing the sentiment values aggregated over all mentions of an entity. Next tag: 7. | number |
| endToken | Token end index in corresponding SAFT document (inclusive). | YoutubeCommentsSentimentSentimentEntitySentimentAnnotationMentionSentimentAnnotation | A mention level sentiment annotation containing the sentiment values for a single entity mention. // Next tag: 6. | String |
| magnitude | Total magnitude of the sentiment. | YoutubeCommentsSentimentSentimentEntitySentimentAnnotationMentionSentimentAnnotation | A mention level sentiment annotation containing the sentiment values for a single entity mention. // Next tag: 6. | number |
| polarity | Polarity of the sentiment. See above for detail. | YoutubeCommentsSentimentSentimentEntitySentimentAnnotationMentionSentimentAnnotation | A mention level sentiment annotation containing the sentiment values for a single entity mention. // Next tag: 6. | number |
| score | The per mention score between -1.0 and 1.0. Combines the signal from polarity and magnitude values. | YoutubeCommentsSentimentSentimentEntitySentimentAnnotationMentionSentimentAnnotation | A mention level sentiment annotation containing the sentiment values for a single entity mention. // Next tag: 6. | number |
| startToken | Token start index in corresponding SAFT document. | YoutubeCommentsSentimentSentimentEntitySentimentAnnotationMentionSentimentAnnotation | A mention level sentiment annotation containing the sentiment values for a single entity mention. // Next tag: 6. | String |
| entity | The entity annotating the document. | YoutubeDiscoveryLegosLegosAnnotation | The annotation of a document by a given entity, for a given type of relationship. | YoutubeDiscoveryLegosLegosEntity |
| format | The annotation is a format annotation, i.e. it tells the format of the video. | YoutubeDiscoveryLegosLegosAnnotation | The annotation of a document by a given entity, for a given type of relationship. | YoutubeDiscoveryLegosLegosFormatRelationship |
| present | The annotation is present in the video. Semantic Legos and Presence Legos naturally overlap and can contain the same entities. However, we do not enforce a strict subset relation. | YoutubeDiscoveryLegosLegosAnnotation | The annotation of a document by a given entity, for a given type of relationship. | YoutubeDiscoveryLegosLegosPresentRelationship |
| semantic | The annotation is a semantic annotation, i.e. it tells what the document is about and what the reasons to watch the video are. The annotation should be valid for the complete annotated document, not simply a part of the document such as a video segment. | YoutubeDiscoveryLegosLegosAnnotation | The annotation of a document by a given entity, for a given type of relationship. | YoutubeDiscoveryLegosLegosSemanticRelationship |
| taxonomic | The annotation is a taxonomic annotation, i.e. it tells to which class of the Legos taxonomy the document belongs to. | YoutubeDiscoveryLegosLegosAnnotation | The annotation of a document by a given entity, for a given type of relationship. | YoutubeDiscoveryLegosLegosTaxonomicRelationship |
| annotations | The annotations for this document. For a given (entity, relationship type) pair, there will be at most one annotation. The list has no particular order. | YoutubeDiscoveryLegosLegosAnnotations | A collection of annotations returned by Legos for a document. | list(YoutubeDiscoveryLegosLegosAnnotation) |
| debugName | DO NOT USE THIS FIELD. The entity name here can be random garbage and when it’s actually a name it will be in a random language (most of the time English but not always). This field is going away soon. For a replacement you should probably use the following RPC: cs/symbol:Ytpedia.GetNames please read go/ytks-calling details on how to call it and don’t hesitate to write to us for help with this (or in any case before starting to send real traffic to us) at: g/yt-knowledge-service | YoutubeDiscoveryLegosLegosEntity | The identification of a Knowledge Graph (KG) entity in Legos. | String |
| kgId | The ID of the Knowledge Graph entity. Note: this is the primary ID at generation time. See https://sites.google.com/a/google.com/knowledge-graph/data/primary_ids | YoutubeDiscoveryLegosLegosEntity | The identification of a Knowledge Graph (KG) entity in Legos. | String |
| confidence | Format classification confidence score, in the 0-1 range. A score of XX% means that we expect at least XX% of the documents annotated with this format to be correctly annotated; i.e. thresholding at XX% yields a precision of at least XX%. | YoutubeDiscoveryLegosLegosFormatRelationship | Description of a format Legos annotation. http://go/legos/formats.md | number |
| confidence | Confidence score. Thresholding at the confidence score at 0.XX yields annotations of precision of at least XX%. | YoutubeDiscoveryLegosLegosPresentRelationship | Description of a present Legos annotation. | number |
| contexts | Extra context about how the entity relates to the document. Typically vertical-specific. Please refrain from populating this field as we’re working on migrating most of the use cases to the LegosEntity proto so clients don’t have to scan all relationships to know which annotations they may be interested in. | YoutubeDiscoveryLegosLegosPresentRelationship | Description of a present Legos annotation. | list(YoutubeDiscoveryLegosLegosSemanticRelationshipContext) |
| confidence | Confidence score. Thresholding at the confidence score at 0.XX yields annotations of precision of at least XX%. Only filled in the intent definition Legos. Please use IsSemanticAnnotationAtConfidenceThreshold() from video/youtube/discovery/legos/annotations/public/legos_annotations_util.h to obtain only intent definition Legos. For more information on the migration please look at go/legos-intent-migration. | YoutubeDiscoveryLegosLegosSemanticRelationship | Description of a semantic Legos annotation. http://go/legos/project.md#semantic-intent-annotations | number |
| contexts | YoutubeDiscoveryLegosLegosSemanticRelationship | Description of a semantic Legos annotation. http://go/legos/project.md#semantic-intent-annotations | list(YoutubeDiscoveryLegosLegosSemanticRelationshipContext) | |
| topicalityScore | DEPRECATED. Please use confidence instead. Will be set to the same value as confidence in early January 2019. See go/legos-intent-migration for more information. | YoutubeDiscoveryLegosLegosSemanticRelationship | Description of a semantic Legos annotation. http://go/legos/project.md#semantic-intent-annotations | float |
| subject | The subject of the semantic relationship. This is set when the relationship is derived from some other entity. The exact meaning of this field depends on the ContextType. | YoutubeDiscoveryLegosLegosSemanticRelationshipContext | Extra context about how the entity relates to the document. Typically vertical-specific. | YoutubeDiscoveryLegosLegosEntity |
| type | The type of semantic relationship between the document and the entity. This allows one to retrieve vertical-specific fine-grained information about the document. | YoutubeDiscoveryLegosLegosSemanticRelationshipContext | Extra context about how the entity relates to the document. Typically vertical-specific. | String |
| isRedundant | Set to true if the taxonomy annotation is redundant amongst the set of other taxonomy annotations for the same document, i.e. if there is at least one other taxonomy annotation that is a child node of this one. | YoutubeDiscoveryLegosLegosTaxonomicRelationship | Description of a taxonomic Legos annotation. http://go/legos/project.md#taxonomy-annotations | boolean |
| score | A score, in the 0-1 range, used to rank taxonomy annotations. | YoutubeDiscoveryLegosLegosTaxonomicRelationship | Description of a taxonomic Legos annotation. http://go/legos/project.md#taxonomy-annotations | float |