Interface LongTermMemoryRetrievalInput

interface LongTermMemoryRetrievalInput {
    userId: string;
    organizationId?: string;
    conversationId: string;
    personaId: string;
    mode: string;
    queryText: string;
    memoryPolicy: ResolvedLongTermMemoryPolicy;
    retrievalPolicy?: MemoryRetrievalPolicy;
    maxContextChars?: number;
    topKByScope?: Partial<Record<"user" | "persona" | "organization", number>>;
    turnScopes?: TurnScopes;
}

Properties

userId organizationId? conversationId personaId mode queryText memoryPolicy retrievalPolicy? maxContextChars? topKByScope? turnScopes?

Properties

userId

userId: string

Optional organizationId

organizationId?: string

conversationId

conversationId: string

personaId

personaId: string

mode

mode: string

queryText

queryText: string

memoryPolicy

memoryPolicy: ResolvedLongTermMemoryPolicy

Optional retrievalPolicy

retrievalPolicy?: MemoryRetrievalPolicy

Optional maxContextChars

maxContextChars?: number

Advisory character budget for the returned context string. Implementations may truncate to stay within this budget.

Optional topKByScope

topKByScope?: Partial<Record<"user" | "persona" | "organization", number>>

Optional per-scope retrieval caps. Implementations are free to ignore/override.

Optional turnScopes

turnScopes?: TurnScopes

With a learning layer: the turn's scope ids, from the GMI's learner session. A retriever reads the user, persona and conversation scopes under them (a learner's, or the session's own form on a turn with no learner); without them it reads under the plain ids, as with no layer.

Settings

Member Visibility

Theme

On This Page

userIdorganizationIdconversationIdpersonaIdmodequeryTextmemoryPolicyretrievalPolicymaxContextCharstopKByScopeturnScopes