Skip to content

Knowledge

A knowledge pack is an LLM wiki: compiled pages with an index, kept with the documents and the brief they were made from, at most 10 MB in all. A run searches it through three tools the runner grants over a read-only /knowledge folder, and its receipt names each pack it was given by digest. The registry's side, its routes and how a pack is sealed and scanned, is in Knowledge packs in the registry.

Making a pack

There are two ways to make one. Both use the Knowledge Creator, a package built into the application that compiles documents, a brief, or both into cited pages. It is never a release anyone installs.

A build takes documents, a brief, or both. The brief says what the pack should cover, and for whom, in up to 8 KiB, and is kept in the pack as sources/brief.md. Every place you build says the same thing at the documents step: "Specific documents make the best knowledge. Without them the Creator researches the web and its own knowledge, which can be wrong or out of date." Where a build cannot search, the warning says the Creator writes from the brief and its own knowledge instead.

  • On your computer, with Create knowledge in the desktop app (Local and Cloud) or agentry knowledge create (--file, --brief, or both). The model your runner policy names does the work, it costs no credits, and nothing is scanned: the pack says not scanned until you keep it in Agentry (Running them). Searching the web there takes your own AI Review key and a search key; without them the build runs without the web and says why.
  • In Agentry, with the Create knowledge card on the Knowledge page, on Pro, Business and Enterprise, where the deployment takes builds. The card says what a build holds and what your account has. On Standard, it says creating knowledge in Agentry is part of Pro, Business and Enterprise, and leads to a page recommending the desktop app with your own model provider, or Pro. Give the pack a name, then its documents, a brief, or both. A pack's page has Add documents, and a finished build's page has Continue. The build runs on Agentry's own sandbox host, against the platform's model, and its pack is scanned before it is final. Beside the button the page says what the build holds: "This build holds N credits and settles from what it uses, plus 1 credit to scan the pack when the build changes it, never more than it holds." The hold and the settlement work as for a hosted run (Hosted runs).

Search the web. The Creator can search the web for what your documents and the pack do not hold. Create knowledge offers three answers: Only without documents (the default), Yes, with your documents too, and No. Add documents has one box, Search the web, unticked. AI Review reads every result and page before the Creator does and holds back what it flags or cannot scan. The searches are drawn from your documents and the brief, so they carry some of what the Creator read to the search provider. In Agentry each search costs credits inside the build's hold, and the page states the price beside the choice; a finished build's page says how many times it searched and what AI Review withheld. A page the Creator wrote from the web cites [src: web:<url>], and the page it read is not kept; what it took from its model's own knowledge cites [src: model].

PDF, Word, OpenDocument, EPUB, RTF, PowerPoint, Excel and images are turned into text first, in a step with no network. Markdown, text, HTML, CSV, JSON, YAML and source files are read as they are.

Keeping packs in Agentry

Knowledge, in your dashboard's left nav, opens two cards: Create knowledge and Manage knowledge. Manage knowledge says how many packs you keep, the storage they take and how many your organizations share, and opens the list of the packs you keep in Agentry: each one's pages, files and size, and its scan state. Above them is the storage the packs use against your knowledge allocation. Only packs kept in Agentry count toward it. A pack made on your computer is kept here with Copy to Cloud in the desktop app or agentry knowledge upload.

Each pack is encrypted under a key of its own. On SecureAgentry that key is wrapped to your account's key, which Agentry holds; a pack's page says what holds its key. Agentry itself can open a pack: it opens each one to check and scan it when it arrives, again for you when you export it, and for a run or a build that uses it. Its routes hand the key to your account alone. Another account, a fellow member of your organization and platform staff all get a not-found answer for your packs; staff can see names and sizes for support, never content.

Every pack is scanned when it arrives. The rule stages read every text file, and AI Review reads your documents and then the finished wiki, in chunks. A pack's page lists what each reader read, what it could not, and every finding by the file and line or the chunk it is in. It shows no excerpt, because the report is kept in the clear beside the encrypted pack. The report is a record: a finding blocks nothing, a pack with findings is still yours to attach, and a scan with no findings does not make the pages accurate or harmless. While a pack is being scanned it cannot be exported, downloaded or attached.

What the scan costs. Keeping a pack made on your computer, with Copy to Cloud or agentry knowledge upload, costs 1 credit for its scan, however large the pack: AI Review is one credit an operation. The credit comes from the same balance as the pack's storage: your account's, or your organization's pool if you are a member, and an organization's pack from the organization. Sending the same pack again costs nothing and is not scanned again, and neither costs anything when you send it again after a scan Agentry could not finish. If the balance cannot pay, the upload is refused with the balance and the date the allowance resets, and nothing is kept. A pack built in Agentry pays its scan inside the build, as above.

From a pack's page:

  • Read the pages here opens the pack in the browser tab: Agentry decrypts it as it streams to you, and the page shows the wiki's pages with no raw HTML, no images, and links only to other sites. Nothing is kept once you leave the page.
  • Export saves the pages and documents unencrypted, as a .tar. The saved copy is not encrypted; the one kept here still is.
  • Download encrypted saves the pack as Agentry keeps it, still sealed under its own key. Nothing on the site opens that file; the desktop app's Copy to Local and agentry knowledge download fetch the copy kept here and open it themselves.
  • Add documents builds more documents, a brief, or both into the pack, in Agentry, on Pro, Business and Enterprise.
  • Delete from Agentry, after a confirmation, deletes the copy kept here, its documents and the wrapped key that opens them. It cannot be undone. A copy on your computer stays where it is.

An organization's shared knowledge

An organization on Business or Enterprise can keep packs of its own, which its members use and its admins write. They are encrypted to the organization's key, which Agentry holds, and count against the organization's pooled allocation.

  • Admins find them in the organization's admin console, in its Knowledge section, with the pool's meter and Create shared knowledge, which builds a pack paid from the organization's pool. On a shared pack's page an admin can also add documents, delete it, and choose whether members may export it.
  • Members see them under Manage knowledge, under Shared by organization. A member can read a shared pack's pages and scan report, download it encrypted, and attach it to a run. They can export it unencrypted, or read it in the browser, only once an admin has let members export it.
  • Anyone else, including a member who has been removed, gets a not-found answer. Membership is checked on every request, so a removed member's next read is refused. A run already started keeps what it was given, and an export a member saved while the pack was exportable stays with them.

In an organization's decommission hold its packs stay readable, and nothing new is created.

Local and Cloud in the desktop app

The desktop app's Knowledge page opens two cards, one for each place a pack can be kept. Local Knowledge lists the packs kept on your computer, which runs there can search. Cloud Knowledge lists the packs your account keeps in Agentry, with the storage they use against your allocation, and after them the packs your organizations share, under Shared by organization. Each card says how many packs its place holds.

Each card and each page has Create knowledge. From Local Knowledge it starts a build on your computer, from Cloud Knowledge a build in Agentry, and the build's Where step lets you change it. Where a build in Agentry is not open to you (on Standard, signed out, on a registry that builds no knowledge, or for documents past 10 MB), the Where step says why and builds on your computer instead, and the finished build offers Copy to Cloud. A pack you build In Agentry from the desktop app is kept and scanned in Agentry, then copied to your computer, so it is listed on both pages.

A pack goes from one place to the other as a copy. Neither button removes the copy it starts from.

  • Copy to Cloud, on Local Knowledge, keeps a copy in your account, where AI Review scans it and it counts toward your storage. It needs you signed in and a pack of your own of at most 10 MB, and it is offered while Agentry keeps no copy of the pack, or one older than the copy on your computer.
  • Copy to Local, on Cloud Knowledge, keeps a copy on your computer. It is offered for a pack with no copy on your computer once Agentry has finished scanning it, a shared pack included.

A pack kept in both places is listed on both pages, marked also in your account or also on this computer, and changed since it was copied when the copy on your computer changed after the copy in Agentry was made; Copy to Cloud then sends the newer one. Delete on a page removes that place's copy alone, after a dialog that says whether it is the only copy. To keep a pack in one place only, copy it, then delete it from the other page.

The desktop app reads a pack's pages from the copy on your computer, so Preview on Cloud Knowledge is offered for a pack also kept there; copy a Cloud-only pack to your computer to read it or to attach it to a run there. A shared pack has Preview and Copy to Local only: its admins change it in Agentry.

Using a pack in a run

On your computer, attach packs with agentry run … --knowledge NAME, or in the desktop app's run setup. A pack is mounted read-only, and the run cannot change it.

In Agentry, the run setup has a Knowledge step between Files and Connect tools. It lists the packs you keep in Agentry and, after them, the ones your organization shares, each with its pages, size and scan state. Only a pack whose scan has finished can be ticked, and a run attaches at most five. The run's page lists the packs it was given, and its receipt names each one by digest.

A QuickAgent can also ask for a pack of your own. Its author writes one line, which the Knowledge step shows as "This release asks: …". When the release marks it required, the run cannot start without a pack attached. The line is shown to you and never to the agent.

Shipping a pack with a QuickAgent

An author can ship packs inside a release, for example documentation a review agent reads. In the QuickAgent Builder, the Knowledge step lists your packs kept in Agentry whose scan has finished; tick up to five. On submit, the site reads each pack back from Agentry, checks it is the one Agentry keeps, and puts it in the package under knowledge/<name>/. A shared pack does not ship from the Builder.

A shipped pack is part of the release, not a pack kept in Agentry:

  • It is not encrypted. Anyone who can download the release can read it: anyone for a public release, and the people with access for a private one.
  • It is scanned with the version. Its findings are the release's findings, and the version's page says under Knowledge this release ships what the rule stages read and how many chunks AI Review read of the documents and of the wiki. It is signed with the rest of the release.
  • The QuickAgent's page lists it with its size under the declared capabilities, as "knowledge: ships N". A new version that ships another pack asks for your consent again when you update.

A pack is at most 10 MiB, and a submission from the Builder at most 16 MiB compressed; publish a larger release from its tag.

What a pack is not

A pack is reference material, not a verdict. "Scanned, N findings" says what the scanners read and found, not that the pages are right. Pages cited [src: web:…] or [src: model] come from the web or the model, not your documents, and can be wrong or out of date. A pack does not widen what a QuickAgent may do: the tools that read it are read-only, and attaching one changes nothing in the release's declared capabilities.