Support
FAQs
Answers to the questions developers ask most when they start with Docklee.
Getting started
Python 3.9 and later, and TypeScript on Node.js 18 and later. The TypeScript SDK also works from plain JavaScript. Both install as docklee, from PyPI and npm. Any other language can call the REST API directly with an API key.
Yes. A key can reach Knowledge Engines, DUM, or both, and you choose its capability: read, write, or both. See API keys.
No. An API key must stay on your server. Call Docklee from your backend and send the results to your client.
Use lynk.query when you want Docklee to write the answer, with citations. Use lynk.retrieve when you run your own model and only need the ranked chunks to put in its prompt.
Writing data
No. A write declares a container, vector or okf, never an engine. You then link the container's API/SDK Feed source to the engines that should read it. See Containers.
Check that the container's API/SDK Feed source is linked to the engine in its Sources tab. An engine reads only the sources linked to it. Also check that Dock was flushed or closed, so the buffered events were sent.
Dock buffers captures and sends a batch when the buffer reaches 10 events, or when you call flush. In TypeScript it also sends every 5 seconds. Call flush_sync() or await dock.close() in Python, or await dock.close() in TypeScript, before your process exits.
With flush_sync() in Python and flush() in TypeScript, the events go back into the buffer and are sent with the next flush. Both return the batch result when the request succeeds and None or null when it fails, so you can check it in code.
Identical content sent again within 60 seconds is skipped. Pass a dedup_key (Python) or dedupKey (TypeScript) to decide yourself what counts as the same event.
Reading data
The most common cause is a multi-user space recalled without an end_user. Once a space holds any end user memory, a recall must name the end user. Also check the memory space ID and that your key's scope includes the space. See End users.
lynk.recall reads one memory space per call. To search several at once, call POST /v1/dum/federated-search with up to 10 memory_space_ids. Spaces your key can't reach are skipped, and the results are merged and ranked together.
Yes. It retries timeouts, connection errors, and the statuses 408, 409, 429, 500, 502, 503, and 504, up to 3 times by default, waiting longer before each retry. Set max_retries (Python) or maxRetries (TypeScript) to change the limit. Requests time out after 30 seconds unless you set timeout.