跳到正文
QuireKit
插件文档
Alpha · API 持续演进
产品预设与服务查看 Markdown ↗

createClassicAi · Classic AI 完整装配

异步创建第一方 AI 接入,返回 plugin 与页面级 destroy。宿主提供浏览器 Document 与偏好存储,离开页面时同时释放 AI 装配。

异步创建第一方 AI 接入,返回 plugin 与页面级 destroy。宿主提供浏览器 Document 与偏好存储,离开页面时同时释放 AI 装配。

@quirekit/classic-ai · Commercial

编辑器适用范围

层次:Classic 产品适配

编辑器状态所需装配与边界
Classic直接支持这是 Classic 产品插件,加入 createClassicEditor 的 plugins;依赖的模型、宿主端口和服务必须按下方配置提供。
Block未支持Block 不消费 Classic 产品 contribution、plugins 或分页装配。请使用共享能力和 Block 适配入口,不能直接复制此入口的 Classic 配置。

“直接支持”指已有上述产品装配;具体交互、宿主服务和格式支持仍有各自条件。状态与接入规则。许可独立显示。

接入

当前 @quirekit/classic-ai 的包元数据标为 private。本站使用工作区源码;外部项目需先取得对应分发包,不能把下面的公开导出理解为已经能从公共 npm 安装。

此入口属于商业组件。使用前先取得相应分发与授权;安装命令仅适用于已配置该分发源的项目。

这是产品层接入:将产品插件放入 createClassicEditor 的 plugins,不要放进 Core 的 extensions。必填宿主端口见下面的配置。

ts

安装时按包声明选择兼容版本,外部可用版本以分发源为准。本站使用工作区 Alpha;许可标签来自入口所属包,使用条件见支持与许可。

按编辑器接入

以下片段沿用已挂载的宿主元素 element,宿主负责容器尺寸与保存;退出页面时调用 instance.destroy()。已有预设装配的能力不要再重复追加;需要宿主端口的入口应先完成下方配置。

Classic · 直接支持

这是 Classic 产品插件,加入 createClassicEditor 的 plugins;依赖的模型、宿主端口和服务必须按下方配置提供。

配置

字段传入创建函数的 options。标为“必填”的端口由宿主提供;undefined 表示未显式配置,下面会说明创建层的回退。

ownerDocument

拥有对话框和界面的浏览器 Document。

类型:Document

默认:必填,宿主提供

storage

保存模型连接、模型选择与授权偏好的浏览器存储。

类型:Storage

默认:必填,宿主提供

defaultHostUrl

用户尚未保存连接设置时使用的 AI Host 地址。

类型:string | undefined

默认:undefined

reconnect

应用新的连接设置后执行的动作,默认重新加载页面。

类型:(() => void) | undefined

默认:undefined

defaultOpen

挂载后是否自动打开 AI 侧栏。

类型:false | true | undefined

默认:undefined

diagnostics

是否显示供开发排查的原始审阅差异。

类型:false | true | undefined

默认:undefined

fetch

宿主提供的 Fetch 实现,适合接入应用网关或测试。

类型:{ (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | URL | Request, init?: RequestInit): Promise<Response>; } | undefined

默认:undefined

getHeaders

请求 Host 前按需读取当前应用认证头,避免捕获过期凭证。

类型:QuireAiPiHostHeaderResolver | undefined

默认:undefined

skillSources

按优先级递增的技能来源;完整提供 skills 时忽略此项。

类型:readonly QuireAiSkillLibrarySource[] | undefined

默认:undefined

builtinSkills

应用自带的技能记录,用于默认技能来源。

类型:readonly QuireAiSkillRecord[] | undefined

默认:undefined

skills

完整技能库接口,在创建工作区时读取可用技能。

类型:QuireAiSkillLibrary | undefined

默认:undefined

workflowHints

是否提供常见请求对应的工具与操作提示,默认启用。

类型:false | true | undefined

默认:undefined

命令与运行方式

此入口没有直接声明可枚举的命令。组合扩展的命令由子扩展提供;产品插件通过 contribution 或文件服务工作。不能把安装入口名称当作命令调用。

创建函数返回 Promise;等待完成后把返回对象的 plugin 安装到产品。编辑器销毁自己的会话,页面额外负责调用返回对象的 destroy 释放设置界面等资源。

下一步

返回全部插件,或阅读配置插件区分配置、文档属性与命令。

继续Classic 快速接入和配置与生命周期。开发自己的产品界面与服务时,见产品插件开发。

QuireKitQuireKit · Core、插件与 Classic 文档