Search the docs

Your first retrieval

Add a document, connect an agent, and check the exact cited passages and support score it gets back.

Add a source you can check

Start with one short document whose contents you know. You will need access to your Takibi workspace and an agent or terminal that can run Node.js 20 or newer.

  1. Open Documents and choose New collection. Give it a name that describes the client or work.
  2. Create a folder with New folder, then choose Upload files.
  3. Select your file, check its destination, and choose Upload. Wait for Indexed.
  4. Open the document and check that its converted text includes the information you want to ask about.

If the file is held or fails, use Held or failed files before continuing. Agents cannot retrieve held content.

Create a Profile for the agent

A Profile defines what an agent may read and do. A key lets a tool use that Profile. All keys in one Profile share its access.

  1. Open Profiles → New profile; in a workspace with companions, open the Agents & tools tab and choose New agent or tool. Name it after its job, such as Support.
  2. Review its daily token budget and ask limit. Leave Create tasks, Orchestrator, and the notes toggles off for a tool that only needs to retrieve knowledge and work on its own tasks.
  3. In the scope step, select the folder you just created.
  4. Finish creating the Profile and copy the key from its paste card. The secret is shown once.

Store the key locally, outside source control. See Access & keys before granting a whole collection.

Connect and ask

Follow Connect an agent to install the CLI and save the key. Then ask a specific question that the document answers:

takibi ask -q "What is our refund policy?" --json

If the Profile can access multiple collections, pass --project <project-uuid>. Use a question relevant to your source; the refund question is only an example.

Check the result against the document

A successful retrieval returns exact source passages, plus citations identifying their documents and chunks. In the JSON these passages are called spans. Open the cited document and compare the passage with the original context.

Retrieval returns only exact passages with their citations, and nothing when no evidence matches; it does not write an answer, so your agent uses those passages to respond. Companions and Emi do write: drafts, plans and proposed tasks built from those passages, and companions can also use connected apps and web search. Their work comes back for your review. If the response says it abstained (abstained: true), no passages were returned; check the document's status, the Profile's access, and the wording of the question.

Read how to interpret evidence for support scores, partial evidence and conflict signals.

Choose your next step

Once you have checked your first retrieval, pick one of these next steps: