@haklex/ rich- agent- core
Lexical富文本编辑的无头AI代理协议. 提供diff-aware编辑引擎,文档上下文快照,基于LiteXML的编辑,以及Zustand后置代理商店——所有框架不可知和UI免费.
安装
pnpm add @haklex/rich-agent-core
同伴依赖关系
| 软件包 | 版本 |
@haklex/rich-editor | 工作空间 |
lexical | ^0.45.0 |
使用量
创建代理仓库
import { createAgentStore, createInitialAgentStoreState } from '@haklex/rich-agent-core';
const store = createAgentStore(
createInitialAgentStoreState({
// initial state configuration
}),
);
构建代理文档上下文
import { buildDocumentContext } from '@haklex/rich-agent-core';
const context = buildDocumentContext(editorState, {
/* options */
});
创建代理执行器
import { createAgentExecutor } from '@haklex/rich-agent-core';
const executor = createAgentExecutor({
store,
provider: myProvider,
config: {
/* executor config */
},
});
const result = await executor.execute({ prompt: 'Improve this paragraph' });
import { createDocumentTools } from '@haklex/rich-agent-core';
const tools = createDocumentTools({ store, editor });
创建和比较快照
import { createSnapshot, compareBlockContent } from '@haklex/rich-agent-core';
const snapshot = createSnapshot(editorState);
const hasChanged = compareBlockContent(snapshotA, snapshotB);
使用选择器
import { agentStoreSelectors } from '@haklex/rich-agent-core';
const messages = agentStoreSelectors.messages(store.getState());
const status = agentStoreSelectors.status(store.getState());
出口
代理存储
| 导出 | 说明 |
createAgentStore(state) | 创建 Zustand 代理店 |
createInitialAgentStoreState(config) | 创建初始存储状态 |
agentStoreSelectors | 存储状态的已键入选择器函数 |
flattenActions(actions) | 平起平坐的行动小组 |
代理执行器
| 导出 | 说明 |
createAgentExecutor(config) | 创建运行提示的代理执行器 |
AgentExecutorConfig | 执行器的配置类型 |
AgentExecutorResult | 执行器运行的结果类型 |
| 导出 | 说明 |
createDocumentTools(config) | 为代理服务器创建文档编辑工具 |
buildDocumentContext(state, options?) | 为代理消费建立文档上下文 |
LiteXML 整合
| 导出 | 说明 |
createLitexmlEditHandler(config) | 创建一个应用 LiteXML 编辑到编辑器的处理器 |
createLitexmlParseHandler(config) | 创建处理器, 从代理响应中解析 LiteXML |
createLitexmlRegistry(options?) | 为代理使用创建 LiteXML 注册 |
LitexmlRegistryOptions | LiteXML 注册创建选项 |
LitexmlRegistryProvider | LiteXML 登记册的提供者接口 |
提供者
| 导出 | 说明 |
createProvider(config) | 创建 AI 提供者实例 |
createDirectTransport(config) | 创建直接传输适配器 |
createProxyTransport(config) | 创建代理传输适配器 |
ProviderType | 支助提供者类型的联盟类型 |
TransportAdapter | 运输适配器接口 |
Diff 复议( V)
| 导出 | 说明 |
createDiffEngine(config) | 为编辑操作创建 diff 引擎 |
createReviewEngine(config) | 为 AI 推荐编辑创建审查引擎 |
DiffEngineConfig, (中文(简体) ), ReviewEngineConfig | 配置类型 |
DiffHunk, (中文(简体) ), DiffResult | Diff 结果类型 |
ReviewBlock, (中文(简体) ), ReviewState | 审查状态类型 |
信件引擎
| 导出 | 说明 |
createMessagesEngine(config) | 为聊天状态创建消息引擎 |
MessagesEngineConfig | 配置类型 |
ChatMessage, (中文(简体) ), MessageRole | 信件类型 |
抓图
| 导出 | 说明 |
createSnapshot(state) | 创建编辑器状态快照 |
compareBlockContent(a, b) | 按块内容比较两个快照 |
EditorSnapshot | 快照类型 |
类型
| 导出 | 说明 |
AgentStore, (中文(简体) ), AgentStoreState, (中文(简体) ), AgentStoreSlice | 存储类型 |
AgentStoreStatus | 存储状态enum |
ChatBubble | 用于 UI 渲染的聊天泡类型 |
ToolCallGroupItem, (中文(简体) ), ToolCallItemStatus | 工具调用类型定义 |
StoreSetter | 存储设置函数类型 |
选择器
| 导出 | 说明 |
agentStoreSelectors.messages | 获取所有信件 |
agentStoreSelectors.status | 获取当前存储状态 |
agentStoreSelectors.session | 获取当前会话信息 |
agentStoreSelectors.toolCalls | 获取工具调用状态 |
agentStoreSelectors.diff | 获取 diff 审查状态 |
agentStoreSelectors.model | 获取选中的模型信息 |
哈克历克的一部分
此软件包是 哈克历 丰富的编辑生态系统.
许可证
麻省理工学院