OpenAICompatRuntime

Methods

abortSession()

abortSession(sessionId, reason?): void;

Parameters

Parameter	Type
`sessionId`	`string`
`reason?`	`string`

Returns

void

compressNow()?

optional compressNow(sessionId, opts?): Promise<Record<string, unknown>>;

Parameters

Parameter	Type
`sessionId`	`string`
`opts?`	{ `focusTopic?`: `string`; `force?`: `boolean`; }
`opts.focusTopic?`	`string`
`opts.force?`	`boolean`

Returns

Promise<Record<string, unknown>>

deleteSession()

deleteSession(sessionId): Promise<void>;

Parameters

Parameter	Type
`sessionId`	`string`

Returns

Promise<void>

getConversationLength()?

optional getConversationLength(sessionId): Promise<number>;

Parameters

Parameter	Type
`sessionId`	`string`

Returns

Promise<number>

getSession()

getSession(sessionId): Promise<Session | null>;

Parameters

Parameter	Type
`sessionId`	`string`

Returns

Promise<Session | null>

getSessionStore()

getSessionStore(): SessionStore;

Returns

SessionStore

markOutcome()

markOutcome(
   sessionId,
   outcome,
opts?): Promise<void>;

Parameters

Parameter	Type
`sessionId`	`string`
`outcome`	`ConversationOutcome`
`opts?`	{ `markedBy?`: `ConversationOutcomeMarkedBy`; `reason?`: `string`; }
`opts.markedBy?`	`ConversationOutcomeMarkedBy`
`opts.reason?`	`string`

Returns

Promise<void>

replayAuditLog()

replayAuditLog(sessionId, opts?): Promise<ConversationAuditEntry[]>;

Parameters

Parameter	Type
`sessionId`	`string`
`opts?`	`AuditListOptions`

Returns

Promise<ConversationAuditEntry[]>

run()

run(opts): TurnHandle;

Parameters

Parameter	Type
`opts`	`RunOptions`

Returns

TurnHandle

stream()

stream(opts): TurnHandle;

Parameters

Parameter	Type
`opts`	`RunOptions`

Returns

TurnHandle