Skip to Content

Getting Started

Overview

Give your AI app knowledge it can answer from and memory that lasts between sessions, through one API.

Docklee sits between your application and your model. It holds two things your app would otherwise build itself: knowledge it can answer from, and memory about the people it serves.

Use Docklee when your assistant needs to cite your own content, remember a user from one session to the next, or both.

  1. 01Your appCaptures documents, events, and conversations.
  2. 02DockSends them to a container or a memory space.
  3. 03DockleeProcesses, links, and keeps the data current.
  4. 04LynkReturns answers, context, or memories to your model.
Your app writes with Dock, Docklee stores and organizes the data, and your app reads it back with Lynk.

Two runtimes

RuntimeHoldsRead with
Knowledge EnginesDocuments, pages, and app data, stored in vector and OKF containerslynk.query and lynk.retrieve
Docklee Universal MemoryFacts, preferences, events, and history, stored in memory spaceslynk.recall

The runtimes are separate. Knowledge never mixes into a memory space, and memory never appears in an engine's answers. One API key can reach either runtime or both.

One package, two classes

The docklee package has a class for each direction of data.

ClassWhat it doesMethods
DockWrites into a container or a memory spacecapture, flush, instrument, watch, listen, close
LynkReads from an engine or a memory spacequery, retrieve, recall, close

Both classes read DOCKLEE_API_KEY from the environment:

from docklee import Dock, Lynk

dock = Dock()
lynk = Lynk()

Three ways to read

MethodReturnsBest for
lynk.queryA finished answer with a confidence score and citations, in one response or as a streamAssistants that answer from your content
lynk.retrieveThe ranked chunks behind an answerApps that run their own model
lynk.recallMemory records, each with a type and a confidence scorePersonalizing replies for a user

Where you set things up

The Docklee dashboard holds the resources the SDK uses.

SectionWhat you do there
SourcesConnect documents, apps, and data once, for every engine
Knowledge EnginesCreate engines and link sources to them
DUMCreate memory spaces, then inspect, review, and correct what they hold
API KeysCreate keys and limit what each one can reach
UsageSee how much each runtime is used

Next steps

Now you know the parts. The Quickstart puts them together in a few minutes.

On this page