@egain/ai-agent-sdk API Reference - v0.1.1 / TranscriptConfig

Interface: TranscriptConfig

Configuration for transcript storage and filtering.

Use this to control which messages are recorded in the transcript.

Example

const config: TranscriptConfig = {
  enabled: true,
  excludeRoles: ['heartbeat', 'token'],
  excludePersonas: ['system']
};

Table of contents

Properties

• enabled
• includeMessageTypes
• excludeRoles
• excludePersonas

Properties

enabled

• Optional enabled: boolean

Enable or disable transcript storage. When disabled, no messages are recorded.

Default

true

Defined in

core/message/Transcript.ts:148

---

includeMessageTypes

• Optional includeMessageTypes: string[]

Array of message types to include. If specified, only these message types are recorded. If not specified, all message types are included (subject to exclude filters).

Example

['agent_message', 'customer_message']

Defined in

core/message/Transcript.ts:157

---

excludeRoles

• Optional excludeRoles: string[]

Array of roles to exclude from the transcript. Messages with these roles will not be recorded.

Example

['heartbeat', 'token']

Defined in

core/message/Transcript.ts:165

---

excludePersonas

• Optional excludePersonas: string[]

Array of personas to exclude from the transcript. Messages from these personas will not be recorded.

Example

['system']

Defined in

core/message/Transcript.ts:173