@stll/folio-agents
Version:
Framework-neutral LLM tool layer over folio's ai-edits engine: function-calling tools so an agent can read and mutate .docx documents through @stll/folio-core.
26 lines • 1.33 kB
TypeScript
import { FolioAgentBridge } from "../bridge.js";
import { FolioAIEditApplyMode, FolioDocxReviewer, FolioRevisionStamp } from "@stll/folio-core/server";
//#region src/bridges/reviewer.d.ts
/** Options for {@link createReviewerBridge}. */
type CreateReviewerBridgeOptions = {
/** `"tracked-changes"` (default) produces ins/del redlines; `"direct"` edits in place. */
mode?: FolioAIEditApplyMode;
/**
* Fixed provenance for what this bridge authors: revisions and comments
* take its date and allocate ids from its seed, and replies take its date.
* For a bridge that applies one batch (a file transaction); a second batch
* would allocate from the same seed. Omit to use the wall clock.
*/
revisionStamp?: FolioRevisionStamp;
};
/**
* Build a {@link FolioAgentBridge} over a headless {@link FolioDocxReviewer}
* (`@stll/folio-core/server`). No optional capability members are
* implemented: a headless document has no live page/selection/scroll
* surface, so `read_page`, `read_selection`, and `scroll_to_block` report an
* unsupported-capability error via {@link executeFolioToolCall} on this
* bridge.
*/
declare const createReviewerBridge: (reviewer: FolioDocxReviewer, options?: CreateReviewerBridgeOptions) => FolioAgentBridge;
//#endregion
export { CreateReviewerBridgeOptions, createReviewerBridge };