Options
All
  • Public
  • Public/Protected
  • All
Menu

A partner clicks "Add Description" in the Writing Assistant drawer, applying the generated (and possibly edited) description to the description cell.

This schema describes events sent to Segment from OsAddedGeneratedArtworkDescription

example
{
  action: "addedGeneratedArtworkDescription",
  context_module: "writingAssistantDrawer",
  context_page_owner_type: "inventory",
  artwork_id: "abc123",
  regenerate_count: 2,
  was_edited: true,
  document_count: 1,
  generated_description: "A vibrant abstract composition...",
  writing_language: "English",
  writing_sample: "A spare, observational tone."
}

Hierarchy

  • OsAddedGeneratedArtworkDescription

Index

Properties

action

action: addedGeneratedArtworkDescription

artwork_id

artwork_id: string

context_module

context_module: writingAssistantDrawer

context_page_owner_type

context_page_owner_type: OsOwnerType

document_count

document_count: number

Number of supporting documents attached at the time of adding the description

generated_description

generated_description: string

The raw AI-generated text, before any edits the partner made

regenerate_count

regenerate_count: number

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

was_edited

was_edited: boolean

Whether the final 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

Generated using TypeDoc