Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CopilotMessageData

model interface for agent assist payload data

Hierarchy

  • CopilotMessageData

Index

Properties

acpAppElements: CopilotElement[]

array of CopilotElement

agentAssistSource: string

The content type of element

checklistData: CopilotChecklistData

field for storing checklist data

comprehensiveFeedback: OverallContactFeedbackData

field for storing comprehensive feedback card data

contactHistory: ContactHistoryData[]

field for storing contact history data

contactId: string

The ID of the contact.

copilotTaskAssistCardData: CopilotTaskAssistCardData

field for storing task assist form data

currentTaskAssistRequestStatus: string

field for storing task assist request status

decisionTreeData: DecisionTreeData

field for storing decision tree data

decisionTreeObjectId?: string

The objectId from the WebSocket element that opened the decision tree. Used to route subsequent messages to the correct container when a workflow and a decision tree are both active simultaneously.

emailCards?: CopilotElement[]

array of email adaptive cards

filterDetails?: CopilotFilterDetails

field for storing filter Details

generateComprehensiveCard: boolean

flag for generating comprehensive card

insertedNBRId: string

The ID of the inserted NBR

isAutoSummaryExpanded?: boolean

flag for checking if auto summary is expanded

isChecklistOpen?: boolean

flag for checking if checklist is open

isComprehensiveFeedbackSent: boolean

flag for checking if comprehensive feedback is sent

isDecisionTreeOpen?: boolean

flag for checking if decision tree is open

isEditorActionPerformed: boolean

flag for checking if editor action is performed

isFinalSummaryAPICalled: boolean

Flag for checking if finalSummary fire-forget API is called already

isFinalSummaryGenerated: boolean

flag for checking if final summary is generated

isFinalSummaryRegenerating: boolean

flag for checking if final summary is regenerating

isJourneySummaryExpanded: boolean

flag for checking if journey summary is expanded

isNBRAvailable: boolean

flag for checking if nbr is available

isNBROpen: boolean

flag for checking if nbr is open

isResponseInserted: boolean

flag for checking if response is inserted in editor

responseSent: string

sent response

updateComprehensiveCard: boolean

flag for checking if comprehensive cards needs to re-render

utcTimestamp: Date

timestamp

workflowSpace?: WorkflowSpaceState

Field for persisting the Copilot workflow-space slice for this contact (alongside copilotTaskAssistCardData) so triggered workflows + their state survive a page reload. Stored within the contactId under the existing Copilot IndexedDB key and rehydrated on app load.

Generated using TypeDoc