OsRatedGeneratedArtworkDescription

A partner rates a generated description as helpful or not, via the thumbs feedback shown below the text in the Writing Assistant drawer. Fires once the follow-up detail modal resolves (Send, Skip, or close) — detail is the optional free text the partner added, or an empty string if they skipped or closed without typing anything.

This schema describes events sent to Segment from OsRatedGeneratedArtworkDescription

example

{
  action: "ratedGeneratedArtworkDescription",
  context_module: "writingAssistantDrawer",
  context_page_owner_type: "inventory",
  artwork_id: "abc123",
  value: "up",
  detail: "",
  regenerate_count: 2,
  was_edited: false,
  document_count: 1,
  generated_description: "A vibrant abstract composition...",
  writing_language: "English",
  writing_sample: "A spare, observational tone."
}

example

With optional detail text

{
  action: "ratedGeneratedArtworkDescription",
  context_module: "writingAssistantDrawer",
  context_page_owner_type: "inventory",
  artwork_id: "abc123",
  value: "down",
  detail: "Too generic, didn't mention the material",
  regenerate_count: 0,
  was_edited: false,
  document_count: 0,
  generated_description: "A vibrant abstract composition...",
  writing_language: "",
  writing_sample: ""
}

Hierarchy

OsRatedGeneratedArtworkDescription

Index

Properties

action

action: ratedGeneratedArtworkDescription

artwork_id

artwork_id: string

context_module

context_module: writingAssistantDrawer

context_page_owner_type

context_page_owner_type: OsOwnerType

detail

detail: string

Optional free text the partner added in the follow-up modal; empty string if skipped or closed without typing

document_count

document_count: number

Number of supporting documents attached at the time of rating

generated_description

generated_description: string

The raw AI-generated text being rated

regenerate_count

regenerate_count: number

Number of times the partner clicked Regenerate (excludes automatic regenerations triggered by adding/removing a document)

value

value: "up" | "down"

was_edited

was_edited: boolean

Whether the rated text differs from the last generated text

writing_language

writing_language: string

The partner's My Brand writing language preference; empty string if unset

writing_sample

writing_sample: string

The partner's My Brand writing sample; empty string if unset