Databricks SDK for JavaScript
    Preparing search index...

    Interface Session

    A durable logical interaction stored within a Session Store.

    interface Session {
        actorId?: string;
        createTime?: Instant;
        lastActivityTime?: Instant;
        metadata?: Record<string, string>;
        name?: string;
        parentSessionId?: string;
        rootSessionId?: string;
        sessionId?: string;
        updateTime?: Instant;
    }
    Index

    Properties

    actorId? createTime? lastActivityTime? metadata? name? parentSessionId? rootSessionId? sessionId? updateTime?

    Properties

    actorId?: string

    Opaque caller-provided identifier for the application actor associated with the session.

    This is application data and has no authentication or authorization semantics. Use the same value as the Managed Memory Entry actor_id when storing memories associated with this actor. Every session must set it. A child session must use the same value as its parent.

    createTime?: Instant

    Time when the session was created.

    lastActivityTime?: Instant

    Time when the session's item history was last mutated.

    metadata?: Record<string, string>

    Mutable caller-defined string labels.

    name?: string

    Resource name in the form session-stores/{session_store_id}/sessions/{session_id}.

    parentSessionId?: string

    Immediate parent session ID. Set only at creation for child sessions, immutable thereafter, and restricted to the same store.

    rootSessionId?: string

    Top-level session ID in the spawn tree. This equals session_id for a root or fork and is inherited transitively by child sessions.

    sessionId?: string

    Unique session ID. The service generates a UUID unless the caller supplies CreateSessionRequest.session_id.

    updateTime?: Instant

    Time when session resource fields last changed.

    Settings

    Member Visibility

    On This Page

    Properties