Yaniv Editor

简体中文

English

简体中文

English

Appearance

AI 配置 ​

YanivEditorAiConfig ​

通过 YanivEditor 的 ai-config prop 注入（宿主托管模式）：

ts
interface YanivEditorAiConfig {
  provider: "openai" | "deepseek" | "aliyun" | "ollama" | "custom";
  apiKey?: string;
  endpoint?: string;
  model?: string;
  timeout?: number;
  enabled?: boolean;
  /** @default 'memory' */
  storageMode?: "local" | "memory" | "proxy";
  /** 有 ai-config 时默认 false */
  showSettings?: boolean;
  /** 送进 AI 上下文的文档全文字符上限，超出即截断并提示用户；@default 8000 */
  documentContextLimit?: number;
}

示例 ​

vue
<script setup lang="ts">
import type { YanivEditorAiConfig } from "@yanivjs/yaniv-editor";

const aiConfig: YanivEditorAiConfig = {
  provider: "deepseek",
  apiKey: import.meta.env.VITE_DEEPSEEK_KEY,
  model: "deepseek-chat",
  storageMode: "memory",
  showSettings: false,
};
</script>

<template>
  <YanivEditor preset="notion" :ai-config="aiConfig" />
</template>

字段默认值 ​

ai-config 只有 provider 必填，其余字段的兜底顺序如下（见 capabilities/registry.ts 与 features/ai/shared/extensionOptions.ts）：

字段未传时
apiKey""
endpointAI_PROVIDERS 中该 provider 的 defaultEndpoint
modelAI_PROVIDERS 中该 provider 的 defaultModel
timeout60000（getAiConfig() 的 DEFAULT_TIMEOUT）
enabledtrue（enabled !== false）
storageMode"memory"
showSettings有 ai-config 时 false，否则 true
documentContextLimit8000（DEFAULT_DOCUMENT_CONTEXT_LIMIT）

documentContextLimit 的单位是字符，不是 token

文档全文会原样拼进 system prompt，不限长的话超长文档会把请求撑爆（多数模型返回 400）。 项目同时支持 openai / aliyun / ollama 且模型可配，各家 tokenizer 不同、没有统一换算， 所以默认值只能取一个保守估计——请按你实际用的模型调整。

截断保留文档开头，并在 prompt 末尾加一条标记让模型知道拿到的不是全文； 同时给用户弹一条提示（messages.aiDocumentContextTruncated），不静默降质。 传 0 或负数关闭这个保护。

配置模式对比 ​

模式来源AI 设置 UI优先级典型场景
宿主托管:ai-config默认隐藏1生产集成
用户配置localStorage显示2Demo / 内部工具
环境变量VITE_AI_*显示3本地开发

表里是三种配置来源；实际解析在 getAiConfig() 里分四级（宿主托管占了 1、3 两级，第 3 级是宿主配置未通过校验时的兜底，用于阻止悄悄下沉到 .env）。完整顺序见 AI 辅助 — 配置来源。

传入 ai-config 后即视为宿主托管，环境变量不再参与解析。未传时按 2 → 3 依次回退。

子包 API ​

ts
import {
  setHostAiConfig,
  getHostAiConfig,
  useAiConfig,
  createAiClient,
  AI_PROVIDERS,
} from "@yanivjs/yaniv-editor/ai";

AI_PROVIDERS 只含技术参数（id / defaultEndpoint / defaultModel / requiresApiKey / docsUrl）。 展示名与说明是 UI 文案，放在语言包的 aiSettings.providerName[id] / aiSettings.providerDesc[id]， 随 locale 切换。

useAiConfig().testConnection() 返回的 ConnectionTestResult 同理只回 key 不回文案：

ts
interface ConnectionTestResult {
  success: boolean;
  /** 语言包 key，如 `aiSettings.testTimeout` */
  messageKey: string;
  /** provider 返回的原始错误文本（无法本地化）；有值时优先展示 */
  detail?: string;
  latency?: number;
}

createAiClient({ getLocaleText }) 同样接收实例 locale 解析器——AI 扩展经 createConfiguredAiClient 自动注入；直接使用导出的 aiClient 单例时，client 自身的提示退回英文。

动态更新 ​

修改 aiConfig.model 等字段后，下次 AI 请求使用新值，无需重建 session（扩展内 getter 读取）。

同页多实例 ​

宿主配置按实例登记，互不覆盖：实例 A 传 ai-config、实例 B 不传时，B 不会复用 A 的密钥与端点。

getHostAiConfig() / isHostAiManaged() 接受可选的 owner（每个编辑器实例内部持有的 Symbol）：

调用方式行为
getHostAiConfig(owner)返回该实例的配置，未登记则 null
getHostAiConfig()仅一个实例登记时返回它（单实例场景）
getHostAiConfig() 多实例返回 null 并在控制台告警

多实例下无 owner 的查询没有正确答案，因此显式失败而不是任选一个——旧版本正是"任选一个"导致跨实例串用密钥。

AI 扩展发起的请求不走这条路径：它们通过实例作用域的 ctx.aiConfig() getter 取值，始终正确。

相关 ​