@egain/ai-agent-sdk API Reference - v0.2.3-beta.2 / MessageData

Interface: MessageData

Message data structure

Indexable

▪ [key: string]: any

Table of contents

Properties

• error_code
• contextValidationErrors
• chat_history
• options
• escalation
• escalationData
• sources
• reasoning
• context
• feedback
• escalationEvent
• token
• workflowType
• workflowNodeType
• inputType

Properties

error_code

• Optional error_code: string

Defined in

core/message/types.ts:56

---

contextValidationErrors

• Optional contextValidationErrors: ContextValidationIssue[]

Defined in

core/message/types.ts:57

---

chat_history

• Optional chat_history: any[]

Defined in

core/message/types.ts:58

---

options

• Optional options: string[]

Defined in

core/message/types.ts:59

---

escalation

• Optional escalation: boolean

Defined in

core/message/types.ts:60

---

escalationData

• Optional escalationData: Object

Type declaration

Name	Type
live?	boolean
liveDomain?	string
entrypointUrl?	string
phone?	boolean
phoneNumber?	string
sms?	boolean
smsNumber?	string
email?	boolean

Defined in

core/message/types.ts:61

---

sources

• Optional sources: any[]

Defined in

core/message/types.ts:71

---

reasoning

• Optional reasoning: string

Defined in

core/message/types.ts:72

---

context

• Optional context: object

Defined in

core/message/types.ts:73

---

feedback

• Optional feedback: Object

Type declaration

Name	Type
rating	any
answerMessageId	string

Defined in

core/message/types.ts:74

---

escalationEvent

• Optional escalationEvent: any

Defined in

core/message/types.ts:78

---

token

• Optional token: string

Defined in

core/message/types.ts:79

---

workflowType

• Optional workflowType: null | "preChatWorkflow" | "escalationWorkflow" | "agentWorkflow"

Defined in

core/message/types.ts:80

---

workflowNodeType

• Optional workflowNodeType: null | string

Defined in

core/message/types.ts:81

---

inputType

• Optional inputType: null | string

Defined in

core/message/types.ts:82