Options
All
  • Public
  • Public/Protected
  • All
Menu

A partner closes the Writing Assistant drawer without adding the generated description, via the Cancel button, the X, the backdrop, or Escape.

This schema describes events sent to Segment from OsClosedWritingAssistant

example
{
  action: "closedWritingAssistant",
  context_module: "writingAssistantDrawer",
  context_page_owner_type: "inventory",
  artwork_id: "abc123",
  value: "cancel",
  regenerate_count: 2,
  was_edited: true,
  document_count: 1,
  generated_description: "A vibrant abstract composition..."
}

Hierarchy

  • OsClosedWritingAssistant

Index

Properties

action

action: closedWritingAssistant

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 when the drawer was closed

generated_description

generated_description: string

The raw AI-generated text that was discarded

regenerate_count

regenerate_count: number

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

value

value: "cancel" | "close"

"cancel" = Cancel button, "close" = X, backdrop, or Escape

was_edited

was_edited: boolean

Whether the discarded text differs from the last generated text

Generated using TypeDoc