Skip to content

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

Interface: TranscriptOptions

Options for filtering transcript entries when retrieving.

Example

typescript
// Get received messages from the last hour
const options: TranscriptOptions = {
  direction: 'received',
  fromTimestamp: Date.now() - 3600000
};
const entries = transcript.getEntries(options);

Table of contents

Properties

Properties

fromTimestamp

Optional fromTimestamp: number

Filter entries from this timestamp onwards (inclusive)

Defined in

core/message/Transcript.ts:196


toTimestamp

Optional toTimestamp: number

Filter entries up to this timestamp (inclusive)

Defined in

core/message/Transcript.ts:201


direction

Optional direction: "sent" | "received" | "both"

Filter by direction: 'sent', 'received', or 'both'

Defined in

core/message/Transcript.ts:206


persona

Optional persona: Persona

Filter by message persona (e.g., 'agent', 'customer')

Defined in

core/message/Transcript.ts:211


role

Optional role: Role

Filter by message role (e.g., 'human', 'context')

Defined in

core/message/Transcript.ts:216

Released under the MIT License.