Skip to content
v9.1.1
Français

ConversationRecord

import type { ConversationRecord } from "@elie-laloum/outpost";

Parameters and properties

Section titled “Parameters and properties”
  • idRequired
    string
    Native conversation identifier used to locate or continue the session.
  • fileRequired
    string
    Host path of the captured transcript or session bundle.
  • referenceOptional
    TransportReference | undefined
    Transport key and revision of the conversation index, set by createTransportConversations(). file still points to a readable local copy.
  • formatRequired
    string
    Format of the store that produced the record. Transcript and session bundle stores reject restoring a record of another format with code configuration.

Signature

Section titled “Signature”
export interface ConversationRecord {
  readonly id: string;
  readonly file: string;
  readonly reference?: TransportReference;
  readonly format: string;
}
Section titled “Related contracts”