View Source GoogleApi.ContentWarehouse.V1.Model.YoutubeCommentsClusteringMiniStanza (google_api_content_warehouse v0.4.0)

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

Attributes

  • isDeleted (type: boolean(), default: nil) - 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.
  • numRepliers (type: integer(), default: nil) - Number of different repliers the comment has.
  • ytReplyToItemId (type: String.t, default: nil) - For replies to replies, this contains the parent reply's id. The parent_id field is actually the root stanza_id (not guaranteed AFAIK).
  • detailedLanguageCode (type: String.t, default: nil) - 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
  • textEmbedding (type: %{optional(String.t) => GoogleApi.ContentWarehouse.V1.Model.YoutubeCommentsRankingYouTubeCommentTextEmbedding.t}, default: nil) - Comment text embedding.
  • contentUpdateTimestamp (type: DateTime.t, default: nil) - 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().
  • ytCommentQualityScore3 (type: float(), default: nil) -
  • channelId (type: String.t, default: nil) - 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.
  • textQualityScores2 (type: GoogleApi.ContentWarehouse.V1.Model.YoutubeCommentsRankingYouTubeCommentTextQualityAnnotation.t, default: nil) - Predicted probability of the comment being flagged based on the text. For testing the new annotation process only.
  • isPinned (type: boolean(), default: nil) - Whether the comment is pinned. This is derived from YTMS and may be out of sync with other fields (a day early or behind).
  • creationTimeInSeconds (type: String.t, default: nil) - The time when the comment is created.
  • ytCommentQualityScore (type: float(), default: nil) - Existing quality corpus scores.
  • textQualityScores (type: GoogleApi.ContentWarehouse.V1.Model.YoutubeCommentsRankingYouTubeCommentTextQualityAnnotation.t, default: nil) - Predicted probability of the comment being flagged based on the text.
  • superThanksInfo (type: GoogleApi.ContentWarehouse.V1.Model.YoutubeBackstageSuperVodCommentInfo.t, default: nil) - Super Thanks related info if a comment is posted through a Super Thanks purchase.
  • wordEntropy (type: float(), default: nil) - Word entropy of the comment.
  • endUserDeleted (type: boolean(), default: nil) - Whether a comment is deleted by the end user.
  • commentClassificationBuckets (type: list(String.t), default: nil) - List of pre-defined classification score buckets to which the comment belongs. E.g. satisfaction_v1_percentile_80.
  • parentId (type: String.t, default: nil) - 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).
  • mustDeleteComments (type: boolean(), default: nil) - Whether a comment's author channel is deleted. Populated from http://shortn/_YttLvbraAI.
  • offlineEngagementScores (type: map(), default: nil) - Offline engagement scores map. Keyed by various model names.
  • empiricalCtrs (type: GoogleApi.ContentWarehouse.V1.Model.VideoYoutubeCommentsRankingCTRMetrics.t, default: nil) - Comments empirical CTRs.
  • postId (type: String.t, default: nil) - The post this comment belongs to.
  • sensitivityScores (type: map(), default: nil) - 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.
  • misinfoScores (type: map(), default: nil) - Misinfo scores map. Keyed by various model names.
  • languageCode (type: String.t, default: nil) - 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.
  • subjectIsVideoOwner (type: boolean(), default: nil) - Whether the comment is authored by the creator.
  • automodScores (type: map(), default: nil) - Automod scores map. Keyed by various model names. Deprecated. Consider using low_quality_scores instead.
  • lowQualityDecisions (type: map(), default: nil) - Low quality decisions. Keyed by decision types corresponding to secondary keys.
  • distillerEngagements (type: GoogleApi.ContentWarehouse.V1.Model.AppsPeopleActivityStreamqualityDistillerEngagements.t, default: nil) - All distiller engagements like reports and downvotes.
  • commentType (type: String.t, default: nil) - Whether the comment is on a video, post, or other product.
  • shortReplyVideoId (type: String.t, default: nil) - Associated Short Reply video ID if the comment represents a Short Reply. See go/yt-comment-sticker-m2.
  • ansibleScores (type: map(), default: nil) - TnS Ansible scores map. Keyed by various model names.
  • commentClassificationRanking (type: map(), default: nil) - Comment classification for ranking mapping all secondary keys to values. E.g. {"joke_v1":0.8, "joke_v2":0.7, "question_v1":0.3}.
  • videoId (type: String.t, default: nil) - The video this comment belongs to.
  • mentionedTimestampCommentSecond (type: integer(), default: nil) - Timed comments for the "mentioned" secondary key.
  • commentModeratedRestrictions (type: list(GoogleApi.ContentWarehouse.V1.Model.YoutubeCommentsApiCommentModeratedRestriction.t), default: nil) - Contains various comment moderated restrictions. Only available in the Atlas version. Extracted from http://shortn/_2LzgPEF5K3
  • channelProfileQualityScores (type: map(), default: nil) - Channel profile quality scores map. Keyed by various model names.
  • ytCommentQualityScore2 (type: float(), default: nil) -
  • subscriptionTimestamp (type: String.t, default: nil) - The timestamp (in seconds) when the author subscribed to the channel.
  • numDislikes (type: integer(), default: nil) - 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).
  • isSubscriber (type: boolean(), default: nil) - If the comment author is publicly subscribed to the channel.
  • stanzaId (type: String.t, default: nil) - Refers to the stanza this data is derived from.
  • impersonationScores (type: map(), default: nil) - Impersonation scores map. Keyed by secondary key (score type).
  • subject (type: GoogleApi.ContentWarehouse.V1.Model.SecurityCredentialsPrincipalProto.t, default: nil) - The author of the comment Prefer using yt_author_channel_id instead of subject when possible.
  • segments (type: GoogleApi.ContentWarehouse.V1.Model.SocialCommonSegments.t, default: nil) - A textual content for the context.
  • eligibleQualifiedTeaserFilters (type: list(String.t), default: nil) - The qualified comment teaser filters that this comment is eligible for. Refer to go/comment-teaser-design for more information.
  • isAuthorSponsor (type: boolean(), default: nil) - If the author is a channel member (sponsor).
  • coverageSamplingEligible (type: boolean(), default: nil) - 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.
  • smartReplies (type: %{optional(String.t) => GoogleApi.ContentWarehouse.V1.Model.VideoYoutubeCommentsClassificationProtoYouTubeCommentSmartReply.t}, default: nil) - Smart replies for this comment. Keyed by model names.
  • hasCreatorReply (type: boolean(), default: nil) - If the comment has a creator reply.
  • stanzaRestrictions (type: list(GoogleApi.ContentWarehouse.V1.Model.SocialStanzaStanzaRestriction.t), default: nil) - Contains various restriction information about a stanza.
  • commentEnforcementStatus (type: GoogleApi.ContentWarehouse.V1.Model.YoutubeCommentsApiCommentEnforcementStatus.t, default: nil) - 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
  • lastReplyTimestampUsec (type: String.t, default: nil) - The time when last reply is created.
  • numReplies (type: integer(), default: nil) - Number of non-abusive replies the comment has.
  • numSubscribersBucket (type: integer(), default: nil) - Bucketed number of subscribers held by comment author.
  • numLikes (type: integer(), default: nil) - 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).
  • charEntropy (type: float(), default: nil) - Char entropy of the comment.
  • hasCreatorHeart (type: boolean(), default: nil) - Indicator for whether there is creator heart on this comment.
  • isPubliclyVisible (type: boolean(), default: nil) - If the post is publicly visible.
  • creationDevice (type: String.t, default: nil) - The creation device. Derived from shares:yt_creation_device
  • commentClassification (type: map(), default: nil) - Comment classification mapping all secondary keys to values. E.g. {"joke_v1":0.8, "joke_v2":0.7, "question_v1":0.3}.
  • content (type: String.t, default: nil) - The text content of the comment.
  • isReply (type: boolean(), default: nil) - Whether the comment is a reply.
  • ytAuthorChannelId (type: String.t, default: nil) - 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.
  • channelDiscussionId (type: String.t, default: nil) - The channel this channel discussion comment belongs to. Note that this will match channel_id for such comments.
  • lowQualityScores (type: map(), default: nil) - Comment low quality scores. Keyed by various model names. Rename from the old automod_scores.
  • sentiment (type: GoogleApi.ContentWarehouse.V1.Model.YoutubeCommentsSentimentSentiment.t, default: nil) - 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.
  • textLength (type: integer(), default: nil) - Text length of the comment in UTF-16 code points. The encoding could change in the future.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.YoutubeCommentsClusteringMiniStanza{
  ansibleScores: map() | nil,
  automodScores: map() | nil,
  channelDiscussionId: String.t() | nil,
  channelId: String.t() | nil,
  channelProfileQualityScores: map() | nil,
  charEntropy: float() | nil,
  commentClassification: map() | nil,
  commentClassificationBuckets: [String.t()] | nil,
  commentClassificationRanking: map() | nil,
  commentEnforcementStatus:
    GoogleApi.ContentWarehouse.V1.Model.YoutubeCommentsApiCommentEnforcementStatus.t()
    | nil,
  commentModeratedRestrictions:
    [
      GoogleApi.ContentWarehouse.V1.Model.YoutubeCommentsApiCommentModeratedRestriction.t()
    ]
    | nil,
  commentType: String.t() | nil,
  content: String.t() | nil,
  contentUpdateTimestamp: DateTime.t() | nil,
  coverageSamplingEligible: boolean() | nil,
  creationDevice: String.t() | nil,
  creationTimeInSeconds: String.t() | nil,
  detailedLanguageCode: String.t() | nil,
  distillerEngagements:
    GoogleApi.ContentWarehouse.V1.Model.AppsPeopleActivityStreamqualityDistillerEngagements.t()
    | nil,
  eligibleQualifiedTeaserFilters: [String.t()] | nil,
  empiricalCtrs:
    GoogleApi.ContentWarehouse.V1.Model.VideoYoutubeCommentsRankingCTRMetrics.t()
    | nil,
  endUserDeleted: boolean() | nil,
  hasCreatorHeart: boolean() | nil,
  hasCreatorReply: boolean() | nil,
  impersonationScores: map() | nil,
  isAuthorSponsor: boolean() | nil,
  isDeleted: boolean() | nil,
  isPinned: boolean() | nil,
  isPubliclyVisible: boolean() | nil,
  isReply: boolean() | nil,
  isSubscriber: boolean() | nil,
  languageCode: String.t() | nil,
  lastReplyTimestampUsec: String.t() | nil,
  lowQualityDecisions: map() | nil,
  lowQualityScores: map() | nil,
  mentionedTimestampCommentSecond: integer() | nil,
  misinfoScores: map() | nil,
  mustDeleteComments: boolean() | nil,
  numDislikes: integer() | nil,
  numLikes: integer() | nil,
  numRepliers: integer() | nil,
  numReplies: integer() | nil,
  numSubscribersBucket: integer() | nil,
  offlineEngagementScores: map() | nil,
  parentId: String.t() | nil,
  postId: String.t() | nil,
  segments: GoogleApi.ContentWarehouse.V1.Model.SocialCommonSegments.t() | nil,
  sensitivityScores: map() | nil,
  sentiment:
    GoogleApi.ContentWarehouse.V1.Model.YoutubeCommentsSentimentSentiment.t()
    | nil,
  shortReplyVideoId: String.t() | nil,
  smartReplies:
    %{
      optional(String.t()) =>
        GoogleApi.ContentWarehouse.V1.Model.VideoYoutubeCommentsClassificationProtoYouTubeCommentSmartReply.t()
    }
    | nil,
  stanzaId: String.t() | nil,
  stanzaRestrictions:
    [GoogleApi.ContentWarehouse.V1.Model.SocialStanzaStanzaRestriction.t()]
    | nil,
  subject:
    GoogleApi.ContentWarehouse.V1.Model.SecurityCredentialsPrincipalProto.t()
    | nil,
  subjectIsVideoOwner: boolean() | nil,
  subscriptionTimestamp: String.t() | nil,
  superThanksInfo:
    GoogleApi.ContentWarehouse.V1.Model.YoutubeBackstageSuperVodCommentInfo.t()
    | nil,
  textEmbedding:
    %{
      optional(String.t()) =>
        GoogleApi.ContentWarehouse.V1.Model.YoutubeCommentsRankingYouTubeCommentTextEmbedding.t()
    }
    | nil,
  textLength: integer() | nil,
  textQualityScores:
    GoogleApi.ContentWarehouse.V1.Model.YoutubeCommentsRankingYouTubeCommentTextQualityAnnotation.t()
    | nil,
  textQualityScores2:
    GoogleApi.ContentWarehouse.V1.Model.YoutubeCommentsRankingYouTubeCommentTextQualityAnnotation.t()
    | nil,
  videoId: String.t() | nil,
  wordEntropy: float() | nil,
  ytAuthorChannelId: String.t() | nil,
  ytCommentQualityScore: float() | nil,
  ytCommentQualityScore2: float() | nil,
  ytCommentQualityScore3: float() | nil,
  ytReplyToItemId: String.t() | nil
}

Functions

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

Unwrap a decoded JSON object into its complex fields.